Products are the different variants of the Hours of Service platform. They are likened to packages or set-ups with a definite set of modules inside an Account. A single Account may have more than one Product and can resell multiple Products, thus allowing its sub-accounts access to the module components, depending on their Products. With the use of Products, only necessary components are installed on an Account instead of all the Hours of Service modules.
Fields
| Tag | Data Type | Description |
| id | Auto-incremented Long | Unique Identifier |
| moduleId | Text | Internal module identifier of the Product. |
| name | Character (255) | The name of the Product as it appears in the UI |
| version | Integer | Version number of the Product. |
Read
| API PATH: | /api/v2/products |
| METHOD: | GET |
| PARAMETERS: | name – Retrieves matching records with the specific name (e.g. name=HOS, all Products by default) offset – Retrieves matching records after an offset value (e.g. offset=2) limit – Retrieves a number of records per page specified by the value (e.g. limit=10) |
| SORTING: | sort=id – Sort records by their id field in ascending order (DEFAULT) sort=-id – Sort records by their id field in descending order sort=name – Sort records by their name field in ascending order sort=-name – Sort records by their name field in descending order |
| QUERY STRING EXAMPLES: | Get the Product with the specified id: api/v2/products/1247624 Get two Products of the current Account with an offset of 1 : ?offset=1&limit=2 Get all Products of the current Account sorted by name alphabetically: ?sort=name |
| EXAMPLE RESPONSE: |
[
{
"id": 1247189,
"name": "Work Orders",
"moduleId": "com.azugaeld.workorders",
"version": 131
},
{
"id": 1247623,
"name": "ELD",
"moduleId": "com.azugaeld.snaptraqhos",
"version": 9
},
{
"id": 1248099,
"name": "DVIR",
"moduleId": "com.azugaeld.dvir",
"version": 7
}
]
|
API error calls
| ERROR MESSAGE | POSSIBLE CAUSES |
| Access Denied. | POST, PUT and DELETE methods are not allowed |