Deactivate a Device (for eUICC)

POST /devices/profile/actions/deactivate

Deactivate a eUICC device, or multiple devices, for a profile.

Contents

See also:

Request Components

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

HTTP Request

POST https://thingspace.verizon.com/api/m2m/v1//devices/profile/actions/deactivate

Request Parameters

Parameter Data Type Description

devices
required

 array

An array of deviceIds. Each deviceId will contain:

  • id
  • kind
   id
 string The numeric ID of the device.
   kind
 string

The the type of device ID represented by the ID value. This could be:

  • imei
  • iccid
  • mdn
  • eid
accountName
required		 string The name of the account.
carrierName string The carrier providing cellular network access.
reasonCode string A note or reason why the change is being made.
etfwaiver boolean

This flags a billing modification and indicates if the customer wants to use an Early Termination Fee waiver (true) or not (false) for this transaction.
checkFallbackProfile
 boolean An indicator of the fallback being set or not .

Request Body

Example request:

{
   "devices":[
      {
         "deviceIds":[
            {
               "id":"15-digit IMEI",
               "kind":"imei"
            },
            {
               "id":"32-digit EID",
               "kind":"eid"
            }
         ]
      }
   ],
   "accountName":"0000123456-00001",
   "carrierName":"name of the mobile service provider",
   "reasonCode":"string",
   "etfWaiver":false,
   "checkFallbackProfile":false
}

Success Response

Status 200

A successful response shows a system generated request ID to track the request.

Example Response:

{
  "requestId": "d1f08526-5443-4054-9a29-4456490ea9f8"
}

Callback Response

These endpoints send responses asynchronously. In order to read the results a callback is required.To learn more about callback, please visti About Callback Services.

Example callback response:

{
   "username":"username",
   "password":"password",
   "requestId":"d1f08526-5443-4054-9a29-4456490ea9f8",
   "deviceIds":[
      {
         "id":"20-digit ICCID",
         "kind":"iccid"
      },
      {
         "id":"15-digit IMEI",
         "kind":"imei"
      },
      {
         "id":"32-digit EID",
         "kind":"eid"
      }
   ],
   "deviceResponse":{
      "deviceProfileResponse":{
         "deviceIdentifierCollection":[
            {
               "id":"20-digit ICCID",
               "kind":"iccid"
            },
            {
               "id":"10-digit MDN",
               "kind":"mdn"
            },
            {
               "id":"32-digit EID",
               "kind":"eid"
            }
         ],
         "state":"Deactive",
         "smsrOid":"1.3.6.1.4.1.31746.1.500.200.101.5",
         "profileStatus":"ENABLE",
         "euiccStatus":"EXECUTED_SUCCESS",
         "euiccStatusCode":"1.2.365",
         "euiccStatusDesc":"EUICC device profile has been updated",
         "euiccSubAddressUpdateStatus":"EXECUTED_SUCCESS",
         "euiccSubAddressUpdateStatusCode":"1",
         "euiccSubAddressUpdateStatusDesc":"SUCCESS: Address has been updated"
      }
   },
   "status":"Success",
   "callbackCount":4,
   "maxCallbackThreshold":4
}

Callback Parameters

Parameter Data Type Description
requestId string The requestId being viewed. This is a system generated value from the request above.
deviceIds
 array

An array of devices being queried by the request. Each deviceId will contain:

  • id
  • kind
   id
 string The numeric ID of the device.
   kind
 string

The the type of device ID represented by the ID value. This could be:

  • imei
  • iccid
  • mdn
  • eid
deviceResponse array Contains the deviceProfileResponse, status and number of callback records returned.
deviceProfileResponse  array

Contains the details and status of the devices and the request.
   deviceIdentifierCollection array Similar to deviceIds above, but this lists the available identifiers for devices responding.
   state string The state of the device(s) responding.
   profileStatus string Indicates the profile state and will show what request was made.
   euiccStatus string This shows how the device, or devices, has responded to the request. eUICC is embedded universal integrated circuit card and refers to the SIM card for the device. For more information, visit Working with eUICC Devices.
   euiccStatusCode string The system generated status code for an eUICC device.
  euiccStatusDesc string Description of the eUICC status code
  euiccSubAddressUpdateStatus string Status of any address update requests.
  euiccSubAddressUpdateStatusCode string A system generated status code for an address update request.
  euiccSubAddressUpdateStatusDesc string A description of the status code from above.
status string The status of the deviceResponse.
callbackCount string The number of responses for deviceResponse found.
maxCallbackThreshold string The maximum number of responses for deviceResponse allowed.

Failure Responses

All error responses will be in the following format

{
  "errorCode": "The 3-digit HTML error code",
  "errorMessage": "string"
}