Go to main content
1/11
Contents
Title and Copyright Information
Preface
Audience
Documentation Accessibility
Related Documents
1
About Extending and Replacing Portal Graphical User Interfaces
Integrating the PRM Portals with External Systems
Securing the PRM API
Securing PRM Web Services
Deployment Example
Managing APIs, Partners, and Network Service Suppliers Using the Services Gatekeeper Portals
About the API and Partner Manager Portal
About the Network Service Supplier Portal
About the Partner Portal
Extending Portals
About the Default Modules and Pages
Points to Consider When Extending the Portals
About the Naming Conventions for Help Files
About the Naming Conventions for Help IDs
About the Extension Example
Adding a Page to a Portal Module
Deploying the New Page
Providing the Help Content for the New Page
Updating the Help WAR File for the Portal Application
Getting a Working Copy of the Portal Help File
Getting a Working Copy of the Help JAR File for the Portal Application
Adding the New Help HTML File to the Working Copy of the Help JAR File
Updating the map.xml File to Include the Target and URL for the Help HTML File
Updating the Navigation List for the Help to Include the New Topic
Readying the Help WAR File for Redeployment
Redeploying the WAR File in Your WebLogic Server Domain
Adding a Custom Module to a Portal Application
Adding Custom Modules
Adding a Page to the Portal Application
Verifying the Addition in the Portal Application
2
Understanding the API Management Model
Understanding the Services Gatekeeper Management Model
Account States
Administering PRM Administrative Users
3
Common Partner Relationship Management 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
4
Creating Custom Actions for Your APIs
Understanding When to Create Custom Actions
Creating and Adding a Custom Action to Services Gatekeeper
Managing Custom Actions
Discovering Actions Chains Schemas
Example Custom Actions
RESTful Request for an Attribute Example
Header Validation Example
Example Black List Action
Example Action for Adding a New Key/Value to EDRs
5
Old Partner Relationship Management 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
A
API Management REST-based API
Understanding the Partner Relationship Management API
Creating and Updating Objects
Understanding API Management API Error Handling
API Management API Operations
API and Partner Manager Portal Operations
API Management Operations
Group Management Operations
Partner Management Operations
Application Management Operations
System Configuration Operations
Partner Portal Operations
Account Management Operations
Application Management Operations
Network Service Supplier Portal Operations
Network Interface Management Operations
Understanding the API Management API Objects
createAPI
editAPI
editAPIContextRoot
deleteAPI
updateAPIStatus
getAPIs
getAPI
listApplicationsForAPI
listAPILifeCycle
updateAPIApplicationRelationship
listAllGroups
createServiceProviderGroup
deleteGroup
confirmMovePartnerToGroup
getUsers
getUserByName
approve
reject
deleteUser
createUser
listApplications
getApplication
updateCurrentSlaForApprove
denyApplication
getAllSysConfig
getSysConfig
updateAllSysConfig
updateSysConfig
getBlobSysConfig
updateBlobSysConfig
registerSP
editUser
getUserByName
listApplications
createApplication
updateApplication
removeApplication
removePendingApp
getInterfaceList
getInterfaceInfoByName
updateInterface
removeInterfaceByID
B
Actions Management REST-Based API
Understanding the Actions Management API
Understanding Actions Management API Error Handling.
Actions Management Operations
submitActionChain
Authorization
HTTP Method
URI
Request Body
Sample requestAction Schemas
Response Body
Example Request
Example Response
retrieveActionChain
Authorization
HTTP Method
URI
Request Body
Response Body
Example Request
Example Response
loadActionSchemas
Authorization
HTTP Method
URI
Request Body
Response Body
Example Request
Example Response
verifyAction
Authorization
HTTP Method
URI
Request Body
Example Request
Example Response
C
Partner Relationship Management SOAP-based Web Services Interface
About the Interface Functionality
Base Service Error Messages
Interface: SpLogin
registerSpAccountReq
Complex Data Types
Interface: OpLogin
Interface: SpService
deleteSpAccountReq
deactivateSpAccount
activateSpAccount
getSpAccount
getSpAccountState
registerAppAccountReq
deleteAppAccountReq
updateSpAccountReq
updateAppAccountReq
updateAppInstGroupReq
deleteAppInstGroupReq
listAppAccounts
getAppAccount
getAppAccountState
activateAppAccount
deactivateAppAccount
activateAppInstGroup
getAppInstGroupState
deactivateAppInstGroup
registerAppInstGroupReq
listAppInstGroups
getAppInstGroup
getSpAccountSlaByType
getAppAccountSlaByType
setAppInstGroupPassword
changeSpAccountPassword
Service Provider Service Complex Data Types
AppAccount
AppInstGroup
Property
SpAccount
State
Interface: OpService
listAppGroups
getAppGroup
createAppGroupByType
deleteAppGroup
moveAppAccountToGroup
getAppGroupId
updateAppGroupByType
listSpGroups
getSpGroup
createSpGroupByType
deleteSpGroup
moveSpToGroup
getSpGroupId
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
Data Types
AppAccount
AppAccountRef
AppInstGroupRef
AppGroup
AppInstGroup
Property
RequestResponse
SpAccount
SpGroup
UserLevel
State
Interface: SpCdrUtil
countCdrs
listCdrs
Data Types
CdrInfo
CdrCompletionStatus
Property
Interface: SpStatisticsUtil
listStatisticTypes
getStatistics
Data Types
StatisticsInfo
StatisticTypeDescriptor
Interface: OpCdrUtil
countCdrs
listCdrs
Data Types
CdrInfo
CdrCompletionStatus
Property
Interface: OpStatisticsUtil
listStatisticTypes
getStatistics
Exceptions
CommonException
Data Types
StatisticsInfo
StatisticTypeDescriptor
Interface: OpAlarmUtil
countAlarms
listAlarms
Data Types
AlarmInfo
AlarmSeverity
Scripting on this page enhances content navigation, but does not change the content in any way.