Get Driver Endpoints: GetDrivers

API endpoints for retrieving driver data

GetDrivers

Allows you to extract details for multiple drivers

Permissions

To run this API, the nominated 'web-services' role needs to be given permission.

If you are not actively using the API, leave the permission off for better security.

Go to Roles / Apis and check on Drivers:Get.

Authentication

Authenticate with the API before running this API.

HTTP Method

Use the HTTP Method 'GET' for consuming this web service.

Input Fields (Body)

JSON FieldFormatNotesMandatory
client_idStringClient IDNo
clientcostcentre_idStringClient Cost Centre IDNo
given_nameStringGiven Name. This field supports the wildcard % operator (See Wildcard % operator notes below).No
surnameStringSurname. This field supports the wildcard % operator (See Wildcard % operator notes below).No
home_emailstringEmailNo
external_codeStringExternal Code. This field supports the wildcard % operator (See Wildcard % operator notes below).No
useridpackage_advisorStringPackage Advisor User ID.No

Wildcard % operator notes:

If you are using "Postman" app, with the wildcard operator, the search string of either %ab% or %ba%, will give this response:

"field_name": {"isEmpty": "Value is required and can't be empty"}.

If you need to search either %ab% or %ba%, please use %25ab%25 or %25ba%25 as required to return results as expected.

Input Fields (JSON)

{ "client_id":"100052", "client_cost_centre_id": null, "external_code":"%", "given_name":"%", "surname":"%", "user_id_package_advisor": null, "page":"1", "page_size":"25"}

Successful Response Example

{ "_links": { "self": { "href": "https://api.catch-e.com/fm/drivers?client_id=100052&page=1&page_size=25" }, "first": { "href": "https://api.catch-e.com/fm/drivers?client_id=100052&page_size=25" }, "last": { "href": "https://api.catch-e.com/fm/drivers?client_id=100052&page=2&page_size=25" }, "next": { "href": "https://api.catch-e.com/fm/drivers?client_id=100052&page=2&page_size=25" } }, "_embedded": { "fm_drivers": [ { ... ... } } } ] }, "page_count": 2, "page_size": 25, "total_items": 34, "page": 1}

Error Response Details

Validation MessagesComments
400 - Bad Request
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Bad Request", "status": 400, "detail": "JSON decoding error: Syntax error, malformed JSON"}

| The JSON payload content is not formatted correctly. |
| 401 - Unauthorized | | |

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unauthorized", "status": 401, "detail": "Unauthorized"}

| You have not authenticated before running this API or The token_timeout of the current session has passed. You need to authenticate again. |
| 403 - Forbidden | | |

{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Forbidden", "status": 403, "detail": "Forbidden"}

| You do not have permissions for this request. Go to System Roles and enter 'web_services' Navigate to the Roles / APIs tab to make sure the permission you need to run this API is checked. |
| 409 - Conflict | | |

{ "validation_messages": [ { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Conflict", "status": 409, "detail": "Invalid page provided"}

| Invalid page number provided |
| 422 - Unprocessable Entity | | |

{ "validation_messages": { "home_email": { "emailAddressInvalidFormat": "The input is not a valid email address. Use the basic format local-part@hostname" } },

| Invalid email address | |

{ "validation_messages": { "home_email": { "emailAddressInvalidHostname": "''catch-e'.com.au' is not a valid hostname for the email address", "hostnameInvalidHostnameSchema": "The input appears to be a DNS hostname but cannot match against hostname schema for TLD 'AU'", "hostnameInvalidLocalName": "The input does not appear to be a valid local network name" }

| Email domain contains an apostrophe |