Drivers / Events

Get driver event codes

Get driver event codes.

GET

/fm/driver-event-codes

curl --request GET \
  --url 'https://api.catch-e.com/fm/driver-event-codes?driver_event_code=%3Cstring%3E&name=%3Cstring%3E&include_inactive_flag=no&page=1&page_size=25' \
  --header 'Authorization: <api-key>'

{
  "_embedded": {
    "fm_driver_event_codes": [
      {
        "driver_event_code": "<string>",
        "driver_event_code_id": "<string>",
        "name": "<string>",
        "status_flag": "active"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.catch-e.com/fm/driver-event-codes"
    }
  },
  "page": 1,
  "page_count": 1,
  "page_size": 25,
  "total_items": 1
}

This method requires the DriverEventCodes:Get permission to be associated with your role.

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Query Parameters

driver_event_codestringquery

Optional Driver Event Code

This field supports the wildcard % operator.

Maximum string length: 8

namestringquery

Optional Name

This field supports the wildcard % operator.

include_inactive_flagenum<string>querydefault:no

Set to yes if inactive event codes are required in the list.

Available options: yes, no

pageintegerquerydefault:1

Optional page number

Required range: 1 <= x <= 2147483647

page_sizeintegerquerydefault:25

Optional page size

Required range: -1 <= x <= 2147483647

Response

Success

_embeddedobject

Show child attributes

_linksobject

pageinteger

Example: 1

page_countinteger

Example: 1

page_sizeinteger

Example: 25

total_itemsinteger

Example: 1

Still need help? Ask the team