This Web service method is used for an IMS™ Application Server to subscribe to notification when user data is updated from the home subscriber server (HSS).
The subscribeRepositoryData Web service method is used by an IMS Application Server to subscribe or unsubscribe to notifications from the HSS when repository data for the publicIdentity and serviceIndication change. The returned string contains a result code.
Example for Subscribe to RepositoryData updates:
Callback URI = new URI("http://hostname.example.com:1234/DHADiameterShNotifyTestClient/services/DiameterShNotifyService") String results = service.subscribeRepositoryData( "aaa://host.example.com;protocol=diameter;-117302099;1", "sipintel10.city.example.com" , "realmA.example.com", "sips:carol@ws1234.example.com", "IBM-Diameter-SH-1234567", 0,callbackURI , null, null );
Example for Unsubscribe to RepositoryData updates:
Callback URI = new URI("http://hostname.example.com:1234/DHADiameterShNotifyTestClient/services/DiameterShNotifyService") String results = service.subscribeRepositoryData( "aaa://host.example.com;protocol=diameter;-117302099;1", "sipintel10.city.example.com" , "realmA.example.com", "sips:carol@ws1234.example.com", "IBM-Diameter-SH-1234567", 1,callbackURI , null, null );
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. |
publicIdentity | String | Specifies the public user identity or public service
identity. This can be either a SIP URL or a TEL URL. Example:
|
serviceIndication | String | A unique identifier for the requested service data. Example: IBM-Diameter-SH-1234567. |
subsReqType | int | Available subscription status values:
|
callbackUri | URI | The Web service URI used to deliver notification back to the subscriber; for example: http://example.com:7676/DHADiameterShNotifyService/services/DiameterShNotifyService |
userID | String | If the IMS Application Server Notify Web service is protected, specify the user ID for that Web service. |
password | String | If the IMS Application Server Notify Web service is protected, specify the password for that Web service. |