Oracle® Communications Service Broker Subscriber Store User's Guide Release 6.1 Part Number E29459-01 |
|
|
PDF · Mobi · ePub |
This chapter provides reference information for the Subscriber Provisioning API, the application programming interface client applications use to manage profiles in the Oracle Communications Service Broker Subscriber Store.
You use the Subscriber Store SOAP API to add and manage subscriber profiles in the Subscriber Store.
The Subscriber Provisioning API contains the following operations:
The following sections provide reference information about the operations.
Each operation acts upon a subscriber profile. See "Using the Subscriber Provisioning API" for information on the contents of the subscriber profile, including its data elements.
Creates one or more subscriber profiles in the Subscriber Store based on the data passed in the operation call.
When it receives the request, the Subscriber Provisioning service creates the profile and assigns it an automatically generated user identifier. You can use any of the user identifiers to a getSubscriber call to verify the presence of the newly created subscriber profile.
The request body contains subscriber profile data. Each profile should be enclosed in an arg0 element.
In the profile data, the profileDataExtensions element is optional. All other elements, including all fields of the globalProfileData, are required.
See "Subscriber Profile Data Model" for information about the format of a subscriber profile.
The response contains an empty storeSubscriberResponse element.
Example 6-1 storeSubscriber Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.subscriber_store.service.rcc.app.ocsb.oracle/"> <soapenv:Header/> <soapenv:Body> <ws:storeSubscriber> <arg0> <globalProfileData> <accountState>Active</accountState> <accountType>MyGroup</accountType> <dateOfBirth>20001112</dateOfBirth> <groups>PkGroup</groups> <language>english</language> <notificationChannel>SMS</notificationChannel> <subscriberActivationDate>20110101</subscriberActivationDate> </globalProfileData> <ifcProfileData> <ifc>MyIfc</ifc> </ifcProfileData> <pcrfProfileData> <allowUnknownServices>false</allowUnknownServices> <homeZones> <locationType>CGI</locationType> <CI>99</CI> <LAC>86</LAC> <MCC>240</MCC> <MNC>1</MNC> </homeZones> <services> <description>Service 1</description> <endDate>20131231</endDate> <id>serviceId</id> <startDate>20120101</startDate> </services> <subscriberCategory>Silver</subscriberCategory> </pcrfProfileData> <profileDataExtensions> <extensionId>MyExtensionId</extensionId> <profileDataExtensions> <name>myName</name> <value>01</value> </profileDataExtensions> </profileDataExtensions> <userIdentifiers> <id>15551234567</id> <type>END_USER_E164</type> </userIdentifiers> </arg0> </ws:storeSubscriber> </soapenv:Body> </soapenv:Envelope>
Example 6-2 Creating Multiple Subscriber Profiles
<?xml version="1.0" ?> <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:storeSubscriber xmlns:ns2="http://ws.subscriber_store.service.rcc.app.ocsb.oracle/"> <arg0> <globalProfileData> <accountState>Active</accountState> <groups>MyGroup</groups> <language>english</language> <notificationChannel>SMS</notificationChannel> </globalProfileData> <ifcProfileData> <ifc>MyIFC</ifc> </ifcProfileData> <pcrfProfileData> <allowUnknownServices>true</allowUnknownServices> <homeZones> <locationType>CGI</locationType> <CI>99</CI> <LAC>86</LAC> <MCC>240</MCC> <MNC>1</MNC> </homeZones> <services> <description>MyDescription</description> <endDate>MyEndDate</endDate> <id>MyServiceId</id> </services> <subscriberCategory>silver</subscriberCategory> </pcrfProfileData> <profileDataExtensions> <extensionId>MyExtensionId</extensionId> <profileDataExtensions> <name>MyExtensionEntryName</name> <value>MyExtensionEntryValue</value> </profileDataExtensions> </profileDataExtensions> <userIdentifiers> <id>15551234567</id> <type>END_USER_E164</type> </userIdentifiers> </arg0> <arg0> <globalProfileData> <accountState>Active</accountState> <groups>MyGroup</groups> <language>english</language> <notificationChannel>SMS</notificationChannel> </globalProfileData> <ifcProfileData> <ifc>MyIFC</ifc> </ifcProfileData> <pcrfProfileData> <allowUnknownServices>true</allowUnknownServices> <homeZones> <locationType>CGI</locationType> <CI>99</CI> <LAC>86</LAC> <MCC>240</MCC> <MNC>1</MNC> </homeZones> <services> <description>MyDescription</description> <endDate>20110302</endDate> <id>MyServiceId</id> </services> <subscriberCategory>silver</subscriberCategory> </pcrfProfileData> <profileDataExtensions> <extensionId>MyExtensionId</extensionId> <profileDataExtensions> <name>MyExtensionEntryName</name> <value>MyExtensionEntryValue</value> </profileDataExtensions> </profileDataExtensions> <userIdentifiers> <id>15555678923</id> <type>END_USER_E164</type> </userIdentifiers> </arg0> </ns2:storeSubscriber> </S:Body> </S:Envelope>
Returns a single profile of a subscriber identified by the submitted subscriber identifier.
The request body is made up of an arg0 element that contains the following information:
id: The identifier of the subscriber for which you want to retrieve a profile.
type: The type of the subscriber identifier.
See "userIdentifier Element" for possible values of the type field.
The response body contains the complete subscriber profile.
See "Subscriber Profile Data Model" for information about the format of the subscriber profile.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.subscriber_store.service.rcc.app.ocsb.oracle/"> <soapenv:Header/> <soapenv:Body> <ws:getSubscriber> <arg0> <id>1</id> <type>END_USER_E164</type> </arg0> </ws:getSubscriber> </soapenv:Body> </soapenv:Envelope>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"> <S:Body> <ns2:getSubscriberResponse xmlns:ns2="http://ws.subscriber_store.service.rcc.app.ocsb.oracle/"> <result> <globalProfileData> <accountState>Active</accountState> <accountType>MyGroup</accountType> <dateOfBirth>20001112</dateOfBirth> <groups>PkGroup</groups> <language>english</language> <notificationChannel>SMS</notificationChannel> <subscriberActivationDate>20110101</subscriberActivationDate> </globalProfileData> <ifcProfileData> <ifc>MyIfc</ifc> </ifcProfileData> <pcrfProfileData> <allowUnknownServices>false</allowUnknownServices> <homeZones> <locationType>CGI</locationType> <CI>99</CI> <LAC>86</LAC> <MCC>240</MCC> <MNC>1</MNC> </homeZones> <services> <description>Service 1</description> <endDate>20131231</endDate> <id>serviceId</id> <startDate>20120101</startDate> </services> <subscriberCategory>Silver</subscriberCategory> </pcrfProfileData> <userIdentifiers> <id>15551234567</id> <type>END_USER_E164</type> </userIdentifiers> <userIdentifiers> <id>OCSB_GUID:15551234567</id> <type>END_USER_GLOBAL_UID</type> </userIdentifiers> </result> </ns2:getSubscriberResponse> </S:Body> </S:Envelope>
Modifies the data for a single subscriber profile. The request must contain the entire profile for the subscriber, including unchanged fields. The Subscriber Provisioning service replaces the contents of the existing profile with the one submitted in the request.
Request body consists of one or more arg elements made up of subscriber profiles.
In the profile data, the profileDataExtensions element is optional. All other elements, including all fields of the globalProfileData, are required.
See "Subscriber Profile Data Model" for information about the format of a subscriber profile.
If the operation was successful, the response body contains an empty updateSubscriberResponse element.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.subscriber_store.service.rcc.app.ocsb.oracle/"> <soapenv:Header/> <soapenv:Body> <ws:updateSubscriber> <arg0> <globalProfileData> <accountState>Active</accountState> <accountType>MyGroup</accountType> <dateOfBirth>20001112</dateOfBirth> <groups>PkGroup</groups> <language>spanish</language> <notificationChannel>SMS</notificationChannel> <subscriberActivationDate>20110101</subscriberActivationDate> </globalProfileData> <ifcProfileData> <ifc>MyIfc</ifc> </ifcProfileData> <pcrfProfileData> <allowUnknownServices>false</allowUnknownServices> <homeZones> <location>MyLocation</location> <locationType>0</locationType> </homeZones> <services> <description>Service 1</description> <endDate>20131231</endDate> <id>serviceId</id> <startDate>20120101</startDate> </services> <subscriberCategory>Silver</subscriberCategory> </pcrfProfileData> <profileDataExtensions> <extensionId>MyExtensionId</extensionId> <profileDataExtensions> <name>myName</name> <value>01</value> </profileDataExtensions> </profileDataExtensions> <userIdentifiers> <id>15551234567</id> <type>END_USER_E164</type> </userIdentifiers> <userIdentifiers> <id>310150123456789</id> <type>END_USER_IMSI</type> </userIdentifiers> </arg0> </ws:updateSubscriber> </soapenv:Body> </soapenv:Envelope>
Removes a single subscriber profile from the Subscriber Store.
Request body parameters are:
id: The identifier of the subscriber profile to be deleted.
type: The type of the subscriber identifier, such as IMSI or E.164. See "userIdentifier Element" for a list of the types.
If the operation was successful, the response body contains an empty deleteSubscriberResponse element.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.subscriber_store.service.rcc.app.ocsb.oracle/"> <soapenv:Header/> <soapenv:Body> <ws:deleteSubscriber> <arg0> <id>310150123456789</id> <type>END_USER_IMSI</type> </arg0> </ws:deleteSubscriber> </soapenv:Body> </soapenv:Envelope>