{ "openapi": "3.0.1", "info": { "title": "Location Service API", "description": "The Location Service API allows you to access the coarse location of a device that is active on your network.\n\n**Note:** You must have an active subscription in order to view the base URL.", "version": "1.0.0", "contact": {} }, "tags": [ { "name": "Location" } ], "paths": { "/locationCheck": { "post": { "summary": "Get Location", "tags": [ "Location" ], "description": "Returns location details about a specified SIM.", "operationId": "getLocation", "parameters": [ { "name": "Authorization", "in": "header", "description": "Your client access token.", "required": true, "schema": { "type": "string" } }, { "name": "X-Authorization", "in": "header", "description": "Your [API Resource PoP Token](/documentation-hub/api-security/authentication-coding-apis#header-2)", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "iccid": { "$ref": "#/components/schemas/Iccid" }, "horizontalPrecision": { "type": "string", "description": "The location's level of precision.

`AREA`: Accurate within 14001 meters
`PRECISE`: Accurate within 150 meters

", "enum": [ "AREA", "PRECISE" ], "example": "AREA" }, "respTimeOut": { "type": "string", "description": "The response time out, in seconds. \n\n**Maximum:** 50", "example": "30", "maximum": 50 }, "maxCacheAge": { "type": "string", "description": "The maximum cache age, in seconds. \n\nBy comparing the cache with `maxCacheAge` you can tell whether the information was retrieved from the server or from the cache:

cache > `maxCacheAge`: Information is sent from the server
cache < `maxCacheAge`: Information is sent from the cache

\n\n**Maximum:** 900", "example": "300", "maximum": 900 } }, "required": [ "iccid", "horizontalPrecision", "respTimeOut", "maxCacheAge" ] } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "iccid": { "$ref": "#/components/schemas/Iccid" }, "msisdn": { "type": "string", "description": "The device's [MSSIDN](https://en.wikipedia.org/wiki/MSISDN).", "example": "17197158760" }, "distanceUnit": { "type": "string", "description": "The distance's unit of measurement.", "example": "meter" }, "longitude": { "type": "string", "description": "The longitude of the cell tower's location.", "example": "39.122819" }, "latitude": { "type": "string", "description": "The latitude of the cell tower's location.", "example": "-104.866133" }, "shape": { "type": "string", "description": "The shape of the estimated area in which the SIM is located.", "example": "CircularArea" }, "radius": { "type": "string", "description": "The area's radius.", "example": "468" }, "cellid": { "type": "string", "description": "The location's cell tower ID.", "example": "6490371" }, "timestamp": { "type": "string", "description": "The date and time the location was received from the application.\n\n**Timezone:** GMT", "format": "YYYYMMDDHHMMSS", "example": "20220324202805" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "System Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } } }, "components": { "schemas": { "ErrorResponse": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ErrorResponseBody" } } } }, "ErrorResponseBody": { "type": "object", "properties": { "reasonCode": { "type": "string" }, "systemMessage": { "type": "string" }, "userMessage": { "type": "string" }, "subReason": { "type": "object" } } }, "Iccid": { "type": "string", "description": "The SIM card's ICCID. The ICCID is 19-20 characters long and is both stored digitally and engraved in the SIM card's body.", "example": "891004234814455936" } } } }

Location

Was this article helpful?