Get Device Status in a Campaign

Get Device Status in a Campaign

GET /reports/{acc}/campaigns/{campaignId}/devices

Returns a list of all devices in a campaign and the status of each device.

Uses and Requirements

Each response includes a maximum of 1,000 devices. If the report contains more than 1,000 devices (indicated by the hasMoreData parameter in each response), you must send additional requests to retrieve the remaining devices. Use the lastSeenDeviceId parameter to return a different set of devices in each response.

Request Components

HTTP Request

GET https://thingspace.verizon.com/api/fota/v2/reports/{acc}/campaigns/{campaignId}/devices

Resource Path and Query Parameters

You must include the account name in the path and campaignId in the resource path.

Parameter Name Data Type Description
acc
required
string The name of the account for which you want the list of devices. An account name is usually numeric, and must include any leading zeros.
campaignId
required
string Software upgrade identifier, returned in the “id” value of the POST /{campaigns}/acc response when the upgrade was scheduled..
lastSeenDeviceId
(query)
integer Only return devices with IMEIs larger than this value. Use 0 for the first request. If hasMoreData=true in the response, use the lastSeenDeviceId value from the response in the next request.

Header Parameters

The request header must contain a current ThingSpace authorization token and a current VZ-M2M-session token.

Parameter Name Data Type Description
Authorization
required
string HTTP Authorization request header containing a valid Bearer token.
VZ-M2M-Token
required
string A valid session token returned by a Connectivity Management POST /session/login request.

Request Body

None.

Example Request

Request the list of devices for an account:

curl https://thingspace.verizon.com/api/fota/reports/$ACC/campaigns/$CAMPAIGN_ID/devices  -H 'Authorization: Bearer $AUTH_TOKEN' -H 'VZ-M2M-Token: $M2M_TOKEN'

Success Responses

Status 200

A success response contains the account name and an array of device objects.

Parameter Name Data Type Description
totalDevice string The total number of devices in the campaign.
hasMoreData Boolean True if there are more devices to retrieve.
lastSeenDeviceId integer If hasMoreData=true, use this value for the next request. 0 if hasMoreData=false.
maxPageSize integer Maximum number of results included in the response.
deviceList array of device objects The list of devices in the account.
deviceList.deviceId string The IMEI of the device.
deviceList.status string The upgrade status of the device, either UpgradeSuccess or upgradeFailure.
deviceList.resultReason string The reason for the upgrade status.

Example Success Response

This example response has been shortened to only show three devices, although there were over 1,000 devices in the original response, as indicated by hasMoreData = true.

{
  "totalDevice": 1148,
  "hasMoreData": true,
  "lastSeenDeviceId": "991124118995360",
  "maxPageSize": 1000,
  "deviceList": [
    {
      "deviceId": "990013907835573",
      "status": "UpgradeSuccess",
      "resultReason": "DownloadInstallSucceeded"
    },
    {
      "deviceId": "990013907835573",
      "status": "UpgradeSuccess",
      "resultReason": "DownloadInstallSucceeded"
    },
    {
      "deviceId": "990013907884259",
      "status": "UpgradeSuccess",
      "resultReason": "DownloadInstallSucceeded"
    }
  ]
}

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.