Set Fallback Attributes

POST /devices/profile/actions/setfallbackattribute

Setting the "Fallback" attribute allows a profile to be set as the profile to revert or resort to if there is a problem with the lead profile. Once the attribute is set, use Activate or Reactivate an eSIM Profile to set the fallback profile ID.

Contents

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. 
    deviceIds array

Device identifiers. deviceId will contain:

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

The type of device ID represented by the ID value. Only the following are supported by the request and both values must be present:

  • iccid - integrated circuit card ID (SIM card)
  • eid - electronic ID, a 32-digit unique ID of the device
  • imei - International Mobile Equipment Identifier 
accountName
required		 string The name of the account. This is numeric and is in the format "0000123456-00001". Leading zeros must be included.

Request Body

Example request:

{
  "devices": [
    {
      "deviceIds": [
        {
          "kind": "eid",
          "id": "32-digit EID"
        },
        {
          "kind": "iccid",
          "id": "20-digit ICCID"
        },
        {
          "kind": "imei",
          "id": "15-digit IMEI"
        }
      ]
    }
  ],
  "accountName": "0000123456-00001"
}

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 callbacks, please visit About Callback Services.

Example callback responses:

{
  "requestId": "d1f08526-5443-4054-9a29-4456490ea9f8",
  "deviceIds": [
    {
      "id": "20-digit ICCID",
      "kind": "iccid"
    },
    {
      "id": "15-digit IMEI",
      "kind": "imei"
    },
    {
      "id": "10-digit phone number",
      "kind": "mdn"
    },
    {
      "id": "32-digit EID",
      "kind": "eid"
    }
  ],
  "deviceResponse": {
    "deviceProfileResponse": {
      "deviceIdentifierCollection": [
        {
          "id": "20-digit ICCID",
          "kind": "iccid"
        },
        {
          "id": "15-digit IMEI",
          "kind": "Imei"
        },
        {
          "id": "10-digit phone number",
          "kind": "mdn"
        },
        {
          "id": "32-digit EID",
          "kind": "eid"
        }
      ]
    }
  },
  "faultResponse": {
    "faultcode": "UnifiedWebService.REQUEST_FAILED.CarrierRequestUnsuccessful",
    "faultstring": "REQUEST_FAILED. A failure cause of profile transaction with SMDP/SMSR is captured in the euiccStatusDesc field."
  },
  "status": "FAILED",
  "callbackCount": 1,
  "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 value of the device ID.
   kind
 string

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

  • imei - International Mobile Equipment IDentifier
  • iccid - Integrated Circuit Card ID (the SIM card ID)
  • mdn - Mobile Device Number (phone number)
  • eid - Electronic ID
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 devices responding.
faultResponse object

The faultResponse shows why a transaction failed.

NOTE: There will be no faultResponse if the transaction succeeds
    faultcode string Text showing the nature of the fault
    faultstring    string More details about the faultCode
status string

The status of the deviceResponse. This will be either:

  • SUCCESS
  • FAILED
callbackCount string The number of responses for deviceResponse found.
maxCallbackThreshold string The maximum number of responses for deviceResponse allowed.