go back to EquipStatusService

GET /equipStatus/approvedDriverStatuses

Searches the database for approved driver status records that are upcoming or in progress and have the provided event code type.

Roles that can access this endpoint are Drivers.

Parameters

name description type default type
event_codes a comma-delimited string used as a query parameter to determine which type of events are to be returned. A null value will return all approved, upcoming or in progress data for a given driver.

Examples:

The call /equipstatus/approvedDriverStatuses?event_codes=TO would find approved time off (TO) driver status events for the current driver that are in the future or currently in progress, based on evaluation of current date/time against the record's provided start and end time frame.

The call /equipstatus/approvedDriverStatuses?event_codes=TO,BR would find find the data from the first example, but would also find approved bereavement leave (BR) as long as those record are also driver events for the future or are currently in progress.

The call /equipstatus/approvedDriverStatuses would find find all approved records that are upcoming or in progress for a given driver.

query String

Result

List < RowDriverStatus > of type: application/xml application/json

a list of RowDriverStatus objects

Additional attributes:

Child Elements:

Try It Out

Request

- Authentication Help
- String