Site Proximity
POST /v1/intelligence/site-proximity/action/list
Identify the direction and general distance of nearby cell sites and the technology supported by the equipment.
HTTP Request
POST https://thingspace.verizon.com/api/m2m/v1/intelligence/site-proximity/action/list
Header Parameters
The request header must set the content-type to JSON, contain a current ThingSpace authorization token and a current VZ-M2M session token. For more details on how to get these tokens, visit Getting Started.
| Parameter Name | Data Type | Description |
|---|---|---|
| Authorization (required) | string | HTTP Authorization request header containing a valid Bearer token: Authorization: Bearer {token} |
| VZ-M2M-Token (required) | string | A valid session token returned by a Connectivity Management POST /session/login request. |
| Content-Type (required) | string | Must be application/json. |
Request Body
Example request:
{
"accountName":"0000123456-00001",
"locationType":"LONGLAT",
"technologyType": "C-BAND"
"coordinates":{
"latitude":"decimal degrees",
"longitude":"decimal degrees"
}
}Request Body Parameters
All parameters are required unless marked "optional".
| Parameter | Data Type | Description |
|---|---|---|
| accountName | string | The numeric name of the account, including leading zeros. |
| locationType | string | The location type used for this query is LONGLAT. |
| technologyType Optional | string | The cellular technology searched for. This can be: LTE or C-BAND Note: If this value is left blank or not used, the query will default to LTE. |
| coordinates | object | The coordinates being queried. |
| latitude | string | Latitude in decimal degrees (-90° to 90°). |
| longitude | string | Longitude in decimal degrees (-180° to 180°). |
Success Responses
Status 200 A successful response shows a system generated request ID to track the request.
Example response:
{
"requestId": "d1f08526-eeee-ffff-gggg-4456490ea9f8"
}Callback Response
These endpoints send responses asynchronously. In order to read the results a callback is required. To learn more about callbacks, please visit About Callback Services. The callback service to subscribe to is IntelligenceService.
Example callback response:
{
"username" : "the user's login information",
"password" : "the user's password",
"requestId": "d1f08526-eeee-ffff-gggg-4456490ea9f8",
"intelligenceResponse": {
"siteProximity": {
"cellSites": [
{
"technology": "LTE",
"heightInFeet": "97.5",
"azimuth": "decimal degrees",
"azimuth2": "decimal degrees",
"los": "Y",
"distanceApprox": "< 2 miles"
},
{
"technology": "C-BAND",
"heightInFeet": "97.5",
"azimuth": "decimal degrees",
"azimuth2": "decimal degrees",
"los": "Y",
"distanceApprox": "< 2 miles"
}
]
}
},
"status": "SUCCESS",
"callbackCount": 1,
"maxCallbackThreshold": 4
}Callback Parameters
| Parameter | Data Type | Description |
|---|---|---|
| username | string | The user's login information. |
| password | object | The user's password. |
| requestId | string | The requestId being viewed. This is a system generated value from the request above. |
| intelligenceResponse | object | Contains the response details of the request. |
| siteProximity | object | Contains the details of how close cell sites are to the location queried. |
| cellSites | array | An array of cell sites found based on the location information queried. |
| technology | string | The network technology found. Valid values are: LTE or C-BAND . |
| heightInFeet | string | How high off the ground the receiver is, measured in Feet. |
| azimuth | string | How far the receiver is from North in decimal degrees. (horizontally, 0° to 360°). |
| azimuth2 | string | The direction, from North in decimal degrees, from the Verizon tower to the lat/long given (horizontally, 0° to 360°). |
| los | string | If the location queried has Line Of Sight to the receiver. This will be: Y - yes or N - no. |
| distanceApprox | string | An estimate of how far the receiver is from the location queried. |
| status | string | The status of the intelligenceResponse. |
| callbackCount | string | The number of responses for intelligenceResponse found. |
| maxCallbackThreshold | string | The maximum number of responses for intelligenceResponse allowed. |
Failure Responses
All error responses will be in the following format:
{
"errorCode": "The 3-digit HTML error code",
"errorMessage": "string"
}