GetDriverEventDescriptions

Overview

This method returns a list of Driver event descriptions.

Use this information to find and populate the required description for events in the API createDriverEvents.

Supplementary SWAGGER documentation is available here: https://api.catch-e.com/docs/#/Driver%20%2F%20Events/getDriverEventDescriptions

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 DriverEventDescriptions:Get

HTTP Method

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

URL Examples

https://api.demo.catch-e.com/authenticate

https://api.{{environment}}.catch-e.com/authenticate

https://api.test.catch-e.com/fm/Driver-event-descriptions

Parameters - Path Variables

Key	Format	Notes	Mandatory
driver_event_code_id	string	driver_event_code_id.	no
include_inactive_flag	string	Available values : no, yes Default value : no Set to yes if inactive event codes are required in the list.	no
page	integer($int32)	Page number. Default value: 1	no
page_size	integer($int32)	Page size. Default value : 25	no

Successful Response Example

{ "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver-event-descriptions/?page=1" }, "first": { "href": "https://api.test.catch-e.com/fm/driver-event-descriptions/" }, "last": { "href": "https://api.test.catch-e.com/fm/driver-event-descriptions/?page=1" } }, "_embedded": { "fm_driver_event_descriptions": [ { "driver_event_description_id": "100000", "driver_event_code_id": "100000", "event_description": "Test", "default_flag": "no", "status_flag": "active", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver-event-descriptions/100000" } } }, { "driver_event_description_id": "100002", "driver_event_code_id": "100007", "event_description": "CC Description 1", "default_flag": "yes", "status_flag": "active", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver-event-descriptions/100002" } } }, { "driver_event_description_id": "100003", "driver_event_code_id": "100007", "event_description": "CC Description 2", "default_flag": "no", "status_flag": "active", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver-event-descriptions/100003" } } }, { "driver_event_description_id": "100005", "driver_event_code_id": "100008", "event_description": "Test3", "default_flag": "no", "status_flag": "active", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver-event-descriptions/100005" } } } ] }, "page_count": 1, "page_size": 25, "total_items": 4, "page": 1 }

Error Response Details

Validation Messages	Comments
404 Not Found
"detail": "API endpoint not found"
{"driver_event_code_id": {"noRecordFound": "No record matching the input was found"}}	The name passed is not stored in the database.
423 Failed Validation
"detail": "Locked"	Either the Driver is being edited or Billing is being processed. Try again once the Driver is no longer in use or the Billing process has completed.
403 - Forbidden
"detail": "Forbidden"	You do not have permissions for this request.

Was this helpful?

Still need help? Ask the team