Retrieve Device Provisioning History:

`POST /devices/history/actions/list`

Returns the provisioning history of a specified device during a specified time period.

Retrieve Device Provisioning History:
POST /devices/history/actions/list

Uses and Requirements

Each response includes a maximum of 500 records. To obtain more records (for response code 202), you can call the API multiple times, adjusting the earliest value each time to start where the previous request finished.

Request Components

HTTP Request

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

Query Parameters

None.

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 Body

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

Parameter Name	Data Type	Description
deviceId required	deviceId object	An identifier for a single device.
kind, id required for deviceId	string	The type and value of the device identifier. ESN - decimal, 11 digits ICCID - decimal, up to 20 digits IMEI - decimal, up to 16 digits MDN - decimal, 10 digits MEID - hexadecimal, 14 characters MSISDN - decimal, 11 digits
earliest required	string	The earliest date and time for which you want provisioning data.
latest required	string	The last date and time for which you want provisioning data.

Example Request Body

{
  "deviceId": {
    "id": "89141390780800784259",
    "kind": "iccid"
  },
  "earliest": "2015-09-16T00:00:01Z",
  "latest": "2015-09-18T00:00:01Z"
}

Success Responses

Status 200 or 202

Returns a list of device provisioning events sorted by the occurredAt timestamp, oldest first.

Parameter Name	Data Type	Description
occurredAt	dateTime	The date and time when the provisioning event occured.
eventBy	string	The user who performed the provisioning event.
eventType	string	The provisioning action: Activate Suspend Restore Deactivate Device Move
status	string	The success or failure of the provisioning event.
mdn	string	The MDN assigned to the device after the provisioning event.
msisdn	string	The MSISDN assigned to the device after the provisioning event.
servicePlan	string	The service plan of the device after the provisioning event occurred.
extendedAttributes		Any extended attributes for the event, as Key and Value pairs.
key	string	The key for an extended attribute.
value	string	The value for an extended attribute.
hasMoreData	boolean	False for a status 200 response. True for a status 202 response, indicating that there is more data to be retrieved. Send another request, adjusting the `earliest` value in the request based on the `occurredAt` value for the last record in the current response.

Example Success Response

{
  "provisioningHistory": [
    {
      "occurredAt": "2015-12-17T13:56:13-05:00",
      "status": "Success",
      "eventBy": "Harry Potter",
      "eventType": "Activation Confirmed",
      "servicePlan": "Tablet5GB",
      "mdn": null,
      "msisdn": "15086303371",
      "extendedAttributes": null
    },
    {
      "occurredAt": "2015-12-17T14:37:17-05:00",
      "status": "Success",
      "eventBy": "Placido Domingo",
      "eventType": "Mobile Terminated SMS Message Sent",
      "servicePlan": "Tablet5GB",
      "mdn": null,
      "msisdn": "5086303371",
      "extendedAttributes": null
    }
  ],
  "hasMoreData": false
}

Failure Responses

Status 400

All error messages are returned in this format:

{
  "errorCode": "error code string",
  "errorMessage": "error message string"
}

Error codes and messages are listed on the Error Messages page, along with explanations and suggestions for corrective actions.

Try It Out!