GET /locationreports/{account}/report/{txid}/statusReturns the current status of a location report that was requested with a POST /locationreports request.
See also:
Create a Device Location Report
Retrieve a Device Location Report
Cancel a Device Location Report
GET https://thingspace.verizon.com/api/loc/v1/locationreports/{account}/report/{txid}/status
You must include the account name and transaction ID in the path.
| Parameter Name | Data Type | Description |
|---|---|---|
| account required |
string | The name of the account that the report was requested for. |
| txid required |
string | The transaction ID from the POST /locationreports response. |
The request header must contain a current ThingSpace authorization bearer token and a valid VZ-M2M session token.
| Parameter Name | Data Type | Description |
|---|---|---|
| Authorization required |
string | HTTP Authorization bearer token. |
| VZ-M2M-Token required |
string | A valid session token returned by POST /api/m2m/v1/session/login. |
None.
Status 200
A success response contains the current status of the report.
| Parameter Name | Data Type | Description |
|---|---|---|
| txid | string | The transaction ID of the report. |
| status | enum | QUEUED, INPROGRESS, or COMPLETED. Once a report is completed, you can retrieve it with a GET /locationreports request. |
{
"txid": "2c90bd28-ece4-42ef-9f02-7e3bd4fbff33",
"status": "INPROGRESS"
}
Status 400
All error messages are returned in this format:
{
"errorCode": "The type of error, such as INVALID_REQUEST.",
"errorMessage": "Additional error information."
}
Error codes and messages are listed on the Error Codes page, along with explanations and suggestions for corrective actions.