1. Provisioning Interface
  2. SOAP Message Definitions
  3. Update Subscriber NAI
  4. Request

4.12.1 Request

The <updateSubscriberNaiRequest> provisions NAI routing entities. Each NAI value is defined as a combination of an NAI host and NAI user value. For example, John.Smith@oracle.com would have John.Smith as the NAI user value and oracle.com as the NAI host value.

Each routing entity contains up to nine destination names. Each destination contains FQDN and realm values, which are used for routing messages. The request can remove a destination value from existing NAI routing entities by specifying none as the destination name.

The request can add new routing entities or update destination names in existing routing entities. These destination changes are applied to all specified NAI routing entities.

Semantic Rules

  • The host name must already exist in the database.
  • Between 1 and 10 user names must be specified.
  • At least one destination must be specified.
  • All specified destination names must already exist in the database.
  • Each destination name type can only be specified once.
  • Specifying a destination name of "none" removes the association of that destination from the specified routing entity.
  • All specified routing entities will be provisioned with the same destination value(s).

Request Format

The request must be inserted between the <soapenv:Body> and </soapenv:Body> XML tags, as shown in SOAP Request Messages. 
<updateSubscriberNaiRequest [timeout="timeout"]>
  <naiList>
    <host>host</host>
    <user>user</user>
[
    <user>user</user>
          …
    <user>user</user>
]
  </naiList>
  <destinationList>
[   <imshss>imshss</imshss>       ]
[   <ltehss>ltehss</ltehss>       ]
[   <pcrf>pcrf</pcrf>             ]
[   <ocs>ocs</ocs>                ]
[   <ofcs>ofcs</ofcs>             ]
[   <aaa>aaa</aaa>                ]
[   <userdef1>userdef1</userdef1> ]
[   <userdef2>userdef2</userdef2> ]
[   <mtchss>mtchss</mtchss>       ]
  <destinationList>
</updateSubscriberNaiRequest>

Request Parameters

Table 4-18 <updateSubscriberNaiRequest> 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).
host The host name, which is used with all user values. A string with 1 to 64 characters.
user The NAI user name to be associated with the host to form an NAI.

A string with 1 to 64 characters.

Must have 1-10 user values.

imshss (Optional) The name of the IMS HSS destination. A string with 1 to 32 characters.
ltehss (Optional) The name of the LTE HSS destination. A string with 1 to 32 characters.
pcrf (Optional) The name of the PCRF destination. A string with 1 to 32 characters.
ocs (Optional) The name of the OCS destination. A string with 1 to 32 characters.
ofcs (Optional) The name of the OFCS destination. A string with 1 to 32 characters.
aaa (Optional) The name of the AAA server destination. A string with 1 to 32 characters.
userdef1 (Optional) The name of the first user defined destination. A string with 1 to 32 characters.
userdef2 (Optional) The name of the second user defined destination. A string with 1 to 32 characters.