WebSphere brand IBM WebSphere IP Multimedia Subsystem Connector, Version 6.2

getUserData Web service method

This Web service method returns user profile data in an XML string representation. The XML file adheres to the format defined in the ShDataType.xsd schema file.

Usage

This Web service method returns the following types of user profile data as an XML string representation: Repository Data, IMSPublic Identity, IMSUserState, S_CSCFName, InitialFilteCriteria, CSLocationInformation, PSLocationInformation, CSUserState, PSUserState, Charging_information, MSISDN, and PSIActivation.

Example

The getUserData Web service method can be used to request different types of data. The parameters that are required will depend on the type of data being requested.
Note: In the following examples, the sixth parameter is used to retrieve the specific type of User Data from the user's profile.

Example for a request RepositoryData user data XML string:

String repositoryDataXML = service.getUserData( "aaa://host.example.com;protocol=diameter;-117302099;1", "sipintel10@city.example.com", "realmA.example.com", "sips:carol@ws1234.example.com", null, 0, "IBM-Diameter-SH-1234567", -1, -1, null);

Example for request InitialFilterCriteria user data XML string:

String filterCriteriaXML = service.getUserData( "aaa://host.example.com;protocol=diameter;-117302099;1", "sipintel10@city.example.com", "realmA.example.com", "sips:carol@ws1234.example.com", null, 13, null, -1, -1, new URI("sip:siphappens.example.com") );

Example for request IMSPublicIdentity user data XML string:

String publicIdentityXML = service.getUserData( "aaa://host.example.com;protocol=diameter;-117302099;1", "sipintel10@city.example.com", "realmA.example.com", "sips:carol@ws1234.example.com", null, 10, null, 1, -1, null);

Example for request CSLocationInformation user data XML string:

String csLocInfoXML = service.getUserData( "aaa://host.example.com;protocol=diameter;-117302099;1", "sipintel10@city.example.com", "realmA.example.com", null, "0113 272 2245", 14, null, -1, 0, null);

Example for request PSIActivation user data XML string:

String psiActivationXML = service.getUserData( "aaa://host.example.com;protocol=diameter;-117302099;1", "sipintel10@city.example.com", "realmA.example.com", null, "0113 272 2245", 18, null, -1, null, -1);

Parameters

Parameter Name Type Description
sessionId String

Identifies a specific session. All messages pertaining to a specific session must include only one Session-Id AVP and the same value must be used throughout the life of a session. The Session ID must be globally and eternally unique, as it is meant to uniquely identify a user session without reference to any other information. This may be needed to correlate historical authentication information with accounting information. Example: aaa://host.example.com;protocol=diameter;-117302099;1

destinationHost String

The fully qualified domain name of the HSS that the Sh subscriber profile Web service will send this request to. This input parameter is optional. Examples include: sipintel15.city.example.com or diameter.example.com

destinationRealm String

The realm that this subscriber belongs to. The destination realm is a required parameter and must be a fully qualified domain name. The value specified must match the specific realmName property that is defined in one of the routex properties in the Diameter_Sh.properties file. If the value does not match any of the specific routes, and a DEFAULT route entry is defined, the DEFAULT route will be used.

publicUserIdentity String
A subscriber is allocated one or more public user identities, which are created by the home operator. A public user identity is either a SIP URL (as defined in RFC 3261) or a TEL URI (as defined in RFC 3966) and helps route a SIP request. Example:
  • sip:Alice.Smith@example.com;transport=tcp
  • sips:carol@ws1234.example.com
  • sip:+358-555-1234567;postd=pp22@example.com;user=phone
  • sip:alice;day=tuesday@example.com
  • tel:+919-123-4567
  • tel:+358-555-1234567;postd=pp22
msisdn String
Mobile Subscriber ISDN is the standard international telephone number used to identify a given subscriber. The MSISDN is the telephone number of a GSM (Global System for Mobile Communications) cell phone that is stored in the SIM (Subscriber Identity Module) smart card inside the phone. A public user identity in IMS is the equivalent of the MSISDN in a GSM network. Example:
  • +919-123-4567
  • (919)-155-4567
  • 0113 272 2245
  • 0044 113 272 2245
  • +44 113 272 2245

When requesting IMSPublicIdentity or ChargingInformation either the public_user_identity or msisdn parameter is required.

dataReference int

Data reference values indicate the type of user data being requested:

  • 0 = Repository Data
  • 10 = IMSPublicIdentity
  • 11 = IMSUserState
  • 12 = S_CSCFName
  • 13 = InitialFilterCriteria
  • 14 = LocationInformation
  • 15 = UserState
  • 16 = Charging_Information
  • 17 = MSISDN
  • 18 = PSI Activation
serviceIndication String

A unique identifier for the requested service data. Example: IBM-Diameter-SH-1234567.

This parameter is only required if the dataReference value is set to 0 for the repository data.

identitySet int
The following values are defined in ShDataType.xsd:
  • 0 = ALL_IDENTITIES
  • 1 = REGISTERED_IDENTITIES
  • 2 = IMPLICIT_IDENTITIES

This parameter is only required if the dataReference value is set to 10 for the IMSPublicIdentity.

serverName URI

The SIP URL of the application server that is providing the service of interest.

This parameter is only required if the dataReference value is set to 13 for the initialFilterCriteria.

requestedDomain int
This parameter is required only if the dataReference value is set to 14 or 15 for LocationInformation or UserState.
  • 0 = CS_Domain
  • 1 = PS_Domain



Terms of use
(C) Copyright IBM Corporation 2009. All Rights Reserved.