GetDriverEventValues

Overview

This method returns a list of Driver event values.

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

Supplementary SWAGGER documentation is available here:

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

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 DriverEventValues: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-values

Path Variables

Key	Format	Notes	Mandatory
driver_event_code_id	string	drivereventcode_id	No
event_value_id	string	event_value_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

Response Details

Validation Message	Comments
404 Not Found	"detail": "API endpoint not found"
422 Unprocessable Entity	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.

Successful Response Example

{ "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver-event-values/?page=1" }, "first": { "href": "https://api.test.catch-e.com/fm/driver-event-values/" }, "last": { "href": "https://api.test.catch-e.com/fm/driver-event-values/?page=1" } }, "_embedded": { "fm_driver_event_values": [ { "driver_event_value_id": "11989979731563994522", "driver_event_code_id": "100001", "event_value": "Authorised", "default_flag": "no", "status_flag": "active", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver-event-values/11989979731563994522" } } }, { "driver_event_value_id": "11989979731563994523", "driver_event_code_id": "100001", "event_value": "Pending", "default_flag": "yes", "status_flag": "active", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver-event-values/11989979731563994523" } } }, { "driver_event_value_id": "11989979731563994524", "driver_event_code_id": "100001", "event_value": "Re-issue", "default_flag": "no", "status_flag": "active", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver-event-values/11989979731563994524" } } } ] }, "page_count": 1, "page_size": 25, "total_items": 3, "page": 1 }

Error Response Examples

422 Unprocessable Entity

{"driver_event_code_id": {"noRecordFound": "No record matching the input was found"}}

Was this helpful?

Still need help? Ask the team