Stop the ThingSpace Quality of Service API Subscription

DELETE /api/m2m/v1/device/actions/enhanceQoS

Use this endpoint to stop the ThingSpace Quality of Service API subscription

Request Components

HTTP Request

DELETE https://thingspace.verizon.com/api/m2m/v1/device/actions/enhanceQoS

Resource Path and Query Parameters

Parameter Name Data Type Description
accountName
required		 string The name of a billing account. This value is numeric and must include any leading zeroes.
qosSubscriptionId
required		 string The id of the QoS subscription that should be stopped.

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

None.

Example Request

{
   "accountName":"0000123456-00001",
   "qosSubscriptionId":"QoS subscription ID"
}

Success Responses

Status 201

{
"requestId": "be36accb-0a9a-4367-93ab-0af6c4ed256a"
}

Callback example

{
  "requestId": "be36accb-0a9a-4367-93ab-0af6c4ed256a",
  "deviceResponse": {
    "qoS": [
      {
        "accountName": "0000123456-00001",
        "qosSubscriptionId": "QoS subscription ID",
        "reportedTime": "2023-02-17T19:02:54.127",
        "qosEvent": "QoSChangeTerminated",
        "status": "SUCCESS"
      }
    ]
  },
  "callbackCount": 1,
  "maxCallbackThreshold": 4
}

Or, if the request fails:

{
  "requestId": "be36accb-0a9a-4367-93ab-0af6c4ed256a",
  "deviceResponse": {
    "qoS": [
      {
        "accountName": "0000123456-00001",
        "reportedTime": "2023-02-17T19:02:54.127",
        "qosEvent": "QoSChangeFailed",
        "status": "FAILED",
        "reason": "device not found"
      }
    ]
  },
  "callbackCount": 1,
  "maxCallbackThreshold": 4
}

Callback Parameters

Parameter Name Data Type Description
requestId string This is the same requestId in the response to the original request
deviceResponse object The device response object
    qoS array The array containing the QoS status for this subscription and account
        accountName string The name of a billing account. This value is numeric and must include any leading zeroes.
        qosSubscriptionId string The subscription id of the QoS request.
        reportedTime string ($datetime) Identifies the absolute time at which the reachability report is received from the Service Capability Exposure Function (SCEF). The format is aligned with RFC3339.
        qosEvent string

This will show either:

  • QoSChangeTerminated (QoS elevation has been stopped)
  • QoSChangeFailed
        status         string

This will show either:

  • SUCCESS
  • FAILED
        reason string This line will have a reason or description of why the request failed. If the status is "SUCCESS", this line will not be output.
callbackCount integer The number of responses in the callback request
maxCallbackThreshold integer The maximum number of callback responses allowed for this request

Failure Responses

Status 400

All error messages are returned in this format:

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