Skip to main content
Omnitracs Knowledge Base

HOS Driver Log Events

add.pngAvailable in PIT v2.3

This ILE API wraps the HOS Driver Log Events web service. See its documentation for a further explanation of the input and output parameters, as well as the possible error conditions.

API Name: HSDRVLE

Parameter Interface:

Parameter

Direction

Type

Length

Precision

Description

Event ID

Input

Character

50

n/a

Event ID starting value from which subsequent log events are returned. A zero value indicates the Start TS input parameter will be used to determine the log event data starting point.

Start Timestamp

Input

Character

50

n/a

Optional start TS in GMT (see below) may be specified in the initial call or left blank to return today's log events. Subsequent calls may use returned event IDs to scroll through the log events from some starting position. Format of TS string may be all blanks or 'YYYY-MM-DDTHH:MM:SS.SSSSSSS-00:00'.

Time Resolution

Input

Character

1

n/a

This parameter specifies whether certain values in the response are returned in seconds or minutes, where '1' = Values are returned in seconds, and '0' = values are returned in minutes.

Driver Log Events Array

Output

Character

n/a

n/a

An array of up to 1000 driver log event structures as shown below. Also see the HSDRVLOGARR and HSLOGEVENT structures defined in the HSDRVLEDS copy file.

Next Event ID

Output

Character

50

n/a

Event ID which may be used as input to the next call in order to page through the log events. A zero return value indicates the call did not result in any data being returned.

Error Category

Output

Decimal

3

0

Error Category, if any

Error Code

Output

Decimal

5

0

Error Code, if any

Error Description

Output

Character

150 varying

n/a

Error description, if any

An error category of 0 means that the driver's details were returned successfully.

Driver Log Event Structure (HSLOGEVENT):

This data structure may be mapped over each of the 1000 elements of the driver log events array output parameter. The array contains a fixed number of elements (1000) - a blank Driver ID (driverID) field value indicates the given array entry and it's associated fields are "empty" and do not contain any log event data. See the HSDRVLEDS copy file for all related external structure definitions:

Field

Type

Length

Precision

Description

driverID

Character

100

n/a

Driver Id

eventType

Character

100

n/a

Log Event Type

eventTS

Character

19

n/a

Log event timestamp (YYYY-MM-DDTHH:MM:SS)

logTS

Character

19

n/a

Logging timestamp (YYYY-MM-DDTHH:MM:SS)

  • Was this article helpful?