API docs by Redocly

Location Services API (1.3.2)

Download OpenAPI specification:Download

Location Services API

CloudLocate API's

CloudLocate Position API

Calculates a position for the given measurement from cellular, Wi-Fi or GNSS module.
For further details you can refer to developer guide

Authorizations:
basicAuthoauth2
header Parameters
DateTime
string <DateTime>
Examples:
  • 2021-05-29T12:36:56 - MEAS20 DateTime header value
  • 2021-05-29T12:37:07 - MEAS50 DateTime header value
  • 2021-05-28T17:19:37 - MEASX DateTime header value

This is only supported when using text/plain format. ISO 8601 DateTime format "yyyy-mm-ddThh:mm:ss" in UTC. This is the optional timestamp of the measurement. If this parameter is omitted, the time of the request is used as the timestamp of the measurement.

Request Body schema:
RequestId
string <= 60 characters

An optional RequestId parameter that will be returned in response as is to trace the request.

DeviceId
string <= 32 characters ^[a-zA-Z0-9:_-]+$

An optional unique DeviceId parameter will be returned in response to trace the device. We highly recommend using this parameter for better traceability, especially if a fleet of devices uses the same credentials.

object

Input measurements from Cellular Modem.

Array of objects

List of WiFi access points. At least two WiFi Access points are required. Only the first 25 Access points are considered; the rest will be ignored.

object

Input measurements from GNSS. Supported types include UBX-RXM-MEASX/MEAS50/MEAS20/MEASC12.

Responses

Request samples

Content type
Example
{
  • "RequestId": "82cb34c9-88c1",
  • "DeviceId": "device:A12345",
  • "GNSSMeasurements": {
    },
  • "WiFiMeasurements": [
    ],
  • "CellMeasurements": {
    }
}

Response samples

Content type
application/json
{
  • "Location": {
    },
  • "DeviceId": "device:G12345",
  • "DateTime": "2023-04-05T12:50:16",
  • "RequestId": "82cb34c9-88c4",
  • "LocationSource": "GNSS"
}

Obtain Token and RefreshToken.

Token has a validity of one hour for accessing the CloudLocate API, while RefreshToken is valid for one day for generating new tokens.

Request Body schema: application/json
required
Username
required
string
Password
required
string

Responses

Request samples

Content type
application/json
{
  • "Username": "string",
  • "Password": "string"
}

Response samples

Content type
application/json
{
  • "Token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6IkZHTVlMWVhLRzFaR1ZPVVRDTlBIIiwidG9rZW5fdHlwZSI6ImFjY2Vzc190b2tlbiIsIm5iZiI6MTcwODMyNDMwMSwiZXhwIjoxNzA4MzI3OTAxLCJpYXQiOjE3MDgzMjQzMDEsImlzcyI6InUtYmxveC1kZXYifQ.pgUSFUMyBlO4Ax8dY6PZFk2z3c1puKi0HTKaoxAoqjc",
  • "RefreshToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6IkZHTVlMWVhLRzFaR1ZPVVRDTlBIIiwidG9rZW5fdHlwZSI6InJlZnJlc2hfdG9rZW4iLCJuYmYiOjE3MDgzMjQzMDEsImV4cCI6MTcwODQxMDcwMSwiaWF0IjoxNzA4MzI0MzAxLCJpc3MiOiJ1LWJsb3gtZGV2In0.dEjsvlK5WMl8Oy9SLFqtqXKLvK231tWTPGxU8ynyrwU"
}

Refresh Token

Using a valid RefreshToken generate a new token which has a validity of one hour.

Request Body schema: application/json
required
RefreshToken
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "Token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1bmlxdWVfbmFtZSI6IkZHTVlMWVhLRzFaR1ZPVVRDTlBIIiwidG9rZW5fdHlwZSI6ImFjY2Vzc190b2tlbiIsIm5iZiI6MTcwODMyNDMwMSwiZXhwIjoxNzA4MzI3OTAxLCJpYXQiOjE3MDgzMjQzMDEsImlzcyI6InUtYmxveC1kZXYifQ.pgUSFUMyBlO4Ax8dY6PZFk2z3c1puKi0HTKaoxAoqjc"
}

Revoke all tokens

Invalidate all tokens generated previously. To access the CloudLocate API, new tokens must be requested.

Request Body schema: application/json
required
Token
required
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "Message": "Tokens are revoked."
}

CellLocate API's

CellLocate Position API

Calculates a position for the given measurement. Input payload (base64 encoded) received from the cellular module.

Authorizations:
basicAuth
Request Body schema: application/json
Payload
string

Input base64 encoded binary payload.

Responses

Request samples

Content type
application/json
{
  • "Payload": "R1NNQ0VMczKzT3YjSzADcAQAAAMDcAQB1gCvsiA7HgADAALJAJKwGzwoAALWAG2xGjMsAALJAGOxGCsrAALWAIq9FiEyAIEaU0FSQS1HMzQwL1NhcmEzNDBfMDguOTAuMDMA"
}

Response samples

Content type
application/json
{
  • "Location": {
    },
  • "DateTime": "2020-08-17T20:18:12",
  • "DeviceID": "357861090015763",
  • "DeviceType": "SARA-R510S-00B-00/01.02,A00.01",
  • "UBXResponse": "tWITQBgAEAAAEuYHCBAHHREAQBO5IAAAAACAGgYAk/G1YhNAFAABAAAA7IcgH66h9P8AAAAAxQwAAC0atWIIBhwAiuyHIB+uofT/FIsAAAAAEREAMosAAAAAEREAX6e8",
  • "LocationSource": "Cell"
}