Integration Guidelines for Partner Relationship Management

About This Document

Introduction

Integration with external systems

Security

Deployment example

The Partner Management Model

Account States

PRM Users in the Context of Oracle Communications Services Gatekeeper Administrative Users

The Interfaces

Overview

WSDLs

Service Provider Interfaces

Service Provider Service Interfaces

Management User

Service Provider Accounts

Application Account

Application Instances

Service Provider CDR utility interface

Service Provider Statistics Utility interface

Service Provider Login interface

Operator Interfaces

Operator Service Interfaces

Management User

Service Provider Account

Service Provider Group

Application Account

Application Account Group

Application Instance

Operator Alarm utility interface

Operator CDR utility interface

Operator Statistics utility interface

Operator login interface

Common PRM Use Scenarios

Registering a new Service Provider Account

Registering a new Application Account

Registering a new Application Instance

Operator: Creating a Service Provider Group

Operator: Creating an Application Account Group

Service Provider requests an account update

Service Provider deactivates an account

Service Provider requests an account deletion

Communicating general information between Service Provider and Operator

Retrieving Charging Data Records

Retrieving Statistics

Retrieving Alarms

Service Provider Login

Web Service

Interface: SpLogin

login (Deprecated. For backwards-compatibility only)

logout(Deprecated. For backwards-compatibility only)

registerSpAccountReq

Exceptions

CommonException

Complex data types

SpAccount

Property

Service Provider Service

Web Service

Interface: SpService

deleteSpAccountReq

deactivateSpAccount

activateSpAccount

getSpAccount

getSpAccountState

registerAppAccountReq

deleteAppAccountReq

updateSpAccountReq

updateAppAccountReq

updateAppInstGroupReq

deleteAppInstGroupReq

listAppAccounts

getAppAccount

getAppAccountState

activateAppAccount

deactivateAppAccount

activateAppInstGroup

getAppInstGroupState

deactivateAppInstGroup

registerAppInstGroupReq

deactivateAppInstGroup

listAppInstGroups

getAppInstGroup

getSpAccountSla

getSpAccountSlaByType

getAppAccountSla

getAppAccountSlaByType

setAppInstGroupPassword

changeSpAccountPassword

Exceptions

ACCESS_DENIED

CommonException

INVALID_STATE

Data types

AppAccount

AppInstGroup

Property

SpAccount

State

Service Provider CDR Utility

Web Service

Interface: SpCdrUtil

countCdrs

listCdrs

Exceptions

CommonException

Data types

CdrInfo

CdrCompletionStatus

Property

Service Provider Statistics Utility

Web Service

Interface: SpService

listStatisticTypes

getStatistics

Exceptions

CommonException

Data types

StatisticsInfo

StatisticTypeDescriptor

Operator Login

Web Service

Interface: OpService

login (Deprecated. For backwards-compatibility only)

logout (Deprecated. For backwards-compatibility only)

Exceptions

ACCESS_DENIED

CommonException

Complex data types

Operator Service

Web Service

Interface: OpService

listAppGroups

getAppGroup

createAppGroup

createAppGroupByType

deleteAppGroup

moveAppAccountToGroup

getAppGroupId

updateAppGroup

updateAppGroupByType

listSpGroups

getSpGroup

createSpGroup

createSpGroupByType

deleteSpGroup

moveSpToGroup

getSpGroupId

updateSpGroup

updateSpGroupByType

listAppInstGroups

getAppInstGroup

getAppInstGroupState

registerAppInstGroupReq

deleteAppInstGroupReq

deleteAppInstGroupRes

updateAppInstGroup

updateAppInstGroupRes

getUpdatePendingAppInstGroup

setAppInstGroupPassword

unlockAppInstGroup

activateSpAccount

deactivateSpAccount

getSpAccount

getSpAccountState

registerAppAccountReq

registerAppAccountRes

updateAppAccountRes

getUpdatePendingAppAccount

deleteAppAccountReq

deleteAppAccountRes

updateAppAccount

getAppAccount

getAppAccountState

activateAppAccount

deactivateAppAccount

registerAppInstGroupRes

activateAppInstGroup

deactivateAppInstGroup

registerSpAccountReq

listAppAccounts

listSpAccounts

registerSpAccountRes

deleteSpAccountReq

deleteSpAccountRes

updateSpAccount

updateSpAccountRes

getUpdatePendingSpAccount

setSpAccountPassword

changeOpAccountPassword

getUserLevel

Exceptions

ACCESS_DENIED

CommonException

Data types

AppAccount

AppAccountRef

AppInstGroupRef

AppGroup

AppInstGroup

Property

RequestResponse

SpAccount

SpGroup

UserLevel

State

Operator CDR Utility

Web Service

Interface: OpCdrUtil

countCdrs

listCdrs

Exceptions

CommonException

Data types

CdrInfo

CdrCompletionStatus

Property

Operator Statistics Utility

Web Service

Interface: OpStatisticsUtil

listStatisticTypes

getStatistics

Exceptions

CommonException

Data types

StatisticsInfo

StatisticTypeDescriptor

Operator Alarm Utility

Web Service

Interface: OpAlarmUtil

countAlarms

listAlarms

Exceptions

CommonException

Data types

AlarmInfo

AlarmSeverity