go back to DriverService

GET /drivers/search

Searches the database for drivers matching the given request parameters.

Roles that can access this endpoint are Users.

Parameters

name description type default type
request read for query parameters to be used as search criteria; use any combination of fields from the location table using a prefix of driver or no prefix.

For example, /drivers/search?driver.state=AL&last_home_date=<=t-30 would find drivers in the state of Alabama who haven't been home in the last 30 days.

Sorting: To sort the result set, you can provide the following reserved query parameter: orderBy If the orderBy parameter is not provided a default sort of driver.id+ASC will be applied.

For example, /drivers/search?driver.is_active=Y&orderBy=driver.id+DESC would return all active driver records sorted descending by the driver id. Multiple sort columns can be provided in a comma delimited format. orderBy=prefix.field+direction,prefix.field+direction

Pagination: To page the result set, you can provide the following reserved query parameters: recordLength and recordOffset

For example, /drivers/search?driver.is_active=Y&recordLength=100&recordOffset=50 would return 100 records starting at the 51st record in the return record set. If no recordLength parameter is provided the search result maximum value in the mobile service control file will be applied.

context HttpServletRequest

Result

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

a list of RowDriver objects

Try It Out

Request

- Authentication Help