1. Provisioning Interface
  2. XML Message Definitions
  3. Delete Subscriber
  4. Request

Request

The <deleteSubscriber> request can be used to delete IMSI, MSISDN, and External Identifier routing data and subscriber data. See Subscriber and Routing Data for a description of subscriber and routing data.

The request allows for the removal of IMSI, MSISDN, External Identifier, or combinations of IMSI, MSISDN, and External Identifier routing entities. Each routing entity contains up to nine destination names.

When the group="y" attribute is specified, the request deletes all data associated with the subscriber, including the Account ID, all relationships, and all IMSI, MSISDN, and External Identifier routing entities that were assigned to the subscriber.

When group="y" is not specified or when group="n" is specified, only IMSI, MSISDN, and External Identifier routing entities are deleted. If the IMSI, MSISDN, or External Identifier value is assigned to a subscriber and there is at least one more IMSI, MSISDN, or External Identifier value assigned to the subscriber, the IMSI, MSISDN, or External Identifier value is removed from the subscriber.

The last IMSI, MSISDN, or External Identifier value cannot be removed from a subscriber - the user must delete the whole subscriber by specifying the group="y" attribute.

Semantic Rules (requests that do not specify the group attribute or specify group="n")

  • All specified IMSI, MSISDN, or External Identifier values must be assigned to one subscriber or must exist in standalone routing entities.
  • The accountID parameter cannot be specified.
  • At least one routing entity (IMSI, MSISDN, or External Identifier) must be specified.
  • A maximum of 10 routing entities (IMSI, MSISDN, External Identifier, or combinations of the two) can be specified.
  • The last IMSI, MSISDN, or External Identifier for a subscriber cannot be deleted. Use group="y" to delete whole subscriber).

Semantic Rules (requests that specify group="y")

  • All specified accountId, imsi, msisdn, and externalIdentifier values must be assigned to one subscriber. The specified imsi, msisdn, or externalIdentifier values cannot exist in a standalone routing entity.
  • The accountID parameter can be specified.
  • At least 1 imsi, msisdn, externalIdentifier, or accountId value must be specified.
  • A maximum of 6 imsi, 6 msisdn, 10 externalIdentifier, and 1 accountId value can be specified.

Request Format 

<deleteSubscriber ent="subscriberRouting" ns="dsr" [resonly="resonly"]
                  [id="id"] [timeout="timeout"] [group="group"]>
[   <accountId>accountId</accountiId> ]
[
    <imsi>imsi</imsi>
    …
    <imsi>imsi</imsi>
]
[
    <msisdn>msisdn</msisdn>
    …
    <msisdn>msisdn</msisdn>
]
[
    <externalId>externalIdentifier</externalId>
    …
    <externalId>externalIdentifier</externalId>
]
</deleteSubscriber>

Request Parameters

Table 5-15 <deleteSubscriber> Request Parameters (XML)

Parameter Definition Values
ent The entity name within the global schema. subscriberRouting
ns The namespace within the global schema. dsr
resonly (Optional) Indicates whether the response should consist of the result only, without including the original request in the response.

y - Only provide the result, do not include the original request (default).

n - Include the original request in the response.

id (Optional) Transaction ID value provided in request and passed back in the response. 1-4294967295
timeout (Optional)

The amount of time (in seconds) to wait to before being able to perform a write if another connection is performing a write, or has a transaction open.

Clients waiting to write are processed in the order that their requests were received.

If the request is being performed within a transaction, this parameter will have no effect, as the client already has a transaction open.

0 (return immediately if not available) to 3600 seconds (default is 0).
group (Optional) Indicates if all of the subscriber's data should be deleted or just specified IMSI, MSISDN, or External Identifier routing entities.

y - Delete subscriber and all of its IMSI, MSISDN, and External Identifier routing entities.

n - Only delete specified IMSI, MSISDN, and External Identifier routing entities (default).

accountId A user-defined Account ID value to delete. 1 to 26 numeric digits.
imsi (Optional) An IMSI (specified in E.212 format). 10 to 15 numeric digits.
msisdn (Optional) An MSISDN (specified in E.164 international public telecommunication numbering plan format). 8 to 15 numeric digits.
externalId (Optional) An External Identifier (specified in NAI format) value to add or update. A string with 3 to 257 characters.