Driver API
Get driver.
Retrieves a DriverResource resource.
Endpoint
GET - https://api.travisroadservices.com/v1/drivers/{id}
Copy
Path params
| Parameter | Type | Description |
|---|---|---|
id
|
string | DriverResource identifier |
Request body
No request bodyResponse body
Response 200
DriverResource resource
Fields
| Field | Type | Description |
|---|---|---|
id
|
string (uuid) | Unique identifier of the driver. |
driverInformation
|
object | Personal information of the driver such as name and phone number. |
firstName
|
string | First name of the driver. |
lastName
|
string | Last name of the driver. |
email
|
string (email) | Email address of the driver. |
phoneNumber
|
string | Phone number of the driver in E.164 format (e.g. +31612345678). |
companyName
|
string | Name of the company the driver is associated with. |
language
|
string | Preferred language of the driver as a BCP 47 language code (e.g. en, nl, de). |
country
|
string | ISO 3166-1 alpha-2 country code of the driver (e.g. NL, DE, FR). |
status
|
string | Current status of the driver account. |
defaultVehicle
|
object | The default vehicle assigned to the driver for bookings. |
truck
|
object | Default truck vehicle assigned to the driver. |
id
|
integer | Unique identifier of the vehicle. |
trailer
|
object | Default trailer vehicle assigned to the driver. |
id
|
integer | Unique identifier of the vehicle. |
notificationToken
|
string | Device push notification token for the driver. |
accountType
|
string | Type of the driver account. |
bookableServices
|
array | List of services the driver is allowed to book. |
features
|
array | Features enabled for the driver. Possible values: vehicle_management, wash_frequency. |
isVehicleManagementEnabled
|
boolean | Indicates whether vehicle management is enabled for the driver. |
customerStatus
|
string | Status of the customer account associated with the driver. |
frozenReason
|
string | Reason why the customer account is frozen, if applicable. |
paymentMethodType
|
string | Payment method type available for the driver. |
isBookingReferenceRequired
|
boolean | Indicates whether a booking reference is mandatory for this driver. |
Example
Response 401
No response body - No bearer token set verify if your token is added as bearer tokenResponse 403
No response body - You don't have access to this API resourceResponse 404
Not found
Fields
| Field | Type | Description |
|---|---|---|
title
|
string | A short, human-readable summary of the problem. |
detail
|
string | A human-readable explanation specific to this occurrence of the problem. |
status
|
number | The HTTP status code applicable to this problem. |
instance
|
string | A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced. |
type
|
string | A URI reference that identifies the problem type |
Example