Retrieve Device Provisioning History (Consumer eSIM for IoT Solutions)

`POST /v2/devices/history/actions/list`

Retreives the provisioning history of an individual device.

Request Components
Success Response
Callback Response
- Callback Parameters
Failure Responses

Request Components

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

`POST https://thingspace.verizon.com/api/m2m/v2/devices/history/actions/list`

Request Parameters

Parameter	Data Type	Description
accountName required	string	The name of the account. This is numeric and is in the format "0000123456-00001". Leading zeros must be included.
deviceFilter	array	The ID of the device being queried.
id	string	The numeric ID of the device.
kind	string	The type of device ID represented by the ID value. This could be: imei - International Mobile Equipmet Identifier iccid - Integrated Circuit Card Identifier (This is system generated for eSIM) mdn - Mobile Device Number (10-digit phone number) eid - Electronic ID
earliest	string ($date-time)	The start of the time period to query.
latest	string ($date-time)	The end of the time period to query.

Request Body

Example request:

{
   "accountName":"0000123456-00001",
   "deviceFilter":{
      "kind":"iccid",
      "id":"20-digit ICCID"
   },
   "earliest":"2021-10-15T04:49:35-00:00",
   "latest":"2021-10-15T04:49:49-00:00"
}

Success Response

Status 200

A successful response shows a system generated request ID to track the request.

Example Response:

{
  "requestId": "d1f08526-5443-4054-9a29-4456490ea9f8"
}

Callback Response

These endpoints send responses asynchronously. In order to read the results a callback is required. To learn more about callbacks, please visit About Callback Services.

Example callback response:

{
   "username":"username",
   "password":"password",
   "requestId":"13ce9d0e-7e84-470d-a621-4a52e31449b6",
   "deviceResponse":{
      "getProvisioningHistoryResponse":{
         "pageNumber":1,
         "totalPages":1,
         "complete":true,
         "provisioningHistory":[
            {
               "carrierName":"Name of the mobile service provider",
               "iccid":"20-digit ICCID",
               "profileStatus":"DISABLE",
               "provisioningStatus":"UNKNOWN",
               "occurredAt":"2021-10-13T23:07:35Z",
               "imei":"15-digit IMEI",
               "eid":"32-digit EID",
               "fallbackAttribute":false
            }
         ]
      }
   },
   "callbackCount":1,
   "maxCallbackThreshold":4
}

Callback Parameters

Parameter	Data Type	Description
username	string	The username making the request.
password	string	The password associated with the username.
requestId	string	The requestId being viewed. This is a system generated value from the request above.
deviceResponse	array	Contains the getProvisioningHistoryResponse.
getProvisioningHistoryResponse	array	Contains the page the response is starting at, how many pages are in the response, if the response is complete and the provisioningHistory showing the record data added or changed in the time period of the query.
provisioningHistory	array	Details of the device's provisioning history.
carrierName	array	The name of the carrier providing cellular network access.
iccid	string	The Integrated Circuit Card Identifier or the serial number of the SIM card. For eSIM, this is system generated.
profileStatus	string	Indicates the profile state and will be one of the following: Enable Disable
provisioningStatus	string	The provisioning state of the device and will be: Pending Complete Unknown
occurredAt	string($date-time)	The time stamp of when the record changed.
imei	string	The International Mobile Equipment Identifier of the device.
eid	string	The Electronic Identifier of the device.
fallbackAttribute	boolean	If the fallback attribute has been set (true) or not (false).
callbackCount	string	The number of responses for deviceResponse found.
maxCallbackThreshold	string	The maximum number of responses for deviceResponse allowed.

Failure Responses

All error responses will be in the following format

{
  "errorCode": "The 3-digit HTML error code",
  "errorMessage": "string"
}

Try It Out!