## Check the Status of an Activation Order POST /devices/requests/status Checks the status of an activation order and lists where the order is in the provisioning process. ### 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](/docs/standard-apis/connectivity-management/api-endpoints/device-management/activation-order-status/deviceuploadstatus) ### 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. | Parameter Name | Data Type | Description | |:-----------------------:|:---------:|:------------------------------------------------------:| | Authorization required | string | HTTP Authorization bearer token. | | VZ-M2M-Token required | string | A valid session token returned by POST /session/login. | | Content-Type required | string | Must be application/json. | ### Request Parameters The request body identifies the device and reporting period that you want included in the report. | Parameter Name | Data Type | Description | |:--------------------------------------------------:|:--------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| | accountName required | string | The name of the account that you want the callback response sent to. An account name is usually numeric, and must include any leading zeros. | | orderRequestId optional if DeviceList is provided | string | The request id from the activation order. | | devices required | array of deviceIds objects | At this time, only one device in the DeviceCollection is allowed per request. NOTE: At this time, we cannot pass multiple device identifiers, even for a single device. | | kind, id required | strings | The type and value of the device identifier. ESN - decimal ICCID - decimal, up to 20 digits MEID - hexadecimal | ### Response Parameters | Parameter Name | Data Type | Description | |:--------------:|:---------:|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| | requestId | string | A unique string that associates the request with the results that are sent via a callback service. The callback message contains the information for all devices in the request. | ### Example Request Body ```json { "accountName": "4Gpublicaccount ", "orderRequestId": " f55fea16-3664-4a32-ae9d-c0cbe3eedf1d ", "devices": [ { "deviceIds": [ { "id": "20112019672551234613", "kind": "iccid" } ] } ] } ``` ### Success Responses Status 200 | Parameter Name | Data Type | Description | |:--------------:|:---------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| | requestId | string | A unique string that associates the request with the results that are sent via a callback message. ThingSpace sends a separate callback message for each device that was in the request indicating whether the operation succeeded for that device. All of the callback messages have the same requestId. | ### Example Success Response ```json { "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: | Parameter Name | Data Type | Description | |:--------------------:|:-------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| | username | string | The username defined when a URL was registered for the callback service, or an empty element if no username was defined. | | password | string | The password defined when a URL was registered for the callback service, or an empty element if no password was defined | | requestId | string | A unique string that matches the RequestId returned in the synchronous response to the original API request. A separate callback message is sent for each device that matched the request criteria, indicating whether the operation succeeded for that device. All of the callback messages have the same RequestId. | | id | string | The value of the device identifier. | | kind | string | The type of the device identifier: ESN, ICCID, or MEID. | | deviceResponse | callback data | Contains data regarding device order status. | | orderStatusResponse | callback data | Contains order status progress information. | | orderRequestId | string | The request ID of the activation order. | | status | string | The status of the provisioning order. | | startDate | dateTime | The date and time the provisioning request was made. | | endDate | dateTime | The date and time the callback was sent. | | provisioningStages | Stage | A list of all pinpoints identifying the stages in the provisioning process | | name | string | The name identifying the provisioning step/stage. | | date | dateTime | The date and time the request entered this step-stage of the provisioning request. | | status | string | The status of the API call on the callback. Status can be Success or Failure. | | callbackCount | integer | The number of times this callback message has been sent. | | maxCallbackThreshold | integer | The maximum number of times this callback message is sent if it is not correctly acknowledged. | ### Example Success Callback Response The check order status callback response includes the device activation status for the device you checked on. ```json { "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 | Error | Error Message | |:--------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:| | | Device status changes from pending to pending statuses are not allowed. | | | 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. | | REQUEST_FAILED | Device is already active. | | REQUEST_FAILED | ICCID is not in DMD. | | REQUEST_FAILED | Activation of this device is no longer supported. | | REQUEST_FAILED | MDN is not available for the provided zip code or NPA/NXX. Please contact Support. | | REQUEST_FAILED | Device (deviceId) or ICCID (iccId) is already active on another MTN. | | | The device was not a part of the account specified. | | | Could not find device IMEI and ICCID. | | REQUEST_FAILED | ICCID (iccId) not provided or is invalid. | | REQUEST_FAILED | Device ID (deviceId) is not in DMD. | | REQUEST_FAILED | Device is not E911 compliant. | | REQUEST_FAILED | Device is not listed with the Verizon Wireless network. Please contact Support. | | REQUEST_FAILED | Device is lost or stolen. | | REQUEST_FAILED | ICCID is paired with another MDN. Please contact support to have it unpaired before retrying. | | REQUEST_FAILED | Request failed due to the duplicate IP assigned to the MTN. | | | Your Add a Line request has timed out. | | | ProductBundleId is required. | | | Pool Name is required. |