Programming Guide to the Hours of Service Platform

My User

This API returns the details of the currently logged in User.

Fields

Tag Data Type Description
accountId Long The id of the Account that owns this record.
active Boolean Indicates if the User is currently active or not
alias Character (255) An optional identifier for the User within an Account. This is not shown if the value is null.
email Character (254) Email address that uniquely identifies User within the system
enabledFeatures Array Indicates the features enabled for the current User. Can contain any of the following as long as the Account also has them enabled:

  • ELD
  • DVIR
  • WORK_ORDERS
eulaAcceptedDate Text Timestamp of when the User accepted the Hours of Service EULA.
Note: Format is in timestamp and timezone (YYYY-MM-DDTHH:MM:SS.sssZ, e.g: 1970-01-01T00:00:00.000Z)
firstName Character (255) The first name of User
homeTerminalId Long Id of the Terminal where the User is assigned
id Auto-incremented Long Unique Identifier
lastChangedDate Text Auto-generated timestamp of the last change made to this record
Note: Format is in timestamp and timezone (YYYY-MM-DDTHH:MM:SS.sssZ, e.g: 1970-01-01T00:00:00.000Z)
lastName Character (255) The last name of User
password Character (255) The initial password for User
permissions Array Contains a list of all the Permissions the User currently has.
subsetId Long Only for Users that are Drivers. Indicates the Subset of the Terminal where the User is assigned.
suffix Character (25) Suffix of the User’s name.
userRoleIds Array List of User Role IDs the User currently has
visibilitySetIds Array  List of Visibility Set IDs associated with the User

Read

API PATH: /api/v2/myUser
METHOD: GET
EXAMPLE RESPONSE: 
{
  "firstName": "John",
  "lastName": "Doe",
  "suffix": "Jr",
  "email": "johndoe@mail.com",
  "eulaAcceptedDate": "2019-09-01T12:00:00.000Z",
  "userRoleIds": [
    1253415
  ],
  "permissions": [
    {
      "name": "PERM_IS_WORK_ORDER_ASSIGNEE",
      "category": "Users",
      "system": false,
      "id": 10
    },
    {
      "name": "PERM_IS_DRIVER",
      "category": "Users",
      "system": false,
      "id": 9
    }
  ],
  "visibilitySetIds": [
    2161
  ],
  "homeTerminalId": 6816,
  "active": true,
  "alias": "D-admin",
  "enabledFeatures": [
    "ELD",
    "DVIR"
  ],
  "accountId": 1248806,
  "id": 1253502,
  "lastChangedDate": "2019-09-01T12:00:00.000Z"
}

API error calls

ERROR MESSAGE POSSIBLE CAUSES
POST is not supported. POST method is not allowed
PUT is not supported. PUT method is not allowed
DELETE is not supported. DELETE method is not allowed