Skip to main content
API docs by Redocly

Vehicle API - Apigee (1.0.3)

Download OpenAPI specification:Download

License: Internal usage only

Vehicle API documentation

Authentication & Authorization

You will need to be identified before calling any endpoints.

In order to be recognized and authorized to access our Vehicle API, we put in place 2 mechanisms:

  • Authentication mechanism is done with a client id dedicated to you.
    Remember that the client id provided should be shared with care.
    The client id must be inserted in the header of the request in the appropriate field
  • Authorization mechanism is done by a well-known authorization flow for REST Web API: Basic auth flow.

Vehicles

Vehicles operation with all operation types

Get vehicles data

Get vehicles data filtered by parameters

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
pageNumber
required
integer <int32> (PageNumberParam) [ 1 .. 1000 ]
Example: pageNumber=2

The page number

pageSize
required
integer <int32> (PageSizeParam) [ 1 .. 1000 ]
Example: pageSize=2

The page size

lastModifiedDateFrom
string <date-time> (lastModifiedDateFromParam)
Example: lastModifiedDateFrom=2024-05-02T10:00:00

Date from for last update date of data

lastModifiedDateTo
string <date-time> (lastModifiedDateToParam)
Example: lastModifiedDateTo=2024-05-02T10:00:00

Date to for last update date of data

registrationNumber
string (RegistrationNumberParam) <= 255 characters
Example: registrationNumber=AA-123-AA

Registration number, if filled then dates filters will not be taken into account

registrationCountryCode
string (RegistrationCountryCodeParam) <= 255 characters
Example: registrationCountryCode=FR

Country code of registration, only used to trigger autoidat calls

externalRef
string (ExternalRefQueryParam) <= 255 characters
Example: externalRef=1000045

Identifier of the external reference

source
string (SourceQueryParam) <= 255 characters
Example: source=GENES

Source of the external reference

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "vehicles": [
    ]
}

Create vehicles data

Create vehicles

Authorizations:
(OAuth2ApiKeyAuth)
Request Body schema: application/json
externalRef
required
string (ExternalRef) <= 255 characters

Vehicle reference code of the source

ownerExternalRef
string <= 255 characters

Owner external Reference

registrationNumber
string (RegistrationNumber) <= 255 characters

Vehicle registration number

registrationDate
string <date> (RegistrationDate)

Vehicle registration date

vin
string (VIN) <= 255 characters

Vehicle Identification Number

make
string (Make) <= 255 characters

Vehicle make

model
string (Model) <= 255 characters

Vehicle model

energy
string (Energy) <= 255 characters

Vehicle energy

mileage
integer (Mileage)

Vehicle mileage

mileageUOM
string (MileageUOM) <= 255 characters

Vehicle mileage unit of measure

annualMileage
integer (AnnualMileage)

Vehicle annual mileage

annualMileageUOM
string (AnnualMileageUOM) <= 255 characters

Vehicle annual mileage unit of measure

nextInspectionDate
string <date> (NextInspectionDate)

Vehicle next inspection date

active
boolean (Active)

true if vehicle is active

Responses

Request samples

Content type
application/json

Create a vehicle with the given informations

{
  • "externalRef": "AAA123",
  • "ownerExternalRef": "20831238",
  • "registrationNumber": "AA-123-AA",
  • "registrationDate": "2024-01-01",
  • "vin": "",
  • "make": "Peugeot",
  • "model": "208",
  • "energy": "PETROL",
  • "mileage": 120000,
  • "mileageUOM": "km",
  • "annualMileage": 20000,
  • "annualMileageUOM": "km",
  • "nextInspectionDate": "2025-09-10"
}

Response samples

Content type
application/json
{
  • "code": "1000293"
}

Get tyre options for a vehicle

Get tyre options for a vehicle

Authorizations:
(OAuth2ApiKeyAuth)
path Parameters
vehicleCode
required
integer <int32> (VehicleCodeParam)
Example: 2

The vehicle code

Responses

Response samples

Content type
application/json
{
  • "tyreOptions": [
    ]
}

Get vehicles states

Get vehicles state data filtered by parameters

Authorizations:
(OAuth2ApiKeyAuth)
query Parameters
pageNumber
required
integer <int32> (PageNumberParam) [ 1 .. 1000 ]
Example: pageNumber=2

The page number

pageSize
required
integer <int32> (PageSizeParam) [ 1 .. 1000 ]
Example: pageSize=2

The page size

lastModifiedDateFrom
string <date-time> (lastModifiedDateFromParam)
Example: lastModifiedDateFrom=2024-05-02T10:00:00

Date from for last update date of data

lastModifiedDateTo
string <date-time> (lastModifiedDateToParam)
Example: lastModifiedDateTo=2024-05-02T10:00:00

Date to for last update date of data

Responses

Response samples

Content type
application/json
{
  • "pagination": {
    },
  • "vehicles": [
    ]
}