Remove Usage Segmentation Labels

Set Usage Segmentation Labels:
DELETE /devices/actions/usagesegmentationlabels

Allows you to remove the label associated with a device.

Contents

Uses and Requirements

Allow customers to remove the associated label from a device. The customer removing a label to a device is restricted to removing the label for their usage segments, and cannot access or modify any other device information owned by another party.

This API can be used for the automotive sector in cases where a streaming radio device is present.

You must register for the CarrierService callback service to receive the callback response.

Request Components

HTTP Request

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

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.

Parameter Name Data Type Description
Authorization
required
string HTTP Authorization bearer token.
VZ-M2M-Token
required
string A valid session token returned by POST /session/login.
Content-Type
required
string Must be application/json.

Request Body Parameters

Parameter Name Data Type Description
accountName
required
string The name of a billing account. An account name is usually numeric, and must include any leading zeros.
labels
required
Array of label names and label values Maximum of 2,000 objects are allowed in the array.
label.name
required
Varchar(20) The label you want to remove from being associated with the device.
label.value
required
Varchar (50) The label value.
deviceId
required
deviceId object An identifier for a single device.
deviceId.kind,
deviceId.id
required for deviceId
string The type and value of the device identifier.
  • EID - 32 digits

Example Request Body

{
  "accountName": "0342330389-00001",            
  "labels": [                                   
    {                                          
      "name": "VIN",
      "value": "2K180720196786706B33432D4"
    },
    {
      "name": "VIN",
      "value": "3B380790196786706F33432X4"
    },
  ]
}

Success Responses

Status 200

A successful request returns the request ID.

Parameter Name Data Type Description
requestId string A unique string that associates the request with the results that are sent via a callback message.

Example Success Response

{
  "requestId": "595f5c44-c31c-4552-8670-020a1545a84d"
}

Callback Parameters

Parameter Name Data Type Description
username
required
string The username for authentication.
password
required
string The password for authentication.
requestId
required
string The unique ID of the asynchronous request.
deviceResponse array of usageSegmentationLabelsResponse objects Summary of status of the device and label assignment.
usagesegmentationlabelsResponse array of usageSegmentationLabels objects The response of usage segmentation label assignment.
usageSegmentationLabels array of deviceId and label objects.
deviceIds All identifiers for the device.
deviceIds.kind string The type of the device identifier. Valid types of identifiers are:
  • EID - 32 digits
deviceIds.id string The value of the device identifier.
label.name Varchar(20) The label you want to remove from being associated with the device.
label.value Varchar(50) The label value.
action string The type of action you are taking. Valid values include:
  • Remove
lineStatus string Indicates the status of the action. Valid values include:
  • Success
  • Failed (with description of failure)
totalLabelCount string The total number of labels.
failedLabelCount string The total number of failed label removals.
successLabelCount string The total number of successful label removals.
callbackCount integer Total number of callback requests.
maxCallbackThreshold integer Maximum number of callbacks allowed.

Example Callback Request

{
  "username": "foo",
  "password": "bar",
  "requestId": "8835387e-cbf9-4df5-bb66-522c5072fb21",
  "deviceResponse": {
    "usageSegmentationLabelsResponse": {
      "usageSegmentationLabels": [
        {
          "deviceIds": [
            {
              "id": "8991101200003204514",
              "kind": "EID"
            }
          ],
          "label": {
            "name": "vin",
            "value": "meetapk12345678"
          },
          "action": "Remove",
          "lineStatus": "Success",
          "description": ""
        },
      ],
      "totalLabelCount": "1",
      "failedLabelCount": "0",
      "successLabelCount": "1"
    }
  },
  "callbackCount": 1,
  "maxCallbackThreshold": 4
}

Callback Success Response

200 OK

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.