Programming Guide to the Hours of Service Platform

My Account

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

Fields

Tag Data Type Description
accountToken Character (40) Unique string identifier used to login from a specific Account
allowSubAccountBranding Boolean Indicates if the Account allows sub account branding or not.
canCreateReseller Boolean Indicates if the Account can create other reseller Accounts or not.
domainName Text Contains an Account’s custom domain name. This is not returned for Accounts that don’t have one.
features Object Contains Features and indicates if they are available for the Account:

  • ifta – when set to true, this enables the Portal’s State Mileage Menu
    map – when set to true, this enables the Portal’s Locations Page
  • eld – when set to true, this enables the Portal’s Hours of Service Menu
  • dvir – when set to true, this enables the Portal’s DVIR Menu
  • workOrder – when set to true, this enables the Portal’s Mobile Worker Menu in the Portal
  • complianceSupportCenter – when set to true, this means that drivers under the account can contact the compliance support agents
id Auto-incremented Long Unique Identifier
isReseller Boolean Indicates if the Account is a reseller or not
name Character (225) The name of the Account.
productIds Array The ids of the Product(s) enabled in the Account.
resellableProducts Array  The ids of the Product(s) that an Account can resell to its own sub-accounts.
topLevel Boolean Indicates if the Account is a top level account or a sub account.
uuid Text (unlimited)  Internal use only.

Read

API PATH: /api/v2/myAccount
METHOD: GET
EXAMPLE RESPONSE: 
{
  "id": 1249104,
  "name": "Account 1",
  "accountToken": "0ADFF3DDC0BA42958F315C352B27AD96",
  "uuid": "a678b9eb-0b6d-402e-b812-5a27e1e6c050",
  "canCreateReseller": true,
  "isReseller": true,
  "topLevel": false,
  "domainName": "www.account.com",
  "allowSubAccountBranding": false, 
  "productIds": [
    1247623,
    1248099,
    1247189
  ],
  "resellableProducts": [
    {
      "id": 1247623
    },
    {
      "id": 1248099
    },
    {
      "id": 1247189
    }
  ],
  "features": {
    "ifta": true,
    "map": true,
    "eld": true,
    "dvir": true,
    "workOrder": true,
    "complianceSupportCenter": false
  }
}

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