This API version is deprecated
Please use the latest version for continued support and access to new features. View latest API documentation
Vehicle API
Check vehicle wash frequency.
Check vehicle wash frequency.
Endpoint
POST - https://api.travisroadservices.com/v1/vehicles_wash_frequency_check
Copy
Request body
Fields
| Field | Type | Required | Description |
|---|---|---|---|
vehicle1
|
string (iri-reference) | No | First vehicle (truck) to check wash frequency for. |
vehicle2
|
string (iri-reference) | No | Second vehicle (trailer) to check wash frequency for. |
cleaningType
|
string | Yes | Cleaning type to check the wash frequency for. Possible values: inside, outside. |
arrivalDate
|
string | Yes | Intended arrival date against which the wash frequency is checked. Format: YYYY-MM-DD. |
Example
Response body
Response 200
VehicleWashFrequencyResource resource created
Fields
| Field | Type | Description |
|---|---|---|
violations
|
array | List of wash frequency violations for the given vehicles and cleaning type. |
isBookingBlocked
|
boolean | Indicates whether booking is blocked due to a wash frequency violation. |
Example
Response 400
Invalid input
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
|
integer | 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
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 422
An error occurred
Fields
| Field | Type | Description |
|---|---|---|
status
|
integer | The HTTP status code (422). |
violations
|
array | A list of constraint violations that caused the error. |
detail
|
string | A human-readable description of the validation errors. |
type
|
string | A URI reference identifying the validation error type. |
title
|
string | A short summary of the error. |
instance
|
string | A URI reference identifying the specific occurrence of the error. |
Example