Data Api
API Reference

Validation Requests

Request New Model Validation

POST v1/validation-requests HTTP/2
Submits a new validation request.

Parameters

Name Type Required Default Description
manufacturer body Manuacturer of the model
model body Model to be validated
range body Expected range of the model
url body Reference url to assist the team to validate the model
notes body Extra notes to the Spec Check data team
reference body Your unique reference for the request

Reponse

Validation Request Collection Model

Possible Http Responses
  • 200 - Request has been processed, status in the respose model may indicate additional detail
  • 400 - Bad request, submitted values is missing a piece of required data, see response data for details and refer to the model page for complete list.
  • 409 - Duplicate request, reference should be unique and requests cannot be created with duplicate values.

GET v1/validation-requests HTTP/2
This endpoint can be used to search for multiple validation requests. Providing no search criteria will result in all possible entries returned.

Parameters

Name Type Data Type Required Default Description
locale query string en-gb Locale for string translation.
manufacturers query (multiple) string Filter requests to the requested manuacturers
models query (multiple) string Filter requests to the requested models
ranges query (multiple) string Filter requests to the requested ranges
references query (multiple) string Filter requests to the requested references
statuses query (multiple) number Filter requests to the requested Statuses
statusesLike query (multiple) string Filter requests to the requested Statuses which can include wildcard characters See below
page query number 1 Page number of the results.
pageSize query number 10 Number of results to return per page.

Status Wildcard

The StatusesLike Parameter can include a wildcard character so the query can filter to multiple statuses without having to include every available status. This allows querys to be unaffected if additional statuses are added at a later date.

So if you wish to return all successful statuses: 

v1/validation-requests?statusesLike=2**
OR
v1/validation-requests?statusesLike=2*
OR
v1/validation-requests?statusesLike=20*

Wildcard in the middle is also supported: 

v1/validation-requests?statusesLike=2*1

Reponse

Validation Request Collection Model

Get Validation Request By Id

GET v1/validation-requests/{id} HTTP/2

Parameters

Name Type Required Default Description
locale query en-gb Locale for string translation.
id route Our id of your validation request.

Reponse

Validation Requests Model

Get Validation Request By Reference

GET v1/validation-requests/ref/{reference} HTTP/2

Parameters

Name Type Required Default Description
locale query en-gb Locale for string translation.
reference route Your refernce of the validation request.

Reponse

Validation Requests Model