Entity Information

Data type: DriverLog, fields list

1. Get single driver log entry by id

URL: /api/driverLogs/{driverLogId}

Query parameterRequiredTypeDefaultDescription
driverlogIdYesNumeric-Driver log Id
includechilddivisionsNoTrue/FalseFalseSearch logs from drivers/assets in subdivisions
includedisabledassetsNoTrue/FalseFalseInclude logs from disabled assets
includedriverdataNoTrue/FalseFalseInclude driver data in Driver property

2. Get driver logs

URL: /api/driverLogs

Sort order: reverse chronological (using Timestamp property)

Query parameterRequiredTypeDefaultDescription
startdatetimeNoDatetime-Filter by Timestamp. Returns driver logs with Timestamp greater or equal than value.
ensdatetimeNoDatetime-Filter by Timestamp. Returns driver logs with Timestamp less or equal than value.
assetIdNoNumeric-Filter by asset ID
driverIdNoNumeric-Filter by driver ID
includechilddivisionsNoTrue/FalseFalseInclude logs from drivers/assets in subdivisions
includedisabledassetsNoTrue/FalseFalseInclude logs from disabled assets
includedriverdataNoTrue/FalseFalseInclude driver data in Driver property
driverstatusesNoText-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 parameterRequiredTypeDefaultDescription
datetimeYes

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.
groupbyNoTextassetGroups 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"
assetIdNoNumeric-Filter by asset ID
driverIdNoNumeric-Filter by driver ID
includechilddivisionsNoTrue/FalseFalseInclude logs from drivers/assets in subdivisions
includedisabledassetsNoTrue/FalseFalseInclude logs from disabled assets
includedriverdataNoTrue/FalseFalseInclude driver data in Driver property
driverstatusesNoText-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 parameterRequiredTypeDefaultDescription
groupbyNoTextassetGroups 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"
assetIdNoNumeric-Filter by asset ID
driverIdNoNumeric-Filter by driver ID
includechilddivisionsNoTrue/FalseFalseInclude logs from drivers/assets in subdivisions
includedisabledassetsNoTrue/FalseFalseInclude logs from disabled assets
includedriverdataNoTrue/FalseFalseInclude driver data in Driver property
driverstatusesNoText-Filter by list of comma delimited driver statuses. Available values are listed here