Standard APIsGlobal IoT OrchestrationAPI EndpointsGet the Status of an Asynchronous Request
API Reference
Get the Status of an Asynchronous Request
GET /v2/accounts/{accountName}/requests/{requestID}/status
Shows the current status of a specific request. Since requests are Asynchronous and require a callback to review results, this request will show if a request has failed, processed or is queued to run.
Bulk operation: Not Supported. eSIM profiles: Both Verizon US and Global.
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/m2m/v2/accounts/{accountName}/requests/{requestID}/status
Request Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| accountName (required) | string | The numeric name of the account. Leading zeros must be included. |
| requestId (required) | string | The system generated request ID from the request made. |
Request Body
None.
Success Response
Status 200
Example Response:
{
"requestId":"d1f08526-5443-4054-9a29-4456490ea9f8",
"status":"Success",
"subRequests":[
{
"ids":[
{
"id":"20-digit ICCID",
"kind":"iccid"
}
],
"status":"Success"
},
{
"ids":[
{
"id":"20-digit ICCID",
"kind":"iccid"
}
],
"status":"Pending"
}
]
}Success Parameters
| Parameter | Data Type | Description |
|---|---|---|
| requestId | string | The system generated request ID from the request made. |
| status | string | The overall status of the request and will be one of the following: Success, Failed, Pending |
| subRequests | array | The devices included in the request. |
| ids | array | An array of devices, by id, that are included in the request. Each ids will contain: id, kind, status. |
| id | string | The numeric ID of the device. |
| kind | string | The the type of device ID represented by the ID value. This could be: imei, iccid, mdn, eid. |
| status | string | The status of the request on a specific device and will be one of the following: Success, Failed, Pending. |
Failure Responses
All error responses will be in the following format
{
"errorCode": "The 3-digit HTML error code",
"errorMessage": "string"
}