GetDriverEvent

Overview

This API returns details for a single driver_event_id.
Supplementary SWAGGER documentation is available here:

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

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/{driver_event_id}

Path Variables

Key	Format	Notes	Mandatory
driver_event_id	string	driver Event ID.	Required

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 Content	Validation failed - see error examples for specific issues

Successful Response Example

{ "driver_event_id": "100002", "driver_id": "100100", "driver_event_code_id": "100006", "event_date": "2006-10-10", "event_value": null, "description": "Signed docs received", "driver_event_value_id": null, "driver_event_description_id": null, "driver_event_action_id": "100000", "due_date": "0000-00-00", "completed_flag": "yes", "attachment_id": null, "user_id_edit": "10003", "last_edit": "2006-10-23 06:35:20", "status_flag": "active", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver-events/100002" } } }

Error Response Examples

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 Content

{ "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