Vehicles

Vehicle details

Options

Enable CORS by returning correct headers

SecurityNone

Responses

200

Enable CORS by returning correct headers

options/v1/historical-vehicles

Retrieve recently serviced vehicles

Retrieve serviced vehicles, sorted by most recent to oldest.

SecurityOAuth2 or JifelineAuthorizer

Request

query Parameters

offset	integer >= 0 The number of items to skip before starting to collect the result set.
limit	integer [ 0 .. 200 ] The maximum number of items to return, the maximum numers of items to return is set to 200. Example: limit=20

Responses

200

List of recently serviced vehicles

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

403

Returned when a client requests a resource it's not authorized for.

500

Returned when an error occurs on the server

get/v1/historical-vehicles

Response samples

application/json

{"result": [{"make_id": 10,
"make_name": "Ford",
"model_group_id": 44,
"model_group_name": "Focus",
"model_id": 23423,
"model_name": "FOCUS - II (DA_, HCP, DP)",
"model_variant_id": 34234,
"model_variant_name": "1.4 59KW ASDA, ASDB",
"vin": "JFL91010104391010",
"last_serviced_at": "2021-09-08T10:03:29+00:00"
}
],
"total": 234,
"offset": 200,
"limit": 20
}

Options

Enable CORS by returning correct headers

SecurityNone

Responses

200

Enable CORS by returning correct headers

options/v1/vehicles/search

Search for vehicle brand, model, type and engine by VIN

Get all vehicle brands

SecurityOAuth2 or JifelineAuthorizer

Request

query Parameters

vin

required

string

The Vehicle Identification number to search the vehicle for

Example: vin=JFL91010104391010

Responses

200

Vehicle

400

Returned when a client sends a bad request.

401

Returned when a request is performed without or with an incorrect OIDC token

403

Returned when a client requests a resource it's not authorized for.

500

Returned when an error occurs on the server

get/v1/vehicles/search

Response samples

application/json

{"make": {"id": 10,
"name": "Ford"
},
"model_group": {"id": 234,
"name": "Focus",
"vehicle_make_id": 0,
"vehicle_make_name": "string"
},
"model": {"id": 23423,
"name": "FOCUS - II (DA_, HCP, DP) (2004 - 2013)",
"manufactured_from": "2019-09-08",
"manufactured_to": "2020-09-08",
"vehicle_model_group_id": 0,
"vehicle_model_group_name": "string",
"vehicle_make_id": 0,
"vehicle_make_name": "string",
"requires_doip": true
},
"model_variant": {"id": 34234,
"name": "1.4 59KW ASDA, ASDB (2004 - 2012)",
"manufactured_from": "2019-09-08",
"manufactured_to": "2020-09-08",
"vehicle_model_id": 0,
"vehicle_model_name": "string",
"vehicle_model_group_id": 0,
"vehicle_model_group_name": "string",
"vehicle_make_id": 0,
"vehicle_make_name": "string",
"requires_doip": true
}
}

Options

Enable CORS by returning correct headers

SecurityNone

Responses

200

Enable CORS by returning correct headers

options/v1/vehicles/makes

Get vehicle makes

A vehicle make is the brand of the vehicle

SecurityOAuth2 or JifelineAuthorizer

Request

query Parameters

offset	integer >= 0 The number of items to skip before starting to collect the result set.
limit	integer [ 0 .. 200 ] The maximum number of items to return, the maximum numers of items to return is set to 200. Example: limit=20

Responses

200

Vehicle makes

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

403

Returned when a client requests a resource it's not authorized for.

500

Returned when an error occurs on the server

get/v1/vehicles/makes

Response samples

application/json

{"result": [{"id": 10,
"name": "Ford"
}
],
"total": 234,
"offset": 200,
"limit": 20
}

Options

Enable CORS by returning correct headers

SecurityNone

Request

path Parameters

makeId

required

integer

Vehicle make ID

Responses

200

Enable CORS by returning correct headers

options/v1/vehicles/makes/{makeId}

Get a single vehicle make

A vehicle make is the brand of the vehicle

SecurityOAuth2 or JifelineAuthorizer

Request

path Parameters

makeId

required

integer

Vehicle make ID

Responses

200

Vehicle make

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

403

Returned when a client requests a resource it's not authorized for.

500

Returned when an error occurs on the server

get/v1/vehicles/makes/{makeId}

Response samples

application/json

{"id": 10,
"name": "Ford"
}

Options

Enable CORS by returning correct headers

SecurityNone

Responses

200

Enable CORS by returning correct headers

options/v1/vehicles/model-groups

Get vehicle model groups

Get vehicle model group for a make

SecurityOAuth2 or JifelineAuthorizer

Request

query Parameters

vehicle_make_id required	number <int32> The ID of the vehicle make. Example: vehicle_make_id=2691
offset	integer >= 0 The number of items to skip before starting to collect the result set.
limit	integer [ 0 .. 200 ] The maximum number of items to return, the maximum numers of items to return is set to 200. Example: limit=20

Responses

200

Vehicle Model Groups

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

403

Returned when a client requests a resource it's not authorized for.

500

Returned when an error occurs on the server

get/v1/vehicles/model-groups

Response samples

application/json

{"result": [{"id": 234,
"name": "Focus",
"vehicle_make_id": 0,
"vehicle_make_name": "string"
}
],
"total": 234,
"offset": 200,
"limit": 20
}

Options

Enable CORS by returning correct headers

SecurityNone

Request

path Parameters

modelGroupId

required

integer

Vehicle model-group ID

Responses

200

Enable CORS by returning correct headers

options/v1/vehicles/model-groups/{modelGroupId}

Get a single vehicle model-group

Get a single vehicle model-group (e.g. Laguna)

SecurityOAuth2 or JifelineAuthorizer

Request

path Parameters

modelGroupId

required

integer

Vehicle model-group ID

Responses

200

Vehicle model-group

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

403

Returned when a client requests a resource it's not authorized for.

500

Returned when an error occurs on the server

get/v1/vehicles/model-groups/{modelGroupId}

Response samples

application/json

{"id": 234,
"name": "Focus",
"vehicle_make_id": 0,
"vehicle_make_name": "string"
}

Options

Enable CORS by returning correct headers

SecurityNone

Responses

200

Enable CORS by returning correct headers

options/v1/vehicles/models

Get vehicle models

Get vehicle models for a model group

SecurityOAuth2 or JifelineAuthorizer

Request

query Parameters

vehicle_model_group_id required	number <int32> The ID of the vehicle model group. Example: vehicle_model_group_id=2691
offset	integer >= 0 The number of items to skip before starting to collect the result set.
limit	integer [ 0 .. 200 ] The maximum number of items to return, the maximum numers of items to return is set to 200. Example: limit=20

Responses

200

Vehicle models

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

403

Returned when a client requests a resource it's not authorized for.

500

Returned when an error occurs on the server

get/v1/vehicles/models

Response samples

application/json

{"result": [{"id": 23423,
"name": "FOCUS - II (DA_, HCP, DP) (2004 - 2013)",
"manufactured_from": "2019-09-08",
"manufactured_to": "2020-09-08",
"vehicle_model_group_id": 0,
"vehicle_model_group_name": "string",
"vehicle_make_id": 0,
"vehicle_make_name": "string",
"requires_doip": true
}
],
"total": 234,
"offset": 200,
"limit": 20
}

Options

Enable CORS by returning correct headers

SecurityNone

Request

path Parameters

modelId

required

integer

Vehicle model ID

Responses

200

Enable CORS by returning correct headers

options/v1/vehicles/models/{modelId}

Get a single vehicle model

Get a single vehicle model (e.g. Laguna III Grandtour)

SecurityOAuth2 or JifelineAuthorizer

Request

path Parameters

modelId

required

integer

Vehicle model ID

Responses

200

Vehicle model

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

403

Returned when a client requests a resource it's not authorized for.

500

Returned when an error occurs on the server

get/v1/vehicles/models/{modelId}

Response samples

application/json

{"id": 23423,
"name": "FOCUS - II (DA_, HCP, DP) (2004 - 2013)",
"manufactured_from": "2019-09-08",
"manufactured_to": "2020-09-08",
"vehicle_model_group_id": 0,
"vehicle_model_group_name": "string",
"vehicle_make_id": 0,
"vehicle_make_name": "string",
"requires_doip": true
}

Options

Enable CORS by returning correct headers

SecurityNone

Responses

200

Enable CORS by returning correct headers

options/v1/vehicles/model-variants

Get vehicle model variants

Get vehicle model variants for a model

SecurityOAuth2 or JifelineAuthorizer

Request

query Parameters

vehicle_model_id required	number <int32> The ID of the vehicle model. Example: vehicle_model_id=2691
offset	integer >= 0 The number of items to skip before starting to collect the result set.
limit	integer [ 0 .. 200 ] The maximum number of items to return, the maximum numers of items to return is set to 200. Example: limit=20

Responses

200

Vehicle model variants

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

403

Returned when a client requests a resource it's not authorized for.

500

Returned when an error occurs on the server

get/v1/vehicles/model-variants

Response samples

application/json

{"result": [{"id": 34234,
"name": "1.4 59KW ASDA, ASDB (2004 - 2012)",
"manufactured_from": "2019-09-08",
"manufactured_to": "2020-09-08",
"vehicle_model_id": 0,
"vehicle_model_name": "string",
"vehicle_model_group_id": 0,
"vehicle_model_group_name": "string",
"vehicle_make_id": 0,
"vehicle_make_name": "string",
"requires_doip": true
}
],
"total": 234,
"offset": 200,
"limit": 20
}

Options

Enable CORS by returning correct headers

SecurityNone

Request

path Parameters

modelVariantId

required

integer

Vehicle model-variant ID

Responses

200

Enable CORS by returning correct headers

options/v1/vehicles/model-variants/{modelVariantId}

Get a single vehicle model-variant

Get a single vehicle model-variant (e.g. Laguna III Grandtour 2.0 16V Turbo 125KW F4R 811)

SecurityOAuth2 or JifelineAuthorizer

Request

path Parameters

modelVariantId

required

integer

Vehicle model-variant ID

Responses

200

Vehicle model-variant

400

Returned when a client sends a bad request

401

Returned when a request is performed without or with an incorrect OIDC token

403

Returned when a client requests a resource it's not authorized for.

500

Returned when an error occurs on the server

get/v1/vehicles/model-variants/{modelVariantId}

Response samples

application/json

{"id": 34234,
"name": "1.4 59KW ASDA, ASDB (2004 - 2012)",
"manufactured_from": "2019-09-08",
"manufactured_to": "2020-09-08",
"vehicle_model_id": 0,
"vehicle_model_name": "string",
"vehicle_model_group_id": 0,
"vehicle_model_group_name": "string",
"vehicle_make_id": 0,
"vehicle_make_name": "string",
"requires_doip": true
}

➔ Next to Cart