API docs by Redocly

GPS Health Check API (1.0.0)

Download OpenAPI specification:

VEROO API for a GPS Health Check

Request a health check

Request a health check for a device whose signals are expected to be provided by an organization or a partner organizations, given its license plate.

Request Body schema: application/json
required
licensePlate
required
string (license_plate)

License plate of the device.

validUntil
string <date-time>

The result link is valid until this time (in UTC). Maximum can be up to 72 hours in the future. Default is 12 hours.

partnerReference
string (partner_reference)

Partner reference provided to a referred organization (based on the signal source or a signal sharing agreement). Used to generate a health check for a license plate that belongs to the partner organization.

object

Responses

Request samples

Content type
application/json
{
  • "licensePlate": "string",
  • "validUntil": "2019-08-24T14:15:22Z",
  • "partnerReference": "string",
  • "reference": {
    }
}

Response samples

Content type
application/json
{}

Delete a health check list

Delete a health check list by its name.

query Parameters
name
required
string

Name of the list to delete.

Responses

Create or update a health check list

Send a name, a title and a list of license plates to update or create a health check list.

Request Body schema: application/json
required
name
required
string

Name of the list. If a list with this name already exists, it will be overwritten. Name can only contain a-z, 0-9 and -

title
required
string

Title of the list. Used for display purposes.

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "title": "string",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string"
}

Delete a health check list Deprecated

(Renamed, will be removed soon) Delete a health check list by its name.

path Parameters
name
required
string

Name of the list to delete.

Responses

Create or update a health check list Deprecated

(Renamed, will be removed soon) Send a name, a title and a list of license plates to update or create a health check list.

Request Body schema: application/json
required
name
required
string

Name of the list. If a list with this name already exists, it will be overwritten.

title
required
string

Title of the list. Used for display purposes.

required
Array of objects

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "title": "string",
  • "items": [
    ]
}

Response samples

Content type
application/json
{
  • "name": "string"
}

Check latest status about devices ("Quick health check")

For each given license plate in the list check if there are any signals and return latest device status

Request Body schema: application/json
required
licensePlates
required
Array of strings unique

List of license plates to check

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}