Assign Licenses to Devices

Assign Licenses to Devices

POST /licenses/{acc}/assign

Assigns FOTA licenses to a list of devices. When licenses are assigned, the ThingSpace Software Management begins monitoring the devices for reachability.


Uses and Requirements

The account must have unused licenses available to assign to the devices. You can get the total number of licenses and the number of used licenses with the GET /licenses/{account} request.

Request Components

HTTP Request

POST https://thingspace.verizon.com/api/fota/v3/firmware/licenses/{acc}/assign

Resource Path and Query Parameters

You must include the account name in the path.

Parameter Name Data Type Description
acc
required
string Account identifier.

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 provides the device list.

Parameter Name Data Type Description
devceList
required
array The IMEIs of the devices to assign licenses to.

Example Request

Assign licenses to two devices.

curl https://thingspace.verizon.com/api/fota/v3/licenses/$ACC/assign -H 'Authorization: Bearer $AUTH_TOKEN' -H 'VZ-M2M-Token: $M2M_TOKEN' -H 'Content-Type: application/json' -d
{  
 "deviceList": [
    "990003425730524",
    "990000473475967"
  ]
}

Success Responses

Status 200

Parameter Name Data Type Description
accountName string Account identifier
licTotalCount integer Total FOTA license count.
licUsedCount integer Assigned FOTA license count.
deviceList array  
   deviceId string Device IMEI.
   status string Status of the license assignment. Valid values include:
  • LicenseAssignSuccess
  • LicenseAssignFailure
   Reason string More information about the status: "Device license preexisting" or a reason for a failure such as "Device Not Found."

Example Success Response

{
    "accountName": "0642233522-00001",
    "licCount": 2,
    "licUsedCount": 2,
    "deviceList": [
        {
            "deviceId": "990003425730524",
            "status": "LicenseAssignSuccess",
            "Reason": "Device license preexisting"
        },
        {
            "deviceId": "990000473475967",
            "status": "LicenseAssignSuccess",
            "Reason": "Device license preexisting"
        }
    ]
}

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.