Telematics SDK | Developer portal
  • Get started
  • 4 Steps to Integrate SDK
  • Product Wiki
  • License
  • FAQ
  • PRODUCT DESCRIPTION
    • How it works
    • SDK Features
    • Scoring
      • Risk driving Scoring
        • Event detection
        • Trip rating
        • Overall scoring
      • Eco Scoring
    • Dataset
      • Dataset | User statistics API
      • Data samples
        • Summary - Processed track details (Rich track details)
        • Processed track waypoints (Rich track points)
        • Summary - list of Processed tracks
        • Incoming track events
        • Incoming track points (waypoints)
        • Summary - list of Incoming tracks
      • Dataset Decription
        • Bluetooth OBD - Vehicle Dataset
        • LastKnownPoints
        • IncomingTrackPoints
        • IncomingTrackEvents
        • Enriched telematics data
          • RichTracks
          • RichTrackPoints
          • RichTrackEvents
          • RichTrackDetails
          • UserStatisticDrivingDetails
        • Raw telematics data from SDK
    • Reporting
      • Drivecoins summary
      • Trip summary
      • Scoring summary
      • User state
      • Fraud
      • Trip waypoints
      • Trip events
    • External Articles
      • Why mobile telematics hits hardware telematics
  • Step 1: Create Datahub Account
  • Step 2: SDK Installation
    • Get started
    • iOS SDK installation
      • *Set up Your Development Environment
      • *Configure Your Project
      • *App Delegate
      • *Configure Framework
      • *React Native Installation
        • Create the iOS bridge
      • Add list of trips to your ViewController
      • Add statistics data to your ViewController
      • *What’s different in iOS 13?
      • *iOS 13 Permissions Wizard
      • *SDK Enable \ Disable \ Disable With Upload
      • *Incoming Tags
      • *Tracking Status
      • *SDK Delegates
      • *SDK Modes
      • *Using the Debugging Tools in Simulator
    • Android SDK installation
      • *Getting started
        • *Set up Your Development Environment
        • *Setup and enable SDK
        • *Permissions wizard
        • *Permissions dialog
        • *Configure SDK variables for notifications
      • *Subscribe to tracking events
      • *Incoming tags managing
      • *Migration from SDK v1.6.x to SDK v2.0.x
    • *Check SDK Installation
      • iOS Simulator
      • DataTool
      • ZenRoad
    • *Demo Applications
      • iOS | Open Source Demo Application
      • iOS | SDK Demo Application
      • iOS | Swift | SDK Demo Application
      • Android | SDK Demo Application
      • Android | Java | SDK Demo Application
      • Flutter | SDK Demo Application
    • SDK Changelog
      • Android SDK Changelog
      • iOS SDK Changelog
    • Permissions Guides
      • First Launch
        • iOS 13 (and higher) Permissions Guide
        • iOS 12 (and lower) Permissions Guide
        • Android 9 Permissions Guide
        • Android 9 XIaomi Permissions Guide
        • Android 10 Permissions Guide
      • *Troubleshooting
        • iOS — Troubleshooting
          • iOS — Troubleshooting
        • Android — Troubleshooting
          • Samsung — Troubleshooting
          • Oppo — Troubleshooting
          • Huawei — Troubleshooting
          • Xiaomi — Troubleshotting
          • OnePlus — Troubleshooting
          • Meizu — Troubleshooting
          • Asus — Troubleshooting
          • Vivo — Troubleshooting
          • Wiko — Troubleshooting
  • Step 3: Register SDK users
    • User Registration (API)
  • Step 4: API | User Statistics, Scores, Trips
    • Step 4: Get Statistics, Scorings and Trip Data
    • API Authorization
    • Statistics and Scoring APIs
      • Get started - Statistics and Scoring API
      • User | Individual Scorings and Statistics
      • Admin | User(s) - Scorings and Statistics
      • Admin | Consolidated Scorings and Statistics
    • Trips API
      • Get a short list of tracks
      • Get a list of tracks with paging
      • Get a list of tracks by IDs
      • Get a single track with waypoints
      • Get the most earliest track
      • Track Statuses
  • SDK Features
    • *Bluetooth Device - Get started
      • *Get Started
      • *Android - ELM API
      • *iOS - ELM API
    • Trip Tags - Get started
      • Tags for trips via mobile app
        • Android - Tags for trips
        • iOS - Tags for trips
      • Tags for period
      • Trip log by tags
  • PLATFORM FEATURES
    • *User Management
      • *User Registration
      • *Check User Existence
      • *User Management
    • *Vehicle Management
      • *Directories
      • *Vehicles
    • FNOL, Inspections & Damage Recognition
      • Get started
      • Profiles
      • Claims
      • Vehicle inspections
        • Dictionary of vehicle photos
      • Photo processing
    • *Leaderboard
      • *Summary Leaderboard
      • *Leaderboard by factors
      • Swagger - Leaderboard
    • *Streaks
    • *SNS
      • *How to register AWS SNS
    • 3rd party data processing
      • Swagger - Incoming getaway
    • *User & Permissions Status | Heartbeats
  • Other
    • Response Codes
    • Resources swaggers
      • Swagger: User service
      • Swagger: Scorings and Statistics API
      • Swagger: Telematics data
      • Swagger: Leaderboard
      • Swagger: Vehicle Management
      • Driving details
      • Swagger: FNOL, Inspections & Damage Recognition
      • Swagger: Heartbeats
    • Archive
      • Get started
      • Statistics and Scorings API
      • Step 5: Get statistics and trip data [ARCHIVED]
      • User Statistics API [Archived]
      • SDK - Statistics API [ARCHIVED]
        • Get the data to the Android app
          • Android Telematics data (Tracks)
            • Check current running track state
            • Get start date for current recording trip
            • Register tracking state listener (for onStartTracking/onStopTracking events)
            • Register speed violations listener
            • Get flag for registered speed violations listener
            • Get registered speed limit in km/h or default
            • Get registered speed violations timeout in ms or default
            • Get Tracks
            • Get detailed trips information
            • Get available user roles
            • Change a user role (any of TrackOriginDictionary.code)
          • Android User Statistics
            • Get Dashboard info
            • Get detailed Dashboard
            • Get Driving time statistics
            • Get Speeding statistics
            • Get Mileage statistics
            • Get Distracted Phone Usage statistics
        • Get the data to the iOS app
          • Other methods
          • iOS Telematics data (tracks)
            • Request all Tracks with specified offset and limit
            • Request all Tracks with specified offset and limit. No filter will be used in request
            • Request Track info with specified Track Token
            • Request Track origins dictionary
            • Change Track Origin Code
            • Share Track
          • iOS User Statistics
            • Get shared Track
            • Request main statistics data for all possible statistic types
            • NS_ENUM
            • Request main statistics data for all possible statistic types
            • Properties and Protocols
      • Get all DeviceTokens
    • Report a bug
    • Data Hub
    • Talk to sales
  • Postman collection
Powered by GitBook
On this page
  • Create Vehicle
  • Update Vehicle
  • Delete Vehicle
  • Get a list of User's Vehicles
  • Get Vehicle Info
  • Get vehicles by Company

Was this helpful?

  1. PLATFORM FEATURES
  2. *Vehicle Management

*Vehicles

Create Vehicle

POST https://services.telematicssdk.com/api/carservice/v1/Vehicles

Authorization: Allow Anonymous

Headers

Name
Type
Description

deviceToken

string

{
  "Result": "fafdebac-e7e7-4386-827e-8d16eabc8c41", // Vehicle token
  "Status": 200,
  "Title": "",
  "Errors": []
}
{
  "plateNumber": "string",
  "vin": "string",
  "manufacturerId": 0, // make id from directories
  "modelId": 0, // model id from directories
  "carYear": 2010,
  "specialMarks": "string", 
  "nvic": "string", // https://www.mycarinfo.com.my/Home/FAQ#:~:text=NVIC,the%20vehicle%20throughout%20its%20lifespan.
  "initialMilage": 100,
  "vehicleId": "string", // vehicle identifier in your system (if have)
  "name": "string",
  "allowedDrivers": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ], // another drivers device tokens (except primary driver deviceToken in header)
  "entityStatus": "Active" //  { Active = 1, Deactivated = 2 } deactivated vehicles are not given for search queries 
  "colorType": "Pearl" // { Solid = 1, Metallic = 2, Pearl = 3,} 
}

Update Vehicle

PUT https://services.telematicssdk.com/api/carservice/v1/Vehicles/{VehicleToken}

Authorization: Allow Anonymous

Path Parameters

Name
Type
Description

vehicleToken

string

Headers

Name
Type
Description

deviceToken

string

{
  "Result": null,
  "Status": 200,
  "Title": "",
  "Errors": []
}
  "modelId": 0, // model id from directories
  "carYear": 2010,
  "specialMarks": "string", 
  "nvic": "string", // https://www.mycarinfo.com.my/Home/FAQ#:~:text=NVIC,the%20vehicle%20throughout%20its%20lifespan.
  "initialMilage": 100,
  "vehicleId": "string", // vehicle identifier in your system (if have)
  "name": "string",
  "allowedDrivers": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ], // another drivers device tokens (except primary driver deviceToken in header)
  "entityStatus": "Active" //  { Active = 1, Deactivated = 2 } deactivated vehicles are not given for search queries 
  "colorType": "Pearl" // { Solid = 1, Metallic = 2, Pearl = 3,} 
}

Delete Vehicle

DELETE https://services.telematicssdk.com/api/carservice/v1/Vehicles/{VehicleToken}

Authorization: Allow Anonymous

Path Parameters

Name
Type
Description

vehicleToken

string

Headers

Name
Type
Description

deviceToken

string

{
  "Result": null,
  "Status": 200,
  "Title": "",
  "Errors": []
}

Get a list of User's Vehicles

GET https://services.telematicssdk.com/api/carservice/v1/Vehicles

Authorization: Allow Anonymous

Headers

Name
Type
Description

deviceToken

string

GUID | User's deviceToken

{
  "Result": {
    "Cars": [
      {
        "Token": "4cbe2ed5-d828-4ae8-8de3-5dc77bfce13a",
        "Name": "PORSCHE, 911 ",
        "PlateNumber": "string",
        "Vin": "string",
        "Manufacturer": "Honda",
        "Model": "Accord",        
        "CarYear": 2020,
        "SpecialMarks": "string",
        "Nvic": "string"
        "InitialMilage": 18.5,
        "InitialOdometerMileage": 65000,
        "VehicleId": "string",
        "LastKnownMileage": 1000,
        "LastKnownMileageDate": "2020-04-10T14:50:46.0048083"
      },
      {
        "Token": "7e40bb4d-8fdf-41de-8927-4090b6f32cc1",
        "Name": "PORSCHE, 911 ",
        "PlateNumber": "string",
        "Vin": "string",
        "Manufacturer": "Honda",
        "Model": "Accord",        
        "CarYear": 2020,
        "SpecialMarks": "string",
        "Nvic": "string"
        "InitialMilage": null,
        "InitialOdometerMileage": null,
        "VehicleId": "string",
        "LastKnownMileage": 1000,
        "LastKnownMileageDate": "2020-04-10T14:50:46.0048083"
      }
    ]
  },
  "Status": 200,
  "Title": "",
  "Errors": []
}

Get Vehicle Info

GET https://services.telematicssdk.com/api/carservice/v1/Vehicles/{VehicleToken}

Authorization: Allow Anonymous

Query Parameters

Name
Type
Description

VehicleToken

string

Headers

Name
Type
Description

deviceToken

string

{
  "Result": {
        "Token": "4cbe2ed5-d828-4ae8-8de3-5dc77bfce13a",
        "Name": "PORSCHE, 911 ",
        "PlateNumber": "string",
        "Vin": "string",
        "Manufacturer": "Honda",
        "Model": "Accord",
        "BodyType": null,
        "CarYear": 2020,
        "SpecialMarks": "string",
        "Nvic": "string"
        "InitialMilage": 18.5,
        "InitialOdometerMileage": 65000,
        "VehicleId": "string",
        "LastKnownMileage": 1000,
        "LastKnownMileageDate": "2020-04-10T14:50:46.0048083"
  }
  "Status": 200,
  "Title": "",
  "Errors": []
}

Get vehicles by Company

GET https://services.telematicssdk.com/api/carservice/v1/companies/{CompanyId}/vehicles

Authorization: Allow Anonymous

Path Parameters

Name
Type
Description

companyID

string

Headers

Name
Type
Description

deviceToken

string

{
  "Result": {
        "Token": "4cbe2ed5-d828-4ae8-8de3-5dc77bfce13a",
        "Name": "PORSCHE, 911 ",
        "PlateNumber": "string",
        "Vin": "string",
        "Manufacturer": "Honda",
        "Model": "Accord",
        "BodyType": null,
        "CarYear": 2020,
        "SpecialMarks": "string",
        "Nvic": "string"
        "InitialMilage": 18.5,
        "InitialOdometerMileage": 65000,
        "VehicleId": "string",
        "LastKnownMileage": 1000,
        "LastKnownMileageDate": "2020-04-10T14:50:46.0048083"
  }
  "Status": 200,
  "Title": "",
  "Errors": []
}
Previous*DirectoriesNextFNOL, Inspections & Damage Recognition

Last updated 4 years ago

Was this helpful?