Unassign SIM-Secure for IoT Flexible and Flexible Bundle Licenses

DELETE /devices/license/actions/assign

Unassigns SIM-Secure for IoT Flexible and Flexible Bundle license from SIMs.

Contents

• Unassign SIM-Secure for IoT Flexible and Flexible Bundle Licenses
  DELETE /devices/license/actions/assign
  • Uses and Requirements
  • Request Components
    • HTTP Request
    • Resource Path and Query Parameters
    • Header Parameters
    • Request Body
      • Example Request Body
  • Success Responses
    • Example Success Response
    • Example Success Callback Response
  • Failure Responses
  • Error Codes and Messages

Uses and Requirements

You can remove, or unassign, SIM-Secure from SIMs to which SIM-Secure flexible licenses have been assigned. These licenses are purchased either a-la-carte or part of a bundle and are designated as: SIMSec-IoT and TS-BUNDLE-KTO-SIMSEC-MRC, respectively. Lifetime licenses are assigned to a SIM for the life of the SIM and cannot be removed.

Note: The user should register for the CarrierService Callback in order to receive callbacks for confirmation or failure of a license assignment. For more information about callbacks, please see About Callback Services and how to Register a Callback Listener.

Request Components

HTTP Request

DELETE https://thingspace.verizon.com/api/m2m/v1/devices/license/actions/assign

Resource Path and Query Parameters

None.

Header Parameters

The request header must contain a current ThingSpace authorization bearer token and a valid VZ-M2M session token, and must set the content-type to JSON.

Request Body

The request body identifies the account name, SKU number, and a list of devices from which you want to unassign a SIM-Secure for Iot license.

NOTE: You can only unassign one license type, or SKU number, per request. To unassign different license types, you must use a separate request for each type.

Example Request Body

{
  "accountName": "0000123456-00001",
  "skuNumber": "SIMSec-IoT",
   "devices": [
    {
      "deviceIds": [
        {
          "id": "15-digit IMEI",
          "kind": "imei"
        },
        {
    "id": "20-digit ICCID",
          "kind": "iccid"
        }
      ]
    }
  ]
}

Success Responses

Status 200

Example Success Response

{"requestId": "1f28c944-d007-44c9-9543-003b8820cc69"}

Example Success Callback Response

You receive a callback when you unassign SIM-Secure for IoT license assignment from SIMs and get an asynchronous response.

{
   "requestId":"1f28c944-d007-44c9-9543-003b8820cc69",
   "deviceIds":[
      {
         "id":"20-digit ICCID",
         "kind":"ICCID"
      },
      {
         "id":"10-digit MDN",
         "kind":"MDN"
      },
      {
         "id":"15-digit IMEI",
         "kind":"IMEI"
      }
   ],
   "deviceResponse":{
      "deviceSkuSubscriptionResponse":{
         "accountName":"0000123456-00001",
         "skuNumber":"TSS-IOT-INTLG-TIERED-SIMSEC",
         "action":"Unassign"
      }
   },
   "comment":"",
   "status":"Success",
   "callbackCount":1,
   "maxCallbackThreshold":4
}

Failure Responses

Error messages are returned in this format:

{
  "errorCode": "error code string",
  "errorMessage": "error message string"
}

Error Codes and Messages