Skip to content

Get vehicle maintenance

OpenAPI specifications

get https://api.autopass.pro/vehiculeMaintenance

Get vehicle maintenance from given context.

Query parameters

reg_or_vin
  • Type: string

This parameter provides the identity of the vehicle. This should be either a VIN, a registration plate or both. reg_or_vin takes priority.

vin
  • Type: string

This parameter provides the identity of the vehicle. This should be either a VIN, a registration plate or both. reg_or_vin takes priority.

reg_plate
  • Type: string

This parameter provides the identity of the vehicle. This should be either a VIN, a registration plate or both. reg_or_vin takes priority.

reg_country
  • Type: string

This parameter specifies the country where the car has been registered. This could be different from the country from which the request is made. For instance when repairing a car registered in Italy in a workshop in France. This is an ISO 3166-1 alpha-2 code. If not specified, the value used is the same as the parameter country.

country
  • Type: string
  • Default: FR

This parameter specifies the country in which the response is calculated. This influence some AM references selection and more generally triggers country specific offers in terms of brands. country must be ISO 3166-1 alpha-2. Note that this is not the language but the country.

company
  • Type: string

User company. Could be used to specify the company or one of its department calling the API. This is typically the highest level of the hierarchy. This parameter is returned but has no influence on the result.

entity
  • Type: string

User entity. Could be used to identify a specific workshop or an agent calling the API. This is usually the lowest level in the hierarchy. Using it is recommended to identify uniquely the caller. This parameter is returned but has no influence on the result.

activities
  • Type: string

User activities. Could be used in a transversal way to identify qualities / specific characteristics of the caller. For instance the type of activities covered by the workshop. This parameter is returned but has no influence on the result.

  • Type: string
  • Type: integer
  • Default: 90000

Vehicle mileage (in kms). If not set, this parameter could be guessed depending on our knowledge of the vehicle. Otherwise a default value is used.

age
  • Type: integer
  • Default: 72

Vehicle age (in months). If not set, this parameter could be guessed depending on our knowledge of the vehicle. Otherwise a default value is used.

mode
  • Type: string
  • Default: top

Maintenance selection mode: * "prev/previous" selects the previous expected maintenance interval * "best/current" selects the current expected maintenance interval * "next" selects the next expected maintenance interval * "top/top3" selects the top3 expected maintenance intervals * "left" selects the top3 and left expected maintenance intervals * "all" selects all expected maintenance intervals

plan
  • Type: string
  • Default: none

Maintenance plan: * "all" lists expected maintenance plans * PLAN_ID selects a plan

Responses

200 - OK.

401 - Unauthorized.

403 - Forbidden.

422 - Unprocessable content.