Skip to main content
API docs by Redocly

Mastercheck API - Apigee (1.2.2)

Download OpenAPI specification:Download

License: Internal

Mastercheck API documentation

Authentication & Authorization

You will need to be identified before calling any Mastercheck API endpoints.

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

  • Authentication mechanism is done with an API key dedicated to you.
    Remember that the API key provided should be shared with care.
    The API key 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: “Client credentials” OAuth2.0 flow.

Masterchecks

Masterchecks inspections with all measurements

Get masterchecks

This endpoint allows to get masterchecks data filtered by parameters

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

The page number

pageSize
required
integer <int32> (PageSizeQueryParam) [ 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

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

Identifier of the external reference

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

Source of the external reference

Responses

Response samples

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

Create mastercheck

This endpoint allows to create a mastercheck

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

The external reference of the mastercheck

vehicleExternalRef
string <= 255 characters

The external reference of the vehicle

saleExternalRef
string <= 255 characters

The external reference of the sale

date
required
string <date>

The visit date

object (NextServiceDTO)
object (ConditionStatus)

The rims status of the vehicle

object
object (ConditionStatus)

The alignment status of the vehicle

object (ConditionStatus)

The bodywork status of the vehicle

object (ConditionStatus)

The brake fluid status of the vehicle

object (ConditionStatus)

The coolant status of the vehicle

object (ConditionStatus)

The washer fluid status of the vehicle

object (ConditionStatus)

The air conditioning status of the vehicle

object (ConditionStatus)

The dashboard caution light status of the vehicle

object (ConditionStatus)

The oil level status of the vehicle

object (ConditionStatus)

The auxiliary battery status of the vehicle

object
object
object
object (ConditionStatus)

The optical glass status of the vehicle

object
object
object
object
object
object
object
object
object
object
object
object (ConditionStatus)

The charging socket HV status of the vehicle

object (ConditionStatus)

The charging cable HV status of the vehicle

object (ConditionStatus)

The orange cable HV status of the vehicle

object (ConditionStatus)

The battery trunk HV status of the vehicle

object (ConditionStatus)

The fluid leak HV status of the vehicle

Responses

Request samples

Content type
application/json
{
  • "date": "2024-12-31",
  • "externalRef": "1000001",
  • "vehicleExternalRef": "1000011",
  • "saleExternalRef": "1000111",
  • "nextService": {
    },
  • "rims": {
    },
  • "tyres": {
    },
  • "alignment": {
    },
  • "bodywork": {
    },
  • "brakeFluid": {
    },
  • "coolant": {
    },
  • "washerFluid": {
    },
  • "airConditioning": {
    },
  • "dashboardCAUTIONLight": {
    },
  • "oilLevel": {
    },
  • "batteryAux": {
    },
  • "indicators": {
    },
  • "windshield": {
    },
  • "wipers": {
    },
  • "opticalGlass": {
    },
  • "positionLights": {
    },
  • "dippedBeam": {
    },
  • "highBeam": {
    },
  • "fogLights": {
    },
  • "brakeLights": {
    },
  • "brakePads": {
    },
  • "brakeDiscs": {
    },
  • "transmission": {
    },
  • "suspension": {
    },
  • "steering": {
    },
  • "bearings": {
    },
  • "chargingSocketHV": {
    },
  • "chargingCableHV": {
    },
  • "orangeCableHV": {
    },
  • "batteryTrunkHV": {
    },
  • "fluidLeakHV": {
    }
}

Response samples

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