GetDriverEventActions

Overview

This method returns a list of Driver event actions.

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

Supplementary SWAGGER documentation is available here:

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

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 DriverEventActions: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-actions

Parameters - Path Variables

Key	Format	Notes	Mandatory
name	string	Name of Action. This field supports the wildcard % operator (See Wildcard % operator notes below).	no
page	integer($int32)	Page number. Default value : 1	no
page_size	integer($int32)	Page size. Default value : 25	no

Key

Format

Notes

Mandatory

name

string

Name of Action.

This field supports the wildcard % operator (See Wildcard % operator notes below).

page

integer($int32)

Page number. Default value : 1

page_size

integer($int32)

Page size. Default value : 25

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.

Successful Response Example

{ "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver-event-actions/?page=1" }, "first": { "href": "https://api.test.catch-e.com/fm/driver-event-actions/" }, "last": { "href": "https://api.test.catch-e.com/fm/driver-event-actions/?page=1" } }, "_embedded": { "fm_driver_event_actions": [ { "driver_event_action_id": "100000", "name": "Closed", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver-event-actions/100000" } } }, { "driver_event_action_id": "100001", "name": "Follow Up", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver-event-actions/100001" } } }, { "driver_event_action_id": "100002", "name": "None", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver-event-actions/100002" } } }, { "driver_event_action_id": "100003", "name": "Urgent", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/driver-event-actions/100003" } } } ] }, "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"
422 Unprocessable Entity
{"name": {"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