Returns a paginated list of Vehicle objects for the Calendar
| Time |
Status |
User Agent |
| Make a request to see history. |
|
|
URL Expired
The URL for this request expired after 30 days.
Request Parameters
| Field |
Type |
Description |
| id |
integer |
The id of the dealership |
| sort |
string |
The sort order for each sort field MUST be ascending unless prefixed with a minus (i.e., "-"), in which case it MUST be descending. Allowed Sort fields are make, model, year, mileage, vin, stock_number, license, status |
| fleet_ids |
array of integers |
Filter vehicles results to those that belong to these fleet ids |
| active |
boolean |
Filter vehicles to those that are either active or inactive |
| status |
array of strings |
Comma separated list of states (in_prep staged returned) |
| mileage_min |
number |
Find Vehicles with mileage in kilometers greater than or equal to mileage_min |
| mileage_max |
number |
Find Vehicles with mileage in kilometers less than or equal to mileage_max |
| make |
string |
Comma Separated list of makes to filter vehicles by |
| model |
string |
Comma Separated list of models to filter vehicles by |
| page |
number |
The page to be fetched, by default 1 |
| per_page |
number |
Number of items per page to be fetched, by default 30 |
| api-version |
integer |
Target API version |
Response Examples
200 Success
Array of objects:
| Field |
Type |
Description |
| id |
number |
Vehicle ID |
| make |
string |
Vehicle make |
| model |
string |
Vehicle model |
| power_train |
string |
Type of power train |
| year |
number |
Year of manufacture |
| mileage |
object |
Mileage details |
| vin |
string |
Vehicle Identification Number |
| stock_number |
string |
Stock number |
| license |
string |
License plate |
| status |
string |
Current status |
| color |
string |
Color of vehicle |
| links |
object |
Associated links |
Example Response
[
{
"id": 1,
"make": "Ford",
"model": "Focus",
"power_train": "mechanical",
"year": 2018,
"mileage": {
"value": 20055.12,
"unit": "km"
},
"vin": "1FADP3K2XJL234567",
"stock_number": 1234567,
"license": "123ABC",
"status": "rented",
"color": "Red",
"links": {
"fleet": {
"id": 2,
"href": "https://api.dw-tst.com/admin/some_resources/2"
},
"fleets": [
{
"id": 2,
"href": "https://api.dw-tst.com/admin/some_resources/2"
}
]
}
}
]
Error Responses
401 Unauthorized
403 Forbidden
404 Not found
406 Not Acceptable