Programming guide to the HOS platform
Response property accessToken All API requests should use "accessToken" as bearer token
| user required | string User login |
| password required | string Password |
| company | string Company ID. Required for auth token that will be used for all requests except /companies endpoint |
{- "user": "string",
- "password": "string",
- "company": "string"
}{- "accessToken": "string"
}| vehicleId | string ID of the vehicle |
| $skip | integer >= 0 Number of records you want to skip (can be used for paging) |
| $limit | integer >= 0 Number of records you want to fetch (can be used for paging) |
{- "data": [
- {
- "companyId": "string",
- "userId": "string",
- "odometer": 0,
- "speed": 0,
- "lat": 0,
- "lon": 0,
- "code": "M",
- "time": "string",
- "vehicleId": "string"
}
]
}| userId | string ID of the driver |
| $skip | integer >= 0 Number of records you want to skip (can be used for paging) |
| $limit | integer >= 0 Number of records you want to fetch (can be used for paging) |
{- "data": [
- {
- "companyId": "string",
- "userId": "string",
- "break": 0,
- "drive": 0,
- "shift": 0,
- "cycle": 0,
- "dutyStatus": "DS_OFF"
}
]
}| $skip | integer >= 0 Number of records you want to skip (can be used for paging) |
| $limit | integer >= 0 Number of records you want to fetch (can be used for paging) |
{- "data": [
- {
- "_id": "string",
- "name": "string",
- "vin": "string",
- "active": true,
- "companyId": "string"
}
]
}| $skip | integer >= 0 Number of records you want to skip (can be used for paging) |
| $limit | integer >= 0 Number of records you want to fetch (can be used for paging) |
{- "data": [
- {
- "_id": "string",
- "username": "string",
- "firstName": "string",
- "lastName": "string",
- "companyId": "string"
}
]
}| $skip | integer >= 0 Number of records you want to skip (can be used for paging) |
| $limit | integer >= 0 Number of records you want to fetch (can be used for paging) |
{- "data": [
- {
- "_id": "string",
- "name": "string"
}
]
}