Premium APIsSoftware ManagementSoftware Management V3API Reference Pages V3
Get a Device's Software Upgrade History
GET /reports/{accountName}/devices/{deviceId}
Returns the software upgrade history of the specified device IMEI.
HTTP Request
GET https://thingspace.verizon.com/api/fota/v3/reports/{accountName}/devices/{deviceId}
Header Parameters
The request header must contain a current ThingSpace authorization token, set the content to "JSON" and a current VZ-M2M-session token.
| Parameter Name | Data Type | Description |
|---|---|---|
| Authorization (required) | string | HTTP Authorization request header containing a valid Bearer token: Authorization: Bearer {token} |
| VZ-M2M-Token (required) | string | A valid session token returned by a Connectivity Management POST /session/login request. |
| Content-Type (required) | string | Must be application/json. |
Request Parameters
You must include the accountName and the device IMEI in the path.
| Parameter Name | Data Type | Description |
|---|---|---|
| accountName (required) | string | The name of the account. An account name is numeric, and must include any leading zeros. |
| deviceId (required) | string | The IMEI of the device being queried for its upgrade history. |
Request Body
None.
Success Response
Status 200 A success response contains an array of software upgrades that the device has had, and each upgrade object has these details. Example Response:
[
{
"deviceId": "15-digit IMEI",
"campaignId": "252d7ffc-7e35-11ec-931d-76f56843c393",
"accountName": "0000123456-00001",
"firmwareName": "SEQUANSCommunications_GM01Q_SR1.2.0.0-10657_SR1.2.0.0-10512",
"firmwareFrom": "SR1.2.0.0-10657",
"firmwareTo": "SR1.2.0.0-10512",
"startDate": "2022-01-25",
"reportUpdatedTime": "2022-01-26 03:45:01.608 +0000 UTC",
"status": "UpgradeSuccess",
"reason": "Upgrade completed successfully"
},
{
"deviceId": "15-digit IMEI",
"campaignId": "8f5e9a4a-6ce2-11ec-ace7-3ea293843397",
"accountName": "0000123456-00001",
"firmwareName": "SEQUANSCommunications_GM01Q_SR1.2.0.0-10512_SR1.2.0.0-10657",
"firmwareFrom": "SR1.2.0.0-10512",
"firmwareTo": "SR1.2.0.0-10657",
"startDate": "2022-01-03",
"reportUpdatedTime": "2022-01-04 02:45:00.67 +0000 UTC",
"status": "UpgradeSuccess",
"reason": "Upgrade completed successfully"
},
{
"deviceId": "15-digit IMEI",
"campaignId": "6f5890ee-61ac-11ec-ad90-4ef948cff74b",
"accountName": "0000123456-00001",
"firmwareName": "SEQUANSCommunications_GM01Q_SR1.2.0.0-10512_SR1.2.0.0-10657",
"firmwareFrom": "SR1.2.0.0-10512",
"firmwareTo": "SR1.2.0.0-10657",
"startDate": "2021-12-20",
"reportUpdatedTime": "2021-12-20 16:00:00.268 +0000 UTC",
"status": "DeviceRejected",
"reason": "Device scheduled for firmware upgrade previously, needs to be completed before another upgrade is scheduled."
},
{
"deviceId": "15-digit IMEI",
"campaignId": "172e9ffa-5c42-11ec-b4e7-9ecd0c925d89",
"accountName": "0000123456-00001",
"firmwareName": "SEQUANSCommunications_GM01Q_SR1.2.0.0-10657_SR1.2.0.0-10512",
"firmwareFrom": "SR1.2.0.0-10657",
"firmwareTo": "SR1.2.0.0-10512",
"startDate": "2021-12-13",
"reportUpdatedTime": "2021-12-14 23:18:53.092 +0000 UTC",
"status": "UpgradeFailed",
"reason": "Upgrade failed, processing is not allowed after campaign end date 14 Dec 21 00:00 UTC"
},
{
"deviceId": "15-digit IMEI",
"campaignId": "9a77091d-4bd5-11ec-9088-2ad91a9c8d05",
"accountName": "0000123456-00001",
"firmwareName": "Generic_Sensor_SR1.2.0.0-10657_SR1.2.0.0-10512",
"firmwareFrom": "SR1.2.0.0-10657",
"firmwareTo": "SR1.2.0.0-10512",
"startDate": "2021-11-22",
"reportUpdatedTime": "2021-11-22 21:12:16.765 +0000 UTC",
"status": "DeviceRejected",
"reason": "Device make/model do not meet software prerequisites."
}
] Success Parameters
| Parameter Name | Data Type | Description |
|---|---|---|
| deviceId | string | The IMEI of the device. |
| id | string | The unique identifier for the upgrade. This is a 32 or 34-bit UUID. |
| accountName | string | The name (number) of the billing account. |
| firmwareName | string | The firmware name. |
| firmwareFrom | string | The current firmware version. |
| firmwareTo | string | The firmware version being upgraded to. |
| startDate | string | Software upgrade start date. |
| status | string | The status of the upgrade for this device, either UpgradeSuccess or UpgradeFailed. |
| reason | string | More information about the status. |
Failure Responses
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.