Get Device Information for a List of Devices

`POST /devices/{acc}`

Returns an array of all device detail for a subset of devices in the specified account. Each device object includes information needed for managing firmware, including the device make and model, MDN, FOTA eligibility, distribution type, and firmware installed on the 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

`POST https://thingspace.verizon.com/api/fota/v3/devices/{acc}?protocol=LWM2M`

Resource Path and Query Parameters

You must include the account name in the path.

Parameter Name	Data Type	Description
acc required	string	The billing name of the account. An account name is usually numeric and must include any leading zeros
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
protocol (query)	string	Filter by the specified protocol of the distribution. Valid values include: LWM2M OMADM HTTP

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.
Content-Type required	string	Must be `application/json`.

Request Body

The request body includes a list of IMEIs.

Parameter Name	Data Type	Description
deviceList required	array	An array of device IMEIs being queried

Example Request

curl POST https://thingspace.verizon.com/api/fota/v3/devices/$ACC  
-H 'VZ-M2M-Token: {M2M token}' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {bearer token}' \
{  
 "deviceList": [
    "15-digit IMEI",
    "15-digit IMEI"
  ]
}

Success Responses

Status 200

Parameter Name	Data Type	Description
accountName	string	The name (number) of the billing account
deviceCount	integer	The number of devices included in the query
deviceList	array
deviceId	string	The IMEI of the device
mdn	string	The MDN (phone number) of the device
model	string	FOTA model of the device
make	string	FOTA make of the device
firmware	string	The current firmware on the device
fotaEligible	boolean	Value="true" if the device software can be upgraded over the air using the Software Management Services API
licenseAssigned	boolean	Value="true" if an MRC license has been assigned to this device
status	string	Indicates if a device is active or not. Valid values include: active suspended pending
protocol	string	The device management protocol supported by the device. Valid values include: LWM2M OMD-DM HTTP
softwareList	array
name	string	The name of the software
version	string	Software version
upgradeTime	string($date-time)	The timestamp of the last upgrade
filesList	array
name	string	The name of the files
createTime	string($date-time)	The date and time when the device is created
upgradeTime	string($date-time)	The date and time when the device firmware or software was last upgraded
statusTime	string($date-time)	The system timestamp associated with this status
refreshTime	string($date-time)	The date and time when the device is refreshed
lastConnectionTime	string($date-time) or N/A	The last known time the device connected to the network

Example Success Response

{
    "accountName": "0000123456-00001",
    "deviceCount": 2,
    "deviceList": [
        {
            "deviceId": "15-digit IMEI",
            "mdn": "10-digit MDN",
            "model": "GM01Q",
            "make": "SEQUANS COMMUNICATIONS",
            "firmware": "SR1.2.0.0-10657",
            "fotaEligible": true,
            "licenseAssigned": true,
            "status": "Active",
            "protocol": "LWM2M",
            "createTime": "2020-11-10 15:35:00.122 +0000 UTC",
            "upgradeTime": "2022-02-04 06:10:01.441 +0000 UTC",
            "statusTime": "2022-02-04 04:03:04.048 +0000 UTC",
            "refreshTime": "2022-02-20 07:39:31.584 +0000 UTC",
            "lastConnectionTime": "2021-12-20 15:21:25.724 +0000 UTC"
        },
        {
            "deviceId": "15-digit IMEI",
            "mdn": "10-digit MDN",
            "model": "NRF9160",
            "make": "NORDIC SEMICONDUCTOR ASA",
            "firmware": "ee58ac77-f1fd-4960-8dc4-4d32e118a6d4",
            "fotaEligible": true,
            "licenseAssigned": true,
            "status": "Active",
            "protocol": "LWM2M",
            "createTime": "2020-06-15 05:29:25.352 +0000 UTC",
            "upgradeTime": "2022-02-17 04:03:21.758 +0000 UTC",
            "statusTime": "2022-02-18 07:32:19.246 +0000 UTC",
            "refreshTime": "2022-02-20 07:39:31.515 +0000 UTC",
            "lastConnectionTime": "2022-02-21 17:23:50.994 +0000 UTC"
        }
    ]
}

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.