Overview

GPS Health Check (GHC) is intended to be used in case of problems or unexpected behaviour of devices and to check the service level of a device.

We distinguish between the following states a device can have in GPSA:

  • "Operational": GPSA received a signal within the last 12 hours for the license plate.
  • "Idle": GPSA received a signal within more than 12 hours ago for the license plate and does not detect any technical issue.
  • "InvalidCredentials": GPSA received a signal for the license plate in the past but cannot get new signals because of invalid credentials.
  • "InsufficientCredentials": GPSA received a signal for the license plate in the past but cannot get new signals because of insufficient credentials.
  • "ProviderError": GPSA received a signal for the license plate in the past but cannot get new signals because of technical issues (i.e. the API of the provider causes issues).
  • "TimezoneAhead": GPSA received a signal for the license plate but the time is in the future.
  • "InvalidSignal": GPSA received a signal for the license plate but it's not valid.
  • "SimilarMatch": GPSA received a signal for a similar license plate.
  • "MappingRequired": GPSA received a signal for a similar license plate and has mapping suggestions.
  • "DeviceNotActivated": GPSA did not receive a signal for the license plate but for other license plates of the same organisation or partner organisation.
  • "NoDevices": GPSA never received a signal for the organisation or partner organisation.

Result links

Result links can be generated to display relevant information about a device based on its license plate. These links analyze the problem and provide recommendations and instructions for troubleshooting. The GHC result link endpoint provides a way to expose this functionality to your users: you can use the API to generate a link to the results of a health check with the following properties:

  • The link is a magic link, i.e. it can be accessed without a VEROO account. The user can therefore share the health check result with persons without a VEROO account.
  • The link has a limited validity (which can be specified up to 72 hours when requesting a health check and defaults to 12 hours). An invalid link cannot be accessed anymore.
To make sure that, given the license plate, GHC only searches through and displays information for devices your organisation has a signal sharing agreement with, in addition to the license plate you need to pass the partnerReference of the organisation that should have access to the device to the API.

Lists

The GHC list endpoints provide a way to expose the health check of multiple devices to your users at a glance by creating list of license plates. The health check results on lists are cached and updated regularly (on average every 5 minutes).

Quick health check

The GHC quick health check endpoint provides a way to get information about the health check for a list of devices based on its license plates. It is intended for machine-2-machine communication. The GHC quick health check endpoint does not contain the cases "SimilarMatch", "MappingRequired", "DeviceNotActivated" or "NoDevices", but can contain the additional case "UnknownLicensePlate".

API docs

You can find the OpenAPI docs here.

Authentication

API access is protected; please see the authentication documentation on how to authenticate to the API.

Copyright © . All rights reserved for VEROO GmbH