Bulk Delete Subscriber Location

This API, which may also be referred to elsewhere as Cancel Location, Reset SIM or Reload SIM, is used to delete multiple subscribers’ registered location of an active IMSI from the system.

HTTP URL  
DELETE /api/v2/bulk/subscriber/cancel-location

Eligibility

The requesting customer is eligible to delete (reset) own subscribers and sub-customers’ 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
eventType Numeric O

Determines on which domain type to perform the action. Valid values:

  • 5 = circuit switching

  • 15 = packet switching

  • 25 = LTE

  • 0 = All: Apply to any type by the system

  • Default: 0 if not provided

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

eventType

Numeric

O

Determines on which domain type to perform the action. Valid values:

  • 5 = circuit switching

  • 15 = packet switching

  • 25 = LTE

  • 0 = All: Apply to any type by the system

  • Default: 0 if not provided

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_1040 Failed to cancel subscriber location

Examples

Request Body

Copy 
{
  "bulk": [
    {
      "subscriberIdentifiers": {
        "type": "IMSI",
        "value": "222013090961859"
      },
      "content": {
        "eventType": 0
      }
    },
    {
      "subscriberIdentifiers": {
        "type": "ICCID",
        "value": "8935711001000034535"
      },
      "content": {
        "eventType": 0
      }
    }
  ]
}

Response Body: Full Success ACK

Copy 
{
  "bulk": [
    {
      "errorCode": "",
      "errorMessage": "",
      "requestId": "ff74dca6-8e7f-4b85-a42b-13860913b370",
      "subscriberIdentifiers": {
        "type": "IMSI",
        "value": "222013090961963"
      },
      "content": {
        "eventType": 0
      }
    },
    {
      "errorCode": "",
      "errorMessage": "",
      "requestId": "7e74dce6-8eef-4c86-a4bb-1a860913c271",
      "subscriberIdentifiers": {
        "type": "ICCID",
        "value": "8935711001000035687"
      },
      "content": {
        "eventType": 0
      }
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}

Response Body: Failure NAK

Copy 
{
  "bulk": [
    {
      "errorCode": "SUBSCRIBER_1002",
      "errorMessage": "Subscriber does not exist",
      "requestId": "",
      "subscriberIdentifiers": {
        "type": "ICCID",
        "value": "8935711001000035687"
      },
      "content": {
        "eventType": 0
      }
    }
  ],
  "pageable": {
    "page": 0,
    "size": 10,
    "totalPages": 1,
    "totalElements": 1
  }
}