Request
The
<readSubscriberRequest>
request
extracts IMSI, MSISDN, and External Identifier routing data and subscriber
data. See
Subscriber and Routing Data
for a description of subscriber and routing data. Each routing entity contains
up to nine destination names.
If the
group="y"
attribute is specified, then
the request extracts and displays all data associated with the subscriber. The
returned response will have the Subscriber's Account ID, all IMSI, MSISDN, and
External Identifier values, and the nine destination values from any of the
subscriber's routing entities is returned in the response. All of a
subscriber's routing entities have the same destination values, so any routing
entity can be used to extract the values.
If
group="y"
is not specified or if
group="n"
is specified, then only the
specified IMSI, MSISDN, and External Identifier routing entities are retrieved.
The returned response will have each IMSI, MSISDN, or External Identifier value
along with its individual up to nine destination values.
Semantic Rules (requests that do not specify the
group attribute or specify
group="n"
)
- 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.
Semantic Rules (requests that specify
group="y"
)
- All specified
accountId
,imsi
,msisdn
, orexternalIdentifier
values must be assigned to one subscriber. The specified IMSI, MSISDN, and External Identifier values cannot exist in a standalone routing entity. - The
accountId
parameter can be specified. - A maximum of six
imsi
, sixmsisdn
, tenexternalIdentifier
, and oneaccountId
values can be specified.
Request Format
<soapenv:Body>
and
</soapenv:Body>
XML tags, as
shown in
SOAP Request Messages.
<readSubscriberRequest [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>
</readSubscriberRequest>
Request Parameters
Table 4-15 <readSubscriberRequest> Parameters (SOAP)
Parameter | Description | Values |
---|---|---|
group (Optional) | Indicates if all of the subscriber’s data should be retrieved or just specified IMSI, MSISDN, or External Identifier routing entities. |
y - Read subscriber and all of its IMSI, MSISDN, and External Identifier routing entities. n - Only read specified IMSI, MSISDN, and External Identifier routing entities (default). |
accountId (Optional) | A user-defined Account ID value to read. | 1 to 26 numeric digits. |
imsi (Optional) | An IMSI (specified in E.212 format) value to read. | 10 to 15 numeric digits. |
msisdn (Optional) | An MSISDN (specified in E.164 format) value to read. | 8 to 15 numeric digits. |
externalId (Optional) | An External Identifier (specified in NAI format) value to read. | A string with 3 to 257 characters. |