Get the license status
Get an account’s license status
GET /licenses/{account}
Returns information about an account’s Software Management Services 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.
Request Components
HTTP Request
GET https://thingspace.verizon.com/api/fota/v1/licenses/{account}/index/{startIndex}
Resource Path and Query Parameters
You must include the account name in the path and the startIndex to specify the starting record.
| Parameter Name | Data Type | Description |
|---|---|---|
| account (required) | 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. |
| startIndex (required) | 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 as the startIndex in the next request. |
Header Parameters
The request header must set the content-type to JSON, contain a current ThingSpace authorization token and a current VZ-M2M session token. For more details on how to get these tokens, visit Getting Started.
| Parameter Name | Data Type | Description |
|---|---|---|
| Authorization (required) | string | HTTP Authorization bearer token: Authorization: Bearer {token} |
| VZ-M2M-Token (required) | string | A valid session token: VZ-M2M-Token: {M2Mtoken} |
| Content-Type (required) | string | Must be application/json Content-Type: application/json |
Request Body
None.
Example Request
Request the license status for an account:
curl https://thingspace.verizon.com/api/fota/v1/licenses/$ACCOUNT/index/0 -H 'Authorization: Bearer $AUTH_TOKEN' -H 'VZ-M2M-Token: $M2M_TOKEN'
Success Responses
Status 200
A successful response includes the total number of licenses, the number of assigned license, and a list of devices that have licenses assigned.
| Parameter Name | Data Type | Description |
|---|---|---|
| accountName | string | The name (number) of the billing account. |
| totalLicenses | integer | The number of monthly licenses in the MRC subscription. |
| assignedLicenses | integer | The number of licenses assigned to devices. |
| hasMoreData | boolean | True if there are more devices to retrieve. |
| lastSeenDeviceId | integer | If hasMoreData=true, the startIndex to use for the next request. 0 if hasMoreData=false. |
| deviceList | array | The list of devices that have licenses assigned, including the date and time of when each license was assigned. |
| deviceList.deviceId | string | The IMEI of the device. |
| deviceList.assignmentTime | string | The date and time that an Software Management Services license was assigned to the device. |
Example Success Response
{
"accountName":"0402196254-00001",
"totalLicenses":5000,
"assignedLicenses":4319,
"hasMoreData": true,
"lastSeenDeviceId": 1000,
"deviceList":[
{
"deviceId": "990003425730535",
"assignmentTime": "2017-11-29 20:15:42.738 +0000 UTC"
},
{
"deviceId": "990000473475989",
"assignmentTime": "2017-11-29 20:15:42.738 +0000 UTC"
},
{
"deviceId": "990000347475989",
"assignmentTime": "2017-11-29 20:15:42.738 +0000 UTC"
},
{
"deviceId": "990007303425535",
"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.