API explorer
Fleet Management API Beta

Sections

Theme switcher

Get a driver.

Authentication

Bearer Token

Standard HTTP Bearer token. Enter the 'access_token' value.

TokenstringRequired

Header Parameters

Authorizationstring

This API is protected under OAuth 2 with the client_credentials grant flow and requires an API client_id and client_secret.
The client_id and client_secret are provisioned by the Fleet Services team.

Access Tokens have a lifespan of 15 minutes.

Requesting an access token

Parameters:

  • client_id = my-client-id
  • client_secret = my-client-secret
  • [base-url] = Replace with the correct server URL for the environment you are using (e.g. - https://wmd.xc.wexonl...

Path Parameters

driver-idstring Required

The row ID for the Driver

Min length
1

Response

200
Object

200 (Ok)

Response Attributes

_linksobject

HATEOAS links related to the driver.

Show child attributes

account_idstring

A unique identifier for the account.

Min length
1
contactallof

Driver contact information.

All Of:

badge_numberstring

Badge number.

cell_phone_numberstring | null

Cell Phone number.

Pattern
^\d{10}$
emailstring

Email address.

employee_numberstring

Employee number.

first_namestring

First name.

Max length
30
job_titlestring

Job title.

last_namestring

Last name.

Max length
30
middle_namestring

Middle name.

Max length
20
phone_numberstring
Pattern
^\d{10}$
preferred_communicationstring

The preferred method of communication.

titlestring

Surname title of the driver.

zip_codestring
departmentobject

Department information.

Show child attributes

driver_idstring

Driver id.

driver_licenseobject

Driver license information.

Show child attributes

driver_numberstring

Number assigned to driver.

evobject

Electric vehicle information

Show child attributes

last_updatedstring

The date and time this object was updated in the format: YYYY-MM-DDTHH:MM:SSZ.

prompt_idstring

Id of driver prompt.

purchase_device_idstring

The id of the card this driver is associated with, if any.

requested_bystring

Id of user updating the driver.

share_modestring

Indicates the level of vehicle sharing.

statusallof

Driver status information.

All Of:

statusstring

Indicates if the driver is Active or Terminated.

Enum values:
ACTIVETERMINATED
status_reasonstring

Reason for the driver status.

status_changed_datestring

Date status was last changed. Format: YYYY-MM-DDTHH:MM:SSZ.

user_defined_fieldsarray

A list of User Defined Fields.

Max items
20

Show child attributes

400
Object

400 (Bad Request)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
401
Object

401 (Unauthorized)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
403
Object

403 (Forbidden)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
404
Object

404 (Not Found)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
500
Object

500 (Internal Server Error)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?