Set the Fallback Attribute (for eUICC)

`POST /devices/profile/actions/setfallbackattribute`

During normal operations a device will make queries to profile information using the network connection. Setting the fall back attribute to "true" instructs the device to use profile infomration that is stored on the device when a network connection is unavailable.

Request Components
Success Response
Callback Response
- Callback Parameters
Failure Responses

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/setfallbackattribute`

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 eid
accountName required	string	The name of the account.
carrierName	string	The carrier providing cellular network access.

Request Body

Example request:

{
   "devices":[
      {
         "deviceIds":[
            {
               "id":"15-digit IMEI",
               "kind":"imei"
            },
            {
               "id":"32-digit EID",
               "kind":"eid"
            }
         ]
      }
   ],
   "accountName":"0000123456-00001",
   "carrierName":"Verizon Wireless"
}

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",
   "Device":[
      {
         "Kind":"iccid",
         "Identifier":"20-digit ICCID"
      },
      {
         "Kind":"eid",
         "Identifier":"32-digit EID"
      }
   ],
   "Data":{
      "Data":{
         "DeviceProfileService":{
            "SetFallbackAttribute":{
               "DeviceIdentifierCollection":[
                  {
                     "Kind":"iccid",
                     "Identifier":"20-digit ICCID"
                  },
                  {
                     "Kind":"eid",
                     "Identifier":"32-digit EID"
                  }
               ],
               "EuiccStatus":"EXECUTED_SUCCESS",
               "EuiccStatusCode":"1.2.365",
               "EuiccStatusDesc":"EUICC device profile has been updated"
            }
         },
         "Status":"SUCCESS",
         "CallbackCount":"1",
         "MaxCallbackThreshold":"4"
      }
   }
}

Callback Parameters

Parameter	Data Type	Description
username	string	The username making the request.
password	string	The password associated with the username.
requestId	string	The requestId being viewed. This is a system generated value from the request above.
Device	array	An array of identifiers available for a specific device. Each identifier will contain: identifier kind
Identifier	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
DeviceProfileService	array	Contains the SetFallbackAttribute, status and number of callback records returned.
SetFallbackAttribute	array	Contains the DeviceIdentifierCollection and status of the request.
deviceIdentifierCollection	array	Similar to deviceIds above, but this lists the devices responding.
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.
status	string	The status of the deviceResponse.
callbackCount	string	The number of responses for deviceResponse.
maxCallbackThreshold	string	The maximum number of responses for deviceResponse found.

Failure Responses

All error responses will be in the following format

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

Try It Out!