Entity Information
Data type: DriverLog, fields list1. Get single driver log entry by id
URL: /api/driverLogs/{driverLogId}
| Query parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| driverlogId | Yes | Numeric | - | Driver log Id |
| includechilddivisions | No | True/False | False | Search logs from drivers/assets in subdivisions |
| includedisabledassets | No | True/False | False | Include logs from disabled assets |
| includedriverdata | No | True/False | False | Include driver data in Driver property |
2. Get driver logs
URL: /api/driverLogs
Sort order: reverse chronological (using Timestamp property)
| Query parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| startdatetime | No | Datetime | - | Filter by Timestamp. Returns driver logs with Timestamp greater or equal than value. |
| ensdatetime | No | Datetime | - | Filter by Timestamp. Returns driver logs with Timestamp less or equal than value. |
| assetId | No | Numeric | - | Filter by asset ID |
| driverId | No | Numeric | - | Filter by driver ID |
| includechilddivisions | No | True/False | False | Include logs from drivers/assets in subdivisions |
| includedisabledassets | No | True/False | False | Include logs from disabled assets |
| includedriverdata | No | True/False | False | Include driver data in Driver property |
| driverstatuses | No | Text | - | Filter by list of comma delimited driver statuses. Available values are listed here |
3. Get driver logs at moment of time, grouped by driver or asset.
URL: /api/driverLogs?datetime={datetime}
Sort order: reverse chronological (using Timestamp property)
Returns driver logs for specific date and groups them by asset or driver. For every asset or driver it will return only 1 driver log entry for requested date/time for your division.
| Query parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| datetime | Yes | Datetime 2013-12-20T11:00:00Z | - | Returns 1 driver log entry that was active by requested date per asset or driver. Both UTC and local dates are accepted. Check Dates Handling for details. |
| groupby | No | Text | asset | Groups driver logs by asset or driver. Possible values are "driver" and "asset" (without quotes). Used only if datetime parameter is specified. Default value is "asset" |
| assetId | No | Numeric | - | Filter by asset ID |
| driverId | No | Numeric | - | Filter by driver ID |
| includechilddivisions | No | True/False | False | Include logs from drivers/assets in subdivisions |
| includedisabledassets | No | True/False | False | Include logs from disabled assets |
| includedriverdata | No | True/False | False | Include driver data in Driver property |
| driverstatuses | No | Text | - | Filter by list of comma delimited driver statuses. Available values are listed here |
4. Get latest driver logs, grouped by driver or asset
URL: /api/driverLogs/latest
Sort order: reverse chronological (using Timestamp property)
Returns latest driver logs, single driver log entry per asset or per driver, depending on groupby parameter. Similar to method above, this one always return latest data.
| Query parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| groupby | No | Text | asset | Groups driver logs by asset or driver. Possible values are "driver" and "asset" (without quotes). Used only if datetime parameter is specified. Default value is "asset" |
| assetId | No | Numeric | - | Filter by asset ID |
| driverId | No | Numeric | - | Filter by driver ID |
| includechilddivisions | No | True/False | False | Include logs from drivers/assets in subdivisions |
| includedisabledassets | No | True/False | False | Include logs from disabled assets |
| includedriverdata | No | True/False | False | Include driver data in Driver property |
| driverstatuses | No | Text | - | Filter by list of comma delimited driver statuses. Available values are listed here |