API docs by Redocly

Send My Signals (1.0)

Download OpenAPI specification:

Send My Signals

Send your GPS signals to VEROO.

Authorizations:
OAuth2
Request Body schema: application/json
required

The signals you want to send to VEROO. The total size must be ≤1MB; this corresponds to roughly 4000 signals.

Array
latitude
required
number <double> [ -90 .. 90 ]
longitude
required
number <double> [ -180 .. 180 ]
licensePlate
required
string^[^ -]+$

The license plate of the truck which sent the signal.

positionTimestamp
required
string <date-time>

The time at which the signal was recorded by the telematics device. Note that the format of the timestamp is according to RFC 3339, section 5.6. This means that the timezone of the timestamp is included in the string. For example, the string "2017-07-21T17:32:28Z" encodes the time July 21, 2017, 17:32:28 in the UTC timezone (indicated by the "Z").

deviceId
string

Your identifier for the device that produced this signal. This value is used by VEROO to identify signals originating from the same device. If absent, VEROO will use licensePlate to identify the device producing the signal.

userMetadata
object

An arbitrary object containing metadata that you would like to provide to applications receiving this signal via the Receive My Signals service. The UTF-8 representation of the object must have size at most 10KB.

references
Array of strings

An optional list of reference-strings that are intended to help receivers of this signal associate it with other objects. For example, a reference could be the identifier of the transport order that the truck to which this signal belongs is currently executing.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]