GET /licenses/{acc}/cancelReturns a list of devices from which licenses will be removed if the number of MRC licenses becomes less than the number of assigned licenses.
Note: This request is only used with accounts that have a monthly recurring charge (MRC) subscription. Accounts with event-based billing do not need to track licenses.
See also:
Create cancellation candidate list
Delete cancellation candidate list
GET https://thingspace.verizon.com/api/fota/v2/licenses/{account}/cancel/index/{startIndex}
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 to get the cancellation candidate list. An account name is usually numeric, and must include any leading zeros. |
| startIndex required |
integer | The zero-based number of the first record to return. Set startIndex=0 for the first request. If there are more than 1,000 devices in the response, set startIndex=1000 for the second request, 2000 for the third request, etc. |
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. |
None.
Request the list of devices for an account:
curl https://thingspace.verizon.com/api/fota/v2/licenses/$ACCOUNT/cancel/index/0 -H 'Authorization: Bearer $AUTH_TOKEN' -H 'VZ-M2M-Token: $M2M_TOKEN'
Status 200
A success response contains the list of devices:
| Parameter Name | Data Type | Description |
|---|---|---|
| count | integer | The total number of devices on the list. |
| hasMoreData | Boolean | True if there are more devices to return. |
| updateTime | string | The date and time that the list was last updated. |
| deviceList | array of IMEI strings | The IMEIs of the devices. |
{
"count":6,
"hasMoreData": false,
"updateTime":"2018-03-22 00:06:00.069 +0000 UTC",
"deviceList":[
"990003425730535",
"990000473475989",
"990005733420535",
"990000347475989",
"990007303425535",
"990007590473489"
]
}
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.