Request
The
<deleteSubscriberRequest>
request
removes IMSI, MSISDN, and External Identifier routing data and can remove
subscriber data. See
Subscriber and Routing Data
for a description of subscriber and routing data. Each routing entity contains
up to nine destination names. Each destination contains FQDN and realm values.
If the
group="y"
attribute is specified, then
the request deletes all data associated with the subscriber. The Account ID,
all relationships, and all IMSI, MSISDN, and External Identifier routing
entities that were assigned to the subscriber are deleted.
If
group="y"
is not specified or if
group="n"
is specified, only IMSI,
MSISDN, and External Identifier routing entities are deleted. If the IMSI or
MSISDN value is assigned to a subscriber and there is at least one more IMSI,
MSISDN, or External Identifier value assigned to the subscriber, then the IMSI,
MSISDN, or External Identifier value is removed from the subscriber.
Note:
The last IMSI, MSISDN, or External Identifier value cannot be removed from a subscriber. The user must delete the whole subscriber by specifying thegroup="y"
attribute.
Semantic Rules (requests that do not specify the
group attribute or specify
group="n"
)
- All specified
imsi
,msisdn
, orextenderIdentifier
values must be assigned to one subscriber or exist as a standalone routing entity. - 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 the whole subscriber.
Semantic Rules (requests that specify
group="y"
)
- All specified
accountId
,imsi
,msisdn
, orextenderIdentifier
values must be assigned to the same subscriber. The specifiedimsi
ormsisdn
values cannot exist in a standalone routing entity. - The
accountId
parameter can be specified. - At least one
accountId
,imsi
,msisdn
, orextenderIdentifier
value must be specified. - A maximum of six
imsi
, sixmsisdn
, tenextenderIdentifier
, and oneaccountId
values can be specified.
Request Format
<soapenv:Body>
and
</soapenv:Body>
XML tags, as
shown in
SOAP Request Messages.
<deleteSubscriberRequest [timeout="timeout"] [group="group"]>
<addressList>
[
<accountId>accountId</accountId>
]
[
<imsi>imsi</imsi>
…
<imsi>imsi</imsi>
]
[
<msisdn>msisdn</msisdn>
…
<msisdn>msisdn</msisdn>
]
[
<externalId>extId</externalId>
…
<externalId>extId</externalId>
]
</addressList>
</deleteSubscriberRequest>
Request Parameters
Table 4-13 <deleteSubscriberRequest> Parameters (SOAP)
Parameter | Description | Values |
---|---|---|
timeout (Optional) |
The amount of time (in seconds) to wait before being able to perform a write if another connection is performing a write, or has a transaction open. Clients waiting to write will be 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 Extender Identifier routing entities. |
y - Delete subscriber and all of its IMSI, MSISDN, and Extender Identifier routing entities. n - Only delete specified IMSI, MSISDN, and Extender Identifier routing entities (default). |
accountId (Optional) | A user-defined Account ID value to delete. | 1 to 26 numeric digits. |
imsi (Optional) | An IMSI (specified in E.212 format) value to delete. | 10 to 15 numeric digits. |
msisdn (Optional) | An MSISDN (specified in E.164 format) value to delete. | 8 to 15 numeric digits. |
externalId (Optional) | An External Identifier (specified in NAI format) value to delete. | A string with 3 to 257 characters. |