Oracle® Communications Services Gatekeeper Partner Relationship Management Guide Release 5.0 Part Number E16618-02 |
|
|
View PDF |
The Partner Relationship Management module consists of two sets of interfaces:
The Service Provider interface set
The Operator interface set
The Service Provider interface set contains a subset of the functionality of the Operator set. It can be used to perform operations for only one specific Service Provider Account; the one with which the user of the CRM/PRM application has authenticated. The Operator set can perform operations on all Service Provider Accounts and also has access to alarm reports. All operations are synchronous.
The Service Provider set of interfaces consists of the following groups:
Service Provider Service Interface, see "Service Provider Service Interfaces".
Service Provider CDR Utility interface, see "Service Provider CDR Utility Interface".
Operator Statistics Utility Interfaces, see "Service Provider Statistics Utility Interface".
Service Provider Login interface, see "Service Provider Login Interface".
Note:
The login portion of this interface is provided only for backwards compatibility purposes. The current implementation is sessionless and the only use for this interface in the current implementation is to request a new Service Provider Account be set up.The Operator set of interface consists of the following groups:
Operator Service Interface, see "Operator Interfaces".
Operator Alarm interface, see "Operator Alarm Utility Interface"
Operator CDR Utility interface, see "Operator CDR Utility Interface".
Operator Statistics Utility Interfaces, see "Operator Statistics Utility Interface"
Operator Login interface, see "Operator Login Interface".
Note:
This interface is only supplied for backwards compatibility. The current implementation is sessionless.The following is a list of the Web Services interfaces available for integration with CRM/PRM applications. The interfaces use document/literal encoding and assume SOAP over HTTP.
The WSDL files that correspond to the interface sets can be found at the URIs listed below:
SpService, WSDL at http://<host>:<port>/prm_sp/services/SpService?wsdl, see "Service Provider Interfaces".
SpCdrUtil, WSDL at http://<host>:<port>/prm_sp/services/SpCdrUtil?wsdl, see "Service Provider CDR Utility Interface".
SpStatUtil, WSDL at http://<host>:<port>/prm_sp/services/SpStatisticsUtil?wsdl, see "Service Provider Statistics Utility Interface".
SpLogin, WSDL at http://<host>:<port>/prm_sp/services/SpLogin?wsdl, see "Service Provider Login Interface".
Note:
The login portion of this interface is provided only for backwards compatibility purposes. The current implementation is sessionless and the only use for this interface in the current implementation is to request a new Service Provider Account be set up.OpService, WSDL at http://<host>:<port>/prm_op/services/OpService?wsdl, see "Operator Interfaces".
OpAlarmUtil, WSDL at http://<host>:<port>/prm_op/services/OpAlarmUtil?wsdl, see "Operator Alarm Utility Interface".
OpCdrUtil, WSDL at http://<host>:<port>/prm_op/services/OpCdrUtil?wsdl, see "Operator CDR Utility Interface".
OpStatUtil, WSDL at http://<host>:<port>/prm_op/services/OpStatisticsUtil?wsdl, see "Operator Statistics Utility Interface".
OpLogin,WSDL at http://<host>:<port>/prm_op/services/OpLogin?wsdl, see "Operator Login Interface".
Note:
This interface is only supplied for backwards compatibility. The current implementation is sessionless.Service Provider interfaces allow application service providers to request changes in their account and to monitor their accounts activities
The Service Provider Service interface provides ways to interact with the following entities:
The management user account is the account by which the service provider is authenticated with the PRM system. The following operation can be performed on an ongoing management user account:
Change the password for the Service Provider Account
The following operations can be performed on Service Provider Accounts:
Activate
Deactivate
Request deletion
Request update
Get information
Get SLA
Get state
The following operations can be performed on an Application Account:
Register new
Activate
Deactivate
Request deletion
Update
Get information
List current Application Accounts
Get the SLA
Get the state
The following operations can be performed on an Application Instance:
Register new
Activate
Deactivate
Request deletion
Request update
Get information
Get the state
List current Application Instances
Set the password that the Application Instance uses when accessing Oracle Communications Services Gatekeeper.
The following operations are available:
Count the number of CDRs that have been generated
List the CDRs that have been generated
The following operations are available:
Retrieve generated statistics information.
List available statistics types.
Backwards compatibility only:
Login
Logout
Request a new Service Provider Account
Operator interfaces allow operators to approve changes in Service Providers' accounts and to perform other account maintenance tasks.
The Operator Service interface provides ways to interact with the following entities:
The following operations can be performed on a management user account:
Change password for the Operator Account
Get user level for an Operator Account
Change password that the Service Provider uses with PRM-SP
The following operations can be performed on a Service Provider Account:
Approve or disapprove service provider's request to register a new Service Provider Account
Approve or disapprove service provider's request to delete an existing Service Provider Account
Approve or disapprove service provider's request to update an existing Service Provider Account
Activate
Deactivate
Connect (move) an account into a Service Provider Group
Make an operator request to delete an existing Service Provider Account
Make an operator request to update an existing Service Provider Account
Make an operator request to register a new Service Provider Account
Get a list of accounts that have pending requests, and need approval or disapproval by the operator
Get Service Provider Account information
List all Service Provider Accounts
Get Service Provider Account state
The following operations can be performed on a Service Provider Group:
Create
Update
Delete
Get information about the group
List all groups
Get the Service Provider Group to which a specific Application Account is assigned
The following operations can be performed on an Application Account:
Approve or disapprove service provider's request to register a new Application Account
Approve or disapprove service provider's request to update an existing Application Account
Approve or disapprove service provider's request to delete an existing Application Account
Get a list of accounts that have pending requests, and need approval or disapproval by the operator
Activate
Deactivate
Connect (move) the account into an Application Account Group
Get information about the account
Get the account's state
List all accounts
Make an operator request to delete an existing account
Make an operator request to register a new account
Make an operator request to update an existing account
The following operations can be performed on an Application Account group:
Create
Update
Delete
Get the Application Account Group to which a specific Service Provider Account and Application Account are assigned
Get information about the group
List all groups
The following operations can be performed on an Application Instance:
Approve or disapprove a service provider's request to delete an existing Application Instance
Approve or disapprove a service provider's request to register a new Application Instance
Approve or disapprove a service provider's request to update an existing Application Instance
Activate
Deactivate
Get a list of instances that have pending requests, and need approval or disapproval by the operator
Get information about the instance
Get Application Instance's state
List all instances
Set password to use when an application authenticates to Oracle Communications Services Gatekeeper
Make an operator request to delete an existing instance
Make an operator request to register new Application Instance
Make an operator request to update an existing instance
Get the authenticated operator's user level
The following operations are available:
Count the number of alarms that have been generated
List the alarms that have been generated
The following operations are available:
Count the number of charging data records that have been generated.
List the charging data records that have been generated.
The following operations are available:
Retrieve generated statistics information.
List available statistics types.
The operator login interface is provided only for backwards compatibility purposes.