Contents

Title and Copyright Information

Preface

• Audience
• Documentation Accessibility
• Related Documents

1 Introduction

• Integration with External Systems
• Security
• Deployment Example

2 The Partner Management Model

• Account States
• PRM Users in the Context of Services Gatekeeper Administrative Users

3 The Interfaces

• 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

4 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

5 Service Provider Login

• Interface: SpLogin
  • login
    • Input Parameters
    • Return Parameters
    • Possible Exceptions
  • logout
    • Return Parameters
    • Possible Exceptions
  • registerSpAccountReq
    • Input Parameters
    • Return Parameters
    • Possible Exceptions
  • Exceptions
    • CommonException
  • Complex data types
    • SpAccount
    • Property

6 Service Provider Service

• Interface: SpService
  • deleteSpAccountReq
    • Input Parameters
    • Return Parameters
    • Possible Exceptions
  • 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

7 Service Provider CDR Utility

• Interface: SpCdrUtil
  • countCdrs
  • listCdrs
  • Exceptions
    • CommonException
  • Data types
    • CdrInfo
    • CdrCompletionStatus
    • Property

8 Service Provider Statistics Utility

• Interface: SpService
  • listStatisticTypes
  • getStatistics
  • Exceptions
    • CommonException
  • Data types
    • StatisticsInfo
    • StatisticTypeDescriptor

9 Operator Login

• Interface: OpLogin
  • login (Deprecated. For backwards-compatibility only)
  • logout (Deprecated. For backwards-compatibility only)
  • Exceptions
    • ACCESS_DENIED
    • CommonException
  • Complex data types

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

11 Operator CDR Utility

• Interface: OpCdrUtil
  • countCdrs
  • listCdrs
  • Exceptions
    • CommonException
  • Data types
    • CdrInfo
    • CdrCompletionStatus
    • Property

12 Operator Statistics Utility

• Interface: OpStatisticsUtil
  • listStatisticTypes
  • getStatistics
  • Exceptions
    • CommonException
  • Data types
    • StatisticsInfo
    • StatisticTypeDescriptor

13 Operator Alarm Utility

• Interface: OpAlarmUtil
  • countAlarms
  • listAlarms
  • Exceptions
    • CommonException
  • Data types
    • AlarmInfo
    • AlarmSeverity