Bulk Delete Subscriber Labels

This API is used to delete one or multiple User labels from each subscriber (SIM) in a list of multiple subscribers in a single call. The bulk request is handled on an individual basis for each subscriber. The labels to be deleted for each subscriber in the bulk list are contained in the id array of Label UUIDs. The result treats all labels of a single subscriber in the bulk list as a single result with all User labels deleted successfully for that subscriber only or all failed when even one of the labels fails to be deleted in that subscriber. The Success or Failure result of the single subscriber has no affect on the other subscribers in the bulk list.

HTTP URL
DELETE	/api/v2/bulk/subscriber/label

Eligibility

The Requester is eligible to request deleting User-labels for its own subscribers or for its sub-customers’ (sub-accounts) subscribers.

API Request

Request Structure

Parameter	Type	M/O/CM	Description
bulk	Object	M	Array of main request body object.

Bulk data objects

Element	Type	M/O/CM	Description
subscriberIdentifiers	Object	M	Subscriber unique keys object, defines the search criteria.
content	Object	M	Main elements container object.

subscriberidentifiers data objects

Element	Type	M/O/CM	Description
type	String	M	Define the search criteria: ENUMs: IMSI, ICCID, MSISDN, IMEI
value	String	M	Type value. IMSI or ICCID or MSISDN or IMEI number.

Content data objects

Parameter	Type	M/O/CM	Description
id	UUID	M	Array of label IDs to be deleted

API Response

Response Structure

Parameter	Type	M/O/CM	Description
bulk	Object	M	Array of main response body object.
pageable	Object	O	Paging information object displayed when an API call was successful. For a failure, it will be empty.

Bulk data objects

Parameter	Type	M/O/CM	Description
errorCode	String	O	Failure code.
errorMessage	String	O	Failure message.
requestId	UUID	CM	Request instance ID. To be used by external systems to query the call (operation) status: In progress Successful Failed. Displayed when an API call was successful. For a failure, it will be empty.
subscriberIdentifiers	Object	M	Subscriber unique keys object, defines the search criteria.
content	Object	O	Main response body object that reflects a single node of the original request.

subscriberidentifiers data objects

Parameter	Type	M/O/CM	Description
type	String	M	Define the search criteria: ENUMs: IMSI, ICCID, MSISDN, IMEI
value	String	M	Type value. IMSI or ICCID or MSISDN or IMEI number.

Content data objects

Element	Type	M/O/CM	Description
id	UUID	CM	Array of label IDs that have been successfully deleted (filled in for a successfully accepted request).

Pageable data objects

Element	Type	M/O/CM	Description
page	Numeric	M	Page number
size	Numeric	M	Page size. Number of requested elements per page
totalPages	Numeric	M	Total amount of available pages per requested page size
totalElements	Numeric	M	Total amount of retrieved elements

Error Codes

In addition to the general success and failure codes, the following error codes are possible.

Code	Message
GLOBAL_1001	Service unavailable. Please try again
SUBSCRIBER_1002	Subscriber does not exist
SUBSCRIBER_1031	Failed to delete subscriber label\s

Examples

Request Body

Copy

{
  "bulk": [
    {
      "subscriberIdentifiers": {
        "type": "IMSI",
        "value": "222013090961859"
      },
      "content": {
        "id": [
          "e7fcef24-5c03-41dd-9e33-995b7d6f47b5",
          "e7fcef24-5c03-41dd-9e33-995b7d6f47a7"
        ]
      }
    },
    {
      "subscriberIdentifiers": {
        "type": "ICCID",
        "value": "8935711001000034535"
      },
      "content": {
        "id": [
          "ff74dca6-8e7f-4b85-a42b-13860913b370",
          "b7fcaf34-6a03-41ed-9b32-915a7d6e76c3"
        ]
      }
    }
  ]
}

Response Body: Full Success ACK

Copy

{
  "bulk": [
    {
      "errorCode": "",
      "errorMessage": "",
      "requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370",
      "subscriberIdentifiers": {
        "type": "IMSI",
        "value": "222013090961963"
      },
      "content": {
        "id": [
          "e7fcef24-5c03-41dd-9e33-995b7d6f47b5",
          "e7fcef24-5c03-41dd-9e33-995b7d6f47a7"
        ]
      }
    },
    {
      "errorCode": "",
      "errorMessage": "",
      "requestId": "7e74dce6-8eef-4c86-a4bb-1a860913c271",
      "subscriberIdentifiers": {
        "type": "ICCID",
        "value": "8935711001000035687"
      },
      "content": {
        "id": [
          "ff74dca6-8e7f-4b85-a42b-13860913b370",
          "b7fcaf34-6a03-41ed-9b32-915a7d6e76c3"
        ]
      }
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}

Response Body: Includes Failure(s) (NAK)

Copy

{
  "bulk": [
    {
      "errorCode": "SUBSCRIBER_1031",
      "errorMessage": "Failed to delete subscriber label\\s",
      "requestId": "",
      "subscriberIdentifiers": {
        "type": "IMSI",
        "value": "222013090961963"
      },
      "content": {
        "id": [
          "e7fcef24-5c03-41dd-9e33-995b7d6f47b5",
          "e7fcef24-5c03-41dd-9e33-995b7d6f47a7"
        ]
      }
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}