POST /devices/requests/status

Checks the status of an activation order and lists where the order is in the provisioning process.

Contents

See also:
Retrieve Device Information
Activate Devices

Uses and Requirements

You can use this request to check the status of real-time orders:

• You can get the orderRequestId from the activation order.
• You can only retrieve activation orders.
• Only one device in the DeviceCollection is allowed per request.
• Only ESN, ICCID, and MEID are allowed as device identifiers.

You must register the DeviceService callback service to receive the callback response.

Request Components

HTTP Request

POST https://thingspace.verizon.com/api/m2m/v1/devices/request/status

Header Parameters

The request header must contain a current ThingSpace authorization bearer token and a valid VZ-M2M session token, and must set the content-type to JSON.

Request Parameters

The request body identifies the device and reporting period that you want included in the report.

Response Parameters

Example Request Body

{
  "accountName": "4Gpublicaccount ",
  "orderRequestId": " f55fea16-3664-4a32-ae9d-c0cbe3eedf1d ",
   "devices": [
    {
      "deviceIds": [
        {
          "id": "20112019672551234613",
          "kind": "iccid"
        }
      ]
    }
  ]
}

Success Responses

Status 200

Example Success Response

{"requestId": "c7b45cf2-cab1-4e42-82f8-20350f4c4ea3"}

Callback Response Parameters

The callback contains an array of deviceInfo objects, one for each device in the request. Each deviceInfo object contains these values:

Example Success Callback Response

The check order status callback response includes the device activation status for the device you checked on.

{
   "username":"hatauatautomation",
   "password":"Verizon*16",
   "requestId":"82b1ef11-b1c5-4c36-bdec-673f0280c046",
   "deviceIds":[
      {
         "id":"89148000003243019556",
         "kind":"ICCID"
      }
   ],
   "deviceResponse":{
      "orderStatusResponse":{
         "orderRequestId":"e5662875-2bb9-45cf-b538-f6340ca24672",
         "status":"IN PROGRESS",
         "startDate":"2019-11-26T19:59:54.547Z",
         "endDate":"2019-11-26T20:26:02.980Z",
         "provisioningStages":[
            {
               "name":"Request Received",
               "date":"2019-11-26T19:59:54.547Z",
               "status":"SUCCESS"
            },
            {
               "name":"Account and credit verification",
               "date":"2019-11-26T19:59:59.808Z",
               "status":"SUCCESS"
            },
            {
               "name":"Device verification",
               "date":"2019-11-26T20:00:05.812Z",
               "status":"SUCCESS"
            },
            {
               "name":"Number and IP allocation",
               "date":"2019-11-26T20:00:09.523Z",
               "status":"SUCCESS"
            },
            {
               "name":"Provisioning configuration",
               "status":"SUCCESS"
            },
            {
               "name":"Network registration"
            },
            {
               "name":"Order completion",
               "status":"SUCCESS"
            },
            {
               "name":"Callback Sent",
               "date":"2019-11-26T20:26:02.980Z",
               "status":"FAILURE",
               "notes":"Your Add a Line request was unsuccessful. Please review your request with your Company Administrator to see whether it can be administered via Verizon Enterprise Center or My Business."
            }
         ]
      }
   },
   "callbackCount":1,
   "maxCallbackThreshold":4
}

Failure Responses