Powered by Redocly

Models

Vehicle models describe the manufactured model of a vehicle.

Model

Vehicle model.

id
integer <int64>

Vehicle model identifier.

enabled
boolean

Whether the vehicle model is enabled. A disabled vehicle model cannot be used to create new tickets.

make_id
integer <int64>

Vehicle make identifier.

manufactured_from
string or null <date>

Date on which vehicle model manufacturing started (first of month).

manufactured_till
string or null <date>

Date on which vehicle model manufacturing ended (end of month).

model_group_id
integer <int64>

Vehicle model group identifier.

name
string [ 1 .. 255 ] characters

Name of vehicle model.

{
  • "id": 5874,
  • "enabled": true,
  • "make_id": 49,
  • "manufactured_from": "2010-01-01",
  • "manufactured_till": "2015-06-30",
  • "model_group_id": 5796,
  • "name": "FOCUS - III"
}

Retrieve vehicle models

Retrieve a list of vehicle models.

SecurityOAuth2
Request
query Parameters
limit
integer <int32> [ 0 .. 1000 ]
Default: 25

Limits the amount of resources in result.

make_id
integer <int64>

Filter vehicle models by make identifier.

model_group_id
integer <int64>

Filter vehicle models by model group identifier.

offset
integer <int64> >= 0
Default: 0

Offset of resources in result.

Responses
200

Successful response.

Response Schema: application/json
object >= 0 properties

Applied query parameters, including defaults.

limit
integer <int32> [ 0 .. 1000 ]
Default: 25

The applied value of the limit query parameter on the resources in result.

offset
integer <int64> >= 0
Default: 0

The applied value of the offset query parameter on the resources in result.

property name*
additional property
any
Array of objects (Model) >= 0 items

List of models.

Array (>= 0 items)
id
integer <int64>

Vehicle model identifier.

enabled
boolean

Whether the vehicle model is enabled. A disabled vehicle model cannot be used to create new tickets.

make_id
integer <int64>

Vehicle make identifier.

manufactured_from
string or null <date>

Date on which vehicle model manufacturing started (first of month).

manufactured_till
string or null <date>

Date on which vehicle model manufacturing ended (end of month).

model_group_id
integer <int64>

Vehicle model group identifier.

name
string [ 1 .. 255 ] characters

Name of vehicle model.

total
integer <int64>

Total number of resources matching provided query parameters.

default

An error occurred - see status code and problem response for more information.

get/v2/vehicles/models
Response samples
application/json
{
  • "query": {
    },
  • "result": [
    ],
  • "total": 3255
}

Retrieve vehicle model

Retrieve a single vehicle model by its identifier.

SecurityOAuth2
Request
path Parameters
model-id
required
integer <int64>

Vehicle model identifier.

Responses
200

Successful response.

Response Schema: application/json
id
integer <int64>

Vehicle model identifier.

enabled
boolean

Whether the vehicle model is enabled. A disabled vehicle model cannot be used to create new tickets.

make_id
integer <int64>

Vehicle make identifier.

manufactured_from
string or null <date>

Date on which vehicle model manufacturing started (first of month).

manufactured_till
string or null <date>

Date on which vehicle model manufacturing ended (end of month).

model_group_id
integer <int64>

Vehicle model group identifier.

name
string [ 1 .. 255 ] characters

Name of vehicle model.

default

An error occurred - see status code and problem response for more information.

get/v2/vehicles/models/{model-id}
Response samples
application/json
{
  • "id": 5874,
  • "enabled": true,
  • "make_id": 49,
  • "manufactured_from": "2010-01-01",
  • "manufactured_till": "2015-06-30",
  • "model_group_id": 5796,
  • "name": "FOCUS - III"
}