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
  • Get user details
  • Update user details
  • Delete user
  • Transfer user to another InstanceID
  • Transfer user to another instance with a Company Invitation Code
  • Get list of users
  • Quick search for users

Was this helpful?

  1. PLATFORM FEATURES
  2. *User Management

*User Management

Previous*Check User ExistenceNext*Vehicle Management

Last updated 4 years ago

Was this helpful?

Swagger:

Production URL:

Get user details

  • Address: /v1/Management/Users/Find

  • Method: GET

  • Authorization: Required with

Request headers:

"Authorization": "Bearer {Token}" // required (get Token in /v1/Auth/Login)

Request

Query parameters (at least one of these is required):

DeviceToken = "3fa85f64-5717-4562-b3fc-2c963f66afa6";
Email = "string";
Phone = "string";
ClientId = "string";
Country = "string";
OsType =  "android", // { "android" = 0, "iOS" = 1 }
FullName = "string"; 
FirstName = "string";
LastName = "string";
IncludeAccountInfo = true; // default = false
ShowInactiveUsers = false; // default = false

Response

{
  "Result": [
    {
      "DeviceToken": "dfe6b62d-2395-456e-8421-a2b9bb5d1ba2",
      "DateCreated": "2020-05-21T12:13:09.9107284",
      "Status": "Active",
      "ActivityStatus": "No Data",
      "UserProfile": {
        "FirstName": "Test",
        "LastName": "Test",
        "Gender": "None",
        "Birthday": "2020-12-04T22:00:00",
        "MaritalStatus": "string",
        "ChildrenCount": "string",
        "Address": "string",
        "Country": "string",
        "District": "string",
        "City": "string",
        "Nickname": "string",
        "Email": "aTest@gmail.com",
        "Phone": "+1213 621 0002",
        "ImageUrl": "string"
      },
      "MobileDevice": {
        "MobileUid": "string",
        "DeviceModel": "string",
        "OsType": "android", // { "android" = 0, "iOS" = 1 }
        "OsVersion": "string",
        "SdkVersion": "string",
        "AppVersion": "string",
      },
      "AccountInfo": {
        "CompanyId": 1285,
        "CompanyName": "CompanyName",
        "ApplicationId": 2339,
        "ApplicationName": "AppName",
        "InstanceId": "7600445e-ab2f-48ba-a52d-8b02fd8a8706",
        "InstanceName": "Common"
      },
      "UserFields": [        
        {
          "ClientId": "string",
          "EnableLogging": false,
          "EnableRealTimeLocation": false,
          "EnableTracking": true,
          "Enabled": true
        }
      ]
    }
  ],
  "Status": 200,
  "Title": "",
  "Errors": []
}

Update user details

  • Address: /v1/Management/Users

  • Method: PUT

Request Headers:

"UserDeviceToken": "3fa85f64-5717-4562-b3fc-2c963f66af17" // use for update another user

Request

{  
  "OldPassword": "string", // required if set up NewPassword
  "NewPassword": "string", 
  "SendVerificationCodeForEmailPhone": false, // default = false - send verification code on email or phone for approve change email or phone
  "FirstName": "string",
  "LastName": "string",
  "Nickname": "string",
  "Phone": "string",
  "Email": "string",
  "Gender": "None", // { "None", "Male", "Female", "Other" }
  "Birthday": "2019-12-13T06:19:18.837Z",
  "MaritalStatus": "string",
  "ChildrenCount": 0,
  "Country": "string",
  "District": "string",
  "City": "string",
  "Address": "string",
  "ImageUrl": "string" // photo url (you can upload your photo later),
  "Status": "Active", // { "Active" = 1, "Deactivated" = 2, } 
  "MobileDevice": {
    "MobileUid":"string",
    "DeviceModel":"string",
    "OsType":"string", // { "android" = 0, "iOS" = 1 }
    "OsVersion":"string",
    "SdkVersion":"string",
    "AppVersion":"string",
  },
  "UserFields": { // default = null. Will be using dafult values below
    "EnableTracking": true, // default = true
    "EnableLogging": false; // default = false
    "EnableRealTimeLocation": false, // default = false
    "Enabled": true, // default = true
    "ClientId": "string", // default = null. User id in your system
  }
}

Response

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

Delete user

  • Address: /v1/Management/Users/{DeviceToken}

  • Method: DELETE

Request headers:

"Authorization": "Bearer {Token}" // required (get Token in /v1/Auth/Login)

Request

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

Transfer user to another InstanceID

Allows to change user instance inside application.

  • Address: /v1/Management/users/instances/change

  • Method: POST

Request headers:

"Authorization": "Bearer {Token}" // required (get Token in /v1/Auth/Login)

Request

{
  "DeviceToken": "3fa85f64-5717-4562-b3fc-2c963f66afa6", // Device token transfering user
  "ToInstanceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "ToInstanceKey": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
// method is now in development, we will add FromInstanceId and FromInstanceKey soon

Response

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

Transfer user to another instance with a Company Invitation Code

Transfer user to another InstanceID with a Company Invitation Code

Allows to change user instance inside application.

  • Address: /v1/Management/users/instances/change/{InstanceInviteCode}

  • Method: POST

  • Authorization: Required as User

  • url parameter: InstanceInviteCode = "someCode" - instance invite code in DataHub

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

Get list of users

  • Address: /v1/Management/users/GetFilteredPage

  • Method: POST

Request headers:

"Authorization": "Bearer {Token}" // required (get Token in /v1/Auth/Login)

Request Parameters work as filter. No parameters are required to get the full list of users.

{
  "CompanyIds": [
    0 // search for companies for which there are rights - where to find information about company ids - https://docs.userdatahub.com/
  ], 
  "ApplicationIds": [
    0 // search for applications for which there are rights - where to find information about application ids - https://docs.userdatahub.com/
  ],
  "InstanceIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6" // search for instances for which there are rights - where to find information about instance ids - https://docs.userdatahub.com/
  ],  
  "IncludeAccountInfo": true, // default = false - show company name, application name, instance name in result
  "SearchTerm": "string", // string for searching
  "Sort": "DeviceToken", /* { DeviceToken,
        FirstName,
        LastName,
        Nickname,
        Phone,
        Email,
        Gender,
        Birthday,
        MaritalStatus,
        ChildrenCount,
        Country,
        District,
        City,
        DeviceTokenDesc,
        FirstNameDesc,
        LastNameDesc,
        NicknameDesc,
        PhoneDesc,
        EmailDesc,
        GenderDesc,
        BirthdayDesc,
        MaritalStatusDesc,
        ChildrenCountDesc,
        CountryDesc,
        DistrictDesc,
        CityDesc,
        DateCreated,
        DateCreatedDesc,
        ActivityStatus,
        ActivityStatusDesc } */
  "ActivityStatuses": [
    "Active"
  ], // { Active, Inactive, Lost, NoData }
  "DateCreatedFrom": "2020-06-30T10:46:39.782Z",
  "DateCreatedTo": "2020-06-30T10:46:39.782Z",
  "Country": "string",
  "City": "string",
  "PageNumber": 1, // should be >= 1 
  "PageSize": 3, // should be >= 1
}

Response

{
  "Result": {
    "Users": [
      {
        "DeviceToken": "721109ee-d59f-47fa-ad1b-e9920cf6c5ac",
        "DateCreated": "2020-02-02T14:39:28.1736903",
        "Status": "Active",
        "ActivityStatus": "No Data",
        "UserProfile": null,
        "MobileDevice": {
          "MobileUid": "string",
          "DeviceModel": "string",
          "OsType": "android", // { "android" = 0, "iOS" = 1 }
          "OsVersion": "string",
          "SdkVersion": "string",
          "AppVersion": "string",
        },
        "AccountInfo": {
          "CompanyId": 3,
          "CompanyName": "CompanyName",
          "ApplicationId": 1002,
          "ApplicationName": "AppName",
          "InstanceId": "3c1c8447-4133-404a-82e9-93a015d85362",
          "InstanceName": "Common"
        },
        "UserFields": [
          {
            "ClientId": "string",
            "EnableLogging": false,
            "EnableRealTimeLocation": false,
            "EnableTracking": true,
            "Enabled": true
          }
        ]
      },
      {
        "DeviceToken": "4ac97d8a-bf5f-4ffd-a550-115eaf42bbdf",
        "DateCreated": "2020-02-02T14:39:27.3484452",
        "Status": "Active",
        "ActivityStatus": "No Data",
        "UserProfile": null,
        "MobileDevice": {
          "MobileUid": "string",
          "DeviceModel": "string",
          "OsType": "android", // { "android" = 0, "iOS" = 1 }
          "OsVersion": "string",
          "SdkVersion": "string",
          "AppVersion": "string",
        },
        "AccountInfo": {
          "CompanyId": 111,
          "CompanyName": "CompanyName",
          "ApplicationId": 1231231,
          "ApplicationName": "AppName",
          "InstanceId": "3c1c44d7-4133-5454-82e9-93a015d85362",
          "InstanceName": "Common"
        },
        "UserFields": [
          {
            "ClientId": "string",
            "EnableLogging": false,
            "EnableRealTimeLocation": false,
            "EnableTracking": true,
            "Enabled": true
          }
        ]
      },
      {
        "DeviceToken": "2b947c54-ad81-4ef3-ad0e-0e3b490b50f2",
        "DateCreated": "2020-02-02T14:39:26.5883671",
        "Status": "Active",
        "ActivityStatus": "No Data",
        "UserProfile": null,
        "MobileDevice": {
          "MobileUid": "string",
          "DeviceModel": "string",
          "OsType": "android", // { "android" = 0, "iOS" = 1 }
          "OsVersion": "string",
          "SdkVersion": "string",
          "AppVersion": "string",
        },
        "AccountInfo": {
          "CompanyId": 3,
          "CompanyName": "CompanyName",
          "ApplicationId": 1002,
          "ApplicationName": "AppName",
          "InstanceId": "3c1c44d7-4133-xdfs-82e9-93a015d85362",
          "InstanceName": "Common"
        },
        "UserFields": [
          {
            "ClientId": "string",
            "EnableLogging": false,
            "EnableRealTimeLocation": false,
            "EnableTracking": true,
            "Enabled": true
          }
        ]
      }
    ],
    "HasPreviousPage": false,
    "HasNextPage": true,
    "TotalUsers": 1548,
    "TotalPages": 516,
    "CurrentPage": 1
  },
  "Status": 200,
  "Title": "",
  "Errors": []
}

Quick search for users

Find users by email, phone, name, deviceToken, clientID as a searchterm.

  • Address: /v1/Management/users/quicksearch

  • Method: GET

Request headers:

"Authorization": "Bearer {Token}" // required (get Token in /v1/Auth/Login)

Request

From query:
SearchTerm = "string"

Response

{
  "Result": {
    "DeviceTokens": [],
    "Emails": [
      {
        "Item1": "4302a498-0b58-45d0-acc0-15817d800c5e",
        "Item2": "test3@raxel.com"
      },
      {
        "Item1": "07012e2b-6542-4978-be80-24c840f98b57",
        "Item2": "test@gmail.com"
      }
    ],
    "ClientIds": [
      {
        "Item1": "58156858-3629-4931-89d9-0043e5873b91",
        "Item2": "234341136598Test"
      }
    ]
  },
  "Status": 200,
  "Title": "",
  "Errors": []
}

Authorization: Required with

Authorization: Required with

Authorization: Required with

Authorization: Required with

Authorization: Required with

https://user.telematicssdk.com/swagger/index.html
https://user.telematicssdk.com
API Authorization Credentials
API Authorization Credentials
API Authorization Credentials
API Authorization Credentials
API Authorization Credentials
API Authorization Credentials