Get an Account's License Status

GET /licenses/{acc}/index/{lastSeenDeviceId}

Returns information about an account’s Software Management Services FOTA licenses and a list of licensed devices.

Note: This request is only used with accounts that have a monthly recurring billing (MRC) subscription. Accounts with event-based billing do not need to track licenses.

Uses and Requirements

This API returns information for FOTA licenses assigned to devices. 

Request Components

HTTP Request

GET https://thingspace.verizon.com/api/fota/v3/licenses/{acc}/index/{lastSeenDeviceId}

Resource Path and Query Parameters

You must include the account name in the path and the lastSeenDeviceId query parameter to specify the starting record.

Parameter Name Data Type Description
acc
required
path		 string The name of the account for which you want the license status. An account name is usually numeric, and must include any leading zeros.
lastSeenDeviceId
required
query		 string 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, 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.
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

None

Example Request

Request a summary of FOTA license for the account.

curl GET https://thingspace.verizon.com/api/fota/v3/licenses/0000123456-00001/index/0
-H 'VZ-M2M-Token: {M2M token}' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer {bearer token}' \

Success Responses

Status 200

Parameter Name Data Type Description
accountName string The name or number of the billing account.
totalLicense integer The number of monthly licenses in the MRC subscription for HTTP devices.
assignedLicenses integer The number of licenses assigned to HTTP devices.
hasMoreData boolean True if there are more devices to retrieve.
lastSeenDeviceId string If hasMoreData=true, the startIndex to use for the next request. 0 if hasMoreData=false.
maxPageSize integer Maximum page size.
deviceList array of devices IMEI device list.
deviceList.deviceId string The Device IMEI.
deviceList.assignmentTime string The date and time that a Software Management Services license was assigned to the device.

Example Success Response

{  
  "accountName":"0000123456-00001",
  "totalLicenses":5000,
  "assignedLicenses":4319,
  "hasMoreData": true,
  "lastSeenDeviceId": 1000,
  "deviceList":[  
    {
      "deviceId": "15-digit IMEI",
      "assignmentTime": "2017-11-29 20:15:42.738 +0000 UTC"
      },
    {
      "deviceId": "15-digit IMEI",
      "assignmentTime": "2017-11-29 20:15:42.738 +0000 UTC"
      },
    {
      "deviceId": "15-digit IMEI",
      "assignmentTime": "2017-11-29 20:15:42.738 +0000 UTC"
      },
    {
      "deviceId": "15-digit IMEI",
      "assignmentTime": "01-01-1900 0:0:0 +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.