Get Device Location Report Status
Get the Status of a Location Report
GET /locationreports/{accountName}/report/{txid}/status
Returns the current status of a location report that was requested with a POST /locationreports request.
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 bearer token: Authorization: Bearer {token} |
| VZ-M2M-Token (required) | string | A valid session token: VZ-M2M-Token: {M2Mtoken} |
| Content-Type (required) | string | Must be application/json Content-Type: application/json |
HTTP Request
GET https://thingspace.verizon.com/api/loc/v1/locationreports/{accountName}/report/{txid}/status
Request Parameters
The accountName and transaction ID (txid) must be included in the path.
| Parameter Name | Data Type | Description |
|---|---|---|
| accountName (required) | string | The numeric name of the account that the report was requested for. Must include leading zeros. |
| txid (required) | string | The transaction ID from the POST /locationreports response. Thisis a 32 or 36-bit UUID. |
Request Body
None.
Success Response
Status 200 A success response contains the current status of the report: Example Success Response:
{
"txid": "2c90bd28-eeee-ffff-gggg-7e3bd4fbff33",
"status": "INPROGRESS"
}Success Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| txid | string | The transaction ID of the report. This is a 32 or 36-bit UUID. |
| status | string | Status of the report request. This can be: QUEUED - Report is waiting to start, INPROGRESS - report is gathering data or COMPLETED - The report is ready to review. Once a report is completed, it can be retrieved with a GET /locationreports request. |
Failure Responses
All error messages are returned in this format:
{
"errorCode": "The 3-digit HTML error code",
"errorMessage": "string"
}Error codes and messages are listed on the Error Codes page, along with explanations and suggestions for corrective actions.