5 Old Partner Relationship Management Interfaces

The Oracle Communications Services Gatekeeper pre-6.0 release Partner Relationship Management (PRM) module consists of these interfaces:

  • The Service Provider interface set

  • The Operator interface set

Note:

This chapter describes the interfaces for the older SOAP-based APIs. To extend and customize the GUIs used in older (Pre-6.0) Services Gatekeeper releases, see "Partner Relationship Management SOAP-based Web Services Interface".

See "API Management REST-based API" for instructions on how to use the newer API Management API.

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 customer relationship management (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:

The Operator set of interface consists of the following groups:

WSDLs

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 Simple Object Access Protocol (SOAP) over HTTP.

The Web Service Definition Language (WSDL) files that correspond to the interface sets can be found at the URIs listed below:

Note:

In each of the example URIs, the values host and port are dependent upon your Services Gatekeeper deployment.

Service Provider Interfaces

Service Provider interfaces allow application service providers to request changes in their account and to monitor their accounts activities

Service Provider Service Interfaces

The Service Provider Service interface provides ways to interact with the following entities:

Management User

The management user account authenticates the service provider with the PRM system. The following operation can be performed on an ongoing management user account:

  • Change the password for the Service Provider Account

Service Provider Accounts

The following operations can be performed on Service Provider Accounts:

  • Activate

  • Deactivate

  • Request deletion

  • Request update

  • Get information

  • Get SLA

  • Get state

Application Account

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

Application Instances

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 Services Gatekeeper.

Service Provider CDR Utility Interface

The following operations are available:

  • Count the number of charge data records (CDRs) that have been generated

  • List the CDRs that have been generated

Service Provider Statistics Utility Interface

The following operations are available:

  • Retrieve generated statistics information.

  • List available statistics types.

Service Provider Login Interface

  • backward compatibility only:

    • Login

    • Logout

  • Request a new Service Provider Account

Operator Interfaces

Operator interfaces allow operators to approve changes in Service Providers' accounts and to perform other account maintenance tasks.

Operator Service Interfaces

The Operator Service interface provides ways to interact with the following entities:

Management User

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

Service Provider Account

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

Service Provider Group

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

Application Account

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

Application Account Group

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

Application Instance

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 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

Operator Alarm Utility Interface

The following operations are available:

  • Count the number of alarms that have been generated

  • List the alarms that have been generated

Operator CDR Utility Interface

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.

Operator Statistics Utility Interface

The following operations are available:

  • Retrieve generated statistics information.

  • List available statistics types.

Operator Login Interface

The operator login interface is provided only for backward compatibility purposes.