Delete serial numbers from an existing subscription

The delete serial numbers from an existing subscription request allows the client application to delete a single or multiple serial numbers from the subscription by providing the subscription ID and serial number list as input parameters.

Delete serial numbers from an existing subscription describes the API structure for deleting serial numbers from an existing subscription.

Table 1. Delete serial numbers from an existing subscription
Title Delete serial numbers from an existing subscription
URL http://<impact_url>/m2m/subscriptions/{subscriptionId}/serialNumbers
Method DELETE
Content-Type application/json
URL Params

The following are the URL parameters:

  • serialNumber:[string]: Specifies the list of serial numbers of the devices that are required to be added in the list of observed resources

    Example:

    deleteRequest=  
{
  "serialNumbers": [
    "string"
  ]
}
    Note:

    • Multiple serial numbers can be provided as input by separating each string value with comma (,) operator.

    • IMPACT IoT ignores any serial numbers mentioned in the input, if they are not part of the specified subscription.

  • subscriptionID:[string]: Specifies the subscription correlator ID for which observed devices list is to be reduced.
Data Params

subscriptionID:[string]: Specifies the subscription correlator ID for which observed devices list is reduced.

Msg:[String]: info/warning/error message

Example:
{
  "subscriptionId": "string",
  "msg": "string", "code": 1000
}
Success Code 
Response Code: 200
Error Code 
204 : No Content 
401 : Unauthorized 
403 : Forbidden 
404 : Not Found
Sample Call

Curl:

curl -X DELETE --header 'Content-Type: application/json' --header 'Accept: application/json'  --header 'Authorization: Basic ZG9jdXNlcjpBc2RmMSM=' -d '{
  "serialNumbers": [
    "111111"
  ]
}' 'http://<impact_url>/m2m/subscriptions/d7588da6-cd36-455f-8af5-3376e886a3e3/serialNumbers'
Response Body:
{
  "subscriptionId": "d7588da6-cd36-455f-8af5-3376e886a3e3",
  "msg": "Success","code":1000
}
Notes

None