GetDriverEvents

Overview

This API returns details for a list of driver events.

Supplementary SWAGGER documentation is available here:

https://api.catch-e.com/docs/#/Drivers%20%2F%20Events/getDriverEvents

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 DriverEvents:Get.

Authentication

Authenticate with the API before running this API.

HTTP Method

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

URL Examples

https://api.test.catch-e.com/fm/driver-events/

Path Variables

Refer to the swagger for the parameters:

https://api.catch-e.com/docs/#/Drivers%20%2F%20Events/getDriverEvents
All parameters are optional.
Only records where [fm_driver_events]status_flag = 'active' are passed.

Response Details

Validation Message	Comments
200 OK	The request was successful and the driver event has been updated
403 - Forbidden	You do not have permissions for this request
422 - Unprocessable Entity	Validation failed - see error examples for specific issues

Successful Response Example

{ "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver-events/?page=1" }, "first": { "href": "https://api.test.catch-e.com/fm/driver-events/" }, "last": { "href": "https://api.test.catch-e.com/fm/driver-events/?page=16" }, "next": { "href": "https://api.test.catch-e.com/fm/driver-events/?page=2" } }, "_embedded": { "fm_driver_events": [ { "driver_event_id": "100024", "driver_id": "101047", "driver_event_code_id": "100007", "event_date": "2012-06-18", "event_value": "", "description": "Call driver about his quote", "driver_event_value_id": null, "driver_event_description_id": null, "driver_event_action_id": "100002", "due_date": "2012-06-19", "completed_flag": "yes", "attachment_id": "102031", "user_id_edit": "10003", "last_edit": "2012-06-18 04:56:49", "status_flag": "active", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver-events/100024" } } } ] }, "page_count": 16, "page_size": 25, "total_items": 396, "page": 1 }

Error Response Examples

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.

422 Unprocessable Entity

{ "validation_messages": { "driver_event_id": { "noRecordFound": "No record matching the input was found" } }, "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Unprocessable Entity", "status": 422, "detail": "Failed Validation" }

Driver Event ID not found.

Was this helpful?

Still need help? Ask the team