Delete Subscriber Location

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

HTTP URL
DELETE	/api/v2/subscriber/{type}/{value}/cancel-location

NOTE: All {type} and {value} pairs, define the search criteria. Valid {type} ENUMs are: ‘imsi’, ‘iccid’, ‘msisdn’, ‘imei’.

Eligibility

The requesting customer is eligible to delete (reset) own subscribers and sub-customers’ subscribers.

API Request

Request Structure

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

API Response

Response Structure

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

Content data objects

Element	Type	M/O/CM	Description
requestId	UUID	M	Request instance ID. To be used by external systems to query the call (operation) status: In progress Successful Failed

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

Response Body: Success ACK

Response Body: Failure NAK