BEAWebLogic Network Gatekeeper · Send us e-mail at [email protected] if you have questions or comments. Your comments will be reviewed directly by the BEA professionals who create

BEAWebLogic Network Gatekeeper™

Web Services API Description for Partner Relationship Management

Version 2.2 Revised: May 15, 2006

CopyrightCopyright © 1995-2006 BEA Systems, Inc. All Rights Reserved.

Restricted Rights LegendThis software is protected by copyright, and may be protected by patent laws. No copying or other use of this software is permitted unless you have entered into a license agreement with BEA authorizing such use. This document is protected by copyright and may not be copied photocopied, reproduced, translated, or reduced to any electronic medium or machine readable form, in whole or in part, without prior consent, in writing, from BEA Systems, Inc.

Information in this document is subject to change without notice and does not represent a commitment on the part of BEA Systems. THE DOCUMENTATION IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. FURTHER, BEA SYSTEMS DOES NOT WARRANT, GUARANTEE, OR MAKE ANY REPRESENTATIONS REGARDING THE USE, OR THE RESULTS OF THE USE, OF THE DOCUMENT IN TERMS OF CORRECTNESS, ACCURACY, RELIABILITY, OR OTHERWISE.

Trademarks and Service MarksCopyright © 1995-2006 BEA Systems, Inc. All Rights Reserved. BEA, BEA JRockit, BEA WebLogic Portal, BEA WebLogic Server, BEA WebLogic Workshop, Built on BEA, Jolt, JoltBeans, SteelThread, Top End, Tuxedo, and WebLogic are registered trademarks of BEA Systems, Inc. BEA AquaLogic, BEA AquaLogic Data Services Platform, BEA AquaLogic Enterprise Security, BEA AquaLogic Interaction, BEA AquaLogic Interaction Analytics, BEA AquaLogic Interaction Collaboration, BEA AquaLogic Interaction Content Services, BEA AquaLogic Interaction Data Services, BEA AquaLogic Interaction Integration Services, BEA AquaLogic Interaction Process, BEA AquaLogic Interaction Publisher, BEA AquaLogic Interaction Studio, BEA AquaLogic Service Bus, BEA AquaLogic Service Registry, BEA Builder, BEA Campaign Manager for WebLogic, BEA eLink, BEA Kodo, BEA Liquid Data for WebLogic, BEA Manager, BEA MessageQ, BEA SALT, BEA Service Architecture Leveraging Tuxedo, BEA WebLogic Commerce Server, BEA WebLogic Communications Platform, BEA WebLogic Enterprise, BEA WebLogic Enterprise Platform, BEA WebLogic Enterprise Security, BEA WebLogic Express, BEA WebLogic Integration, BEA WebLogic Java Adapter for Mainframe, BEA WebLogic JDriver, BEA WebLogic Log Central, BEA WebLogic Mobility Server, BEA WebLogic Network Gatekeeper, BEA WebLogic Personalization Server, BEA WebLogic Personal Messaging API, BEA WebLogic Platform, BEA WebLogic Portlets for Groupware Integration, BEA WebLogic Real Time, BEA WebLogic RFID Compliance Express, BEA WebLogic RFID Edge Server, BEA WebLogic RFID Enterprise Server, BEA WebLogic Server Process Edition, BEA WebLogic SIP Server, BEA WebLogic WorkGroup Edition, BEA Workshop for WebLogic Platform, BEA Workshop JSP, BEA Workshop JSP Editor, BEA Workshop Struts, BEA Workshop Studio, Dev2Dev, Liquid Computing, and Think Liquid are trademarks of BEA Systems, Inc. Accelerated Knowledge Transfer, AKT, BEA Mission Critical Support, BEA Mission Critical Support Continuum, and BEA SOA Self Assessment are service marks of BEA Systems, Inc.

All other names and marks are property of their respective owners.

API Description for Partner Relationship Management Interfaces i

Contents:

1. Operator LoginWeb Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1

logout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2

Exceptions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3

Complex data types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3

Listener Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3

2. Operator ServiceWeb Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

listAppGroups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1

getAppGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2

createAppGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3

deleteAppGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3

moveAppAccountToGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4

getAppGroupId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5

updateAppGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5

listSpGroups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-6

getSpGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7

createSpGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7

deleteSpGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8

moveSpToGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9

ii API Description for Partner Relationship Management Interfaces

getSpGroupId . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9

updateSpGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-10

listAppInstGroups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-11

getAppInstGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12

getAppInstGroupState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-12

registerAppInstGroupReq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-13

deleteAppInstGroupReq. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14

deleteAppInstGroupRes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-15

updateAppInstGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-17

updateAppInstGroupRes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-17

getUpdatePendingAppInstGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-18

setAppInstGroupPassword. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-19

unlockAppInstGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-20

activateSpAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-21

deactivateSpAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-22

getSpAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-23

getSpAccountState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-23

registerAppAccountReq. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-24

registerAppAccountRes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-25

updateAppAccountRes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-26

getUpdatePendingAppAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-27

deleteAppAccountReq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-28

deleteAppAccountRes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-29

updateAppAccount. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-30

getAppAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-31

getAppAccountState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-32

activateAppAccount. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-32

deactivateAppAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-33

API Description for Partner Relationship Management Interfaces iii

registerAppInstGroupRes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-34

activateAppInstGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-35

deactivateAppInstGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-36

registerSpAccountReq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-37

listAppAccounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-38

listSpAccounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-39

registerSpAccountRes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-39

deleteSpAccountReq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-41

deleteSpAccountRes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-41

updateSpAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-42

updateSpAccountRes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-43

getUpdatePendingSpAccount. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-44

setSpAccountPassword. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-45

changeOpAccountPassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-46

getUserLevel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-47

Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-47

Data types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-48

Listener Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-52

3. Operator Alarm UtilityWeb Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

countAlarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1

listAlarms . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-2

Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3

Data types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3


iv API Description for Partner Relationship Management Interfaces

4. Operator CDR UtilityWeb Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

countCdrs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-1

listCdrs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3

Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4

Data types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4

Listener Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6

5. Operator Statistics UtilityWeb Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

listStatisticTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-1

getStatistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-2

Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3

Data types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-3


6. Operator Messaging Management UtilityWeb Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

listMailboxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-1

createMailbox. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-2

removeMailbox . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3

addMailboxTranslation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-3

deleteMailboxTranslation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-4

listMailboxTranslations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-5

listMailboxTranslationsForAddress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6

Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-6

Data types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-7


API Description for Partner Relationship Management Interfaces v

7. Service Provider LoginWeb Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-1

logout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-2

registerSpAccountReq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-3

Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4

Complex data types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7-4


8. Service Provider ServiceWeb Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1

deleteSpAccountReq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-1

deactivateSpAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-2

activateSpAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3

getSpAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-3

getSpAccountState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-4

registerAppAccountReq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5

deleteAppAccountReq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-5

updateSpAccountReq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-6

updateAppAccountReq. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-7

updateAppInstGroupReq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-8

deleteAppInstGroupReq . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-9

listAppAccounts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-10

getAppAccount. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-10

getAppAccountState. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-11

activateAppAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-12

deactivateAppAccount . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-12

activateAppInstGroup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-13

vi API Description for Partner Relationship Management Interfaces

getAppInstGroupState . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-14

deactivateAppInstGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-15


deactivateAppInstGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-17


listAppInstGroups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-19

getAppInstGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-19

getSpAccountSla . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-20

getAppAccountSla . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-21

setAppInstGroupPassword. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-21

changeSpAccountPassword . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-22

Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-23

Data types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-23

Listener Interface. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-26

9. Service Provider CDR UtilityWeb Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1

countCdrs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-1

listCdrs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2

Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4

Data types. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-4


10.Service Provider Statistics UtilityWeb Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1

listStatisticTypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-1

getStatistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-2

Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3

API Description for Partner Relationship Management Interfaces vii

Data types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-3


11.Service Provider Messaging Management UtilityWeb Service. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1

listMailboxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-1

Exceptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2

Data types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2


viii API Description for Partner Relationship Management Interfaces

API Description for Partner Relationship Management Interfaces 1

About This Document

This document explains the Partner Relationship Management interfaces exposed for developing and integrating the Partner Relationship Management interfaces exposed by WebLogic Network Gatekeeper with operator internal CRM/PRM systems and operator-external customer-facing CRM/PRM systems.

This document covers the following topics:

Chapter 1, “Operator Login” describes the interface used by the Operator CRM/PRM application to log in CRM/PRM users to the Operator part of a the Partner Management Relationship interfaces.

Chapter 2, “Operator Service” describes the main interface used by the Operator part of a CRM/PRM application.

Chapter 3, “Operator Alarm Utility” describes the Alarm utility interface used by the Operator part of a CRM/PRM application.

Chapter 4, “Operator CDR Utility” describes the CDR utility interface used by the Operator part of a CRM/PRM application.

Chapter 5, “Operator Statistics Utility” describes the Statistics utility interface used by the Operator part of a CRM/PRM application.

Chapter 6, “Operator Messaging Management Utility” describes the Messaging Management utility interface used by the Operator part of a CRM/PRM application.

About Th is Document

2 API Description for Partner Relationship Management Interfaces

Chapter 7, “Service Provider Login” describes the interface used by the Service Provider CRM/PRM application to log in CRM/PRM users to the Service Provider part of the Partner Relationship Management interfaces.

Chapter 8, “Service Provider Service” describes the main interface used by the Operator part of a CRM/PRM application.

Chapter 9, “Service Provider CDR Utility” describes the CDR utility interface used by the Service Provider part of a CRM/PRM application.

Chapter 10, “Service Provider Statistics Utility” describes the Statistics utility interface used by the Service Provider part of a CRM/PRM application.

Chapter 11, “Service Provider Messaging Management Utility” describes the Messaging Management utility interface used by the Service provider part of a CRM/PRM application.

What You Need to KnowThis document is intended mainly for application developers who are interested in building CRM/PRM applications to manage Service Providers and Applications that are or will be using the traffic interfaces exposed by the WebLogic Network Gatekeeper. It assumes a familiarity with WebLogic Network Gatekeeper and Web Services programming.

e-docs Web SiteBEA product documentation is available on the BEA corporate Web site. From the BEA Home page, click on Product Documentation or go directly to the “e-docs” Product Documentation page at http://e-docs.bea.com.

How to Print the DocumentYou can print a copy of this document from a Web browser, one file at a time, by using the File→Print option on your Web browser.

A PDF version of this document is available on the WebLogic Network Gatekeeper documentation Home page on the e-docs Web site (and also on the documentation CD). You can open the PDF in Adobe Acrobat Reader and print the entire document (or a portion of it) in book format. To access the PDFs, open the WebLogic Network Gatekeeper documentation Home page, click the PDF files button and select the document you want to print.

Re la ted In fo rmat ion


If you do not have the Adobe Acrobat Reader, you can get it for free from the Adobe Web site at http://www.adobe.com/.

Related InformationThe following BEA WebLogic Network Gatekeeper documents contain information that is relevant to using the Partner Relationship Management interfaces:

WebLogic Network Gatekeeper Integration Guidelines for Partner Relationship Management

WebLogic Network Gatekeeper Product Description

WebLogic Network Gatekeeper User's Guide

For more information in general about Web Services and WSDL applications, refer to the following source:

The W3C Web Site at http://www.w3c.org/

Contact Us!Your feedback on the BEA WebLogic Network Gatekeeper documentation is important to us. Send us e-mail at [email protected] if you have questions or comments. Your comments will be reviewed directly by the BEA professionals who create and update the WebLogic Network Gatekeeper documentation.

In your e-mail message, please indicate that you are using the documentation for the BEA WebLogic Network Gatekeeper 2.0 release.

If you have any questions about this version of BEA WebLogic Network Gatekeeper, or if you have problems installing and running BEA WebLogic Network Gatekeeper, contact BEA Customer Support through BEA WebSupport at www.bea.com. You can also contact Customer Support by using the contact information provided on the Customer Support Card, which is included in the product package.

When contacting Customer Support, be prepared to provide the following information:

Your name, e-mail address, phone number, and fax number

Your company name and company address

Your machine type and authorization codes



The name and version of the product you are using

A description of the problem and the content of pertinent error messages

Documentation ConventionsThe following documentation conventions are used throughout this document.

Convention Item

boldface text Indicates terms defined in the glossary.

Ctrl+Tab Indicates that you must press two or more keys simultaneously.

italics Indicates emphasis or book titles.

monospace text

Indicates code samples, commands and their options, data structures and their members, data types, directories, and file names and their extensions. Monospace text also indicates text that you must enter from the keyboard.

Examples:#include <iostream.h> void main ( ) the pointer psz

chmod u+w *

\tux\data\ap

.doc

tux.doc

BITMAP

float

monospace boldface text

Identifies significant words in code.

Example:void commit ( )

monospace italic text

Identifies variables in code.

Example:

String expr

Documentat ion Convent i ons


UPPERCASE TEXT

Indicates device names, environment variables, and logical operators.

Examples:

LPT1

SIGNON

OR

{ } Indicates a set of choices in a syntax line. The braces themselves should never be typed.

[ ] Indicates optional items in a syntax line. The brackets themselves should never be typed.

Example:buildobjclient [-v] [-o name ] [-f file-list]... [-l file-list]...

| Separates mutually exclusive choices in a syntax line. The symbol itself should never be typed.

... Indicates one of the following in a command line: • That an argument can be repeated several times in a command line• That the statement omits additional optional arguments• That you can enter additional parameters, values, or other information

The ellipsis itself should never be typed.

Example:buildobjclient [-v] [-o name ] [-f file-list]... [-l file-list]...

.

.

.

Indicates the omission of items from a code example or from a syntax line. The vertical ellipsis itself should never be typed.

Convention Item



API Description for Partner Relationship Management Interfaces 1-1

C H A P T E R 1

Operator Login

Web ServiceThe Operator Login Web Service provides a CRM/PRM application with functions for logging in to the Partner Relationship Management module in WebLogic Network Gatekeeper.

When an application session has been created, a loginTicket is returned. This loginTicket is used to identify login session.

loginUsed by a CRM/PRM application to login and retrieve a loginTicket that servers as an identifier when the Operator part of the Partner Relationship Management interface is used.

Table 1-1 login(operatorId, password)

Parameter Name Type Description

Input

operatorId xsd:string The ID of operator account. This account is created using the Network Gatekeeper Management Tool.

password xsd:string The password associated with the password.

Opera to r Log in

1-2 API Description for Partner Relationship Management Interfaces

logoutUsed by a CRM/PRM application to logout and destroy the login session and the corresponding loginTicket

Returns

loginReturn xsd:string Returns a loginTicket used to identify the login session. This ticket shall be supplied in the SOAP header for each method invocation.

Possible Exceptions

ACCESS_DENIED

CommonException

Table 1-2 logout(loginTicket)


Input

loginTicket xsd:string The loginTicket retrieved when logging in.

Returns

logoutReturn void

Possible Exceptions

ACCESS_DENIED

CommonException

Table 1-1 login(operatorId, password)


L is tener In te r face


Exceptions

ACCESS_DENIEDExceptions of this type are raised when access to the method is denied.

CommonExceptionThis exception is raised when the login session has expired or there are communication problems with the underlying platform.

Complex data typesThere are no complex data types.

Listener InterfaceAll operations are synchronous, and no listener interface is present.

Opera to r Log in



C H A P T E R 2

Operator Service

Web ServiceThe Operator Service Web Service provides a CRM/PRM application with functions for handling Service Provider Accounts, Service Provider Groups, Application Accounts, Application Account Groups and Applications Instance groups.

To use this interface, the CRM/PRM application must have logged in and retrieved a loginTicket using the Operator Login Web Service, see “Operator Service” on page 2-1.

listAppGroupsLists all Application Groups

Table 2-1 listAppGroups()


Input

no input parameters

Returns

Array of xsd:string A list of all Application Group IDs.

Possible Exceptions

Operato r Se rv ice


getAppGroupRetrieves details about a specific Application Group.

ACCESS_DENIED

CommonException

Table 2-2 getAppGroup(appGroupId)


Input

appGroupId xsd:string The ID of the group.

Returns

tns1:AppGroup Data structure with details about the Application Group. See “AppGroup” on page 2-49.

Possible Exceptions

ACCESS_DENIED

CommonException

Table 2-1 listAppGroups()


Web Serv i ce


createAppGroupCreates a new Application Group with a certain ID.

deleteAppGroupDeletes an Application Group. There must be no Application Accounts associated with the group in order to delete it

Table 2-3 createAppGroup(appGroupId, appGroup)


Input

appGroupId xsd:string ID of the Application Group.

appGroup tns1:AppGroup Data structure describing the group. See “AppGroup” on page 2-49

Returns

createAppGroupReturn void

Possible Exceptions

ACCESS_DENIED

CommonException

Table 2-4 deleteAppGroup(appGroupId)


Input


Returns

deleteAppGroupReturn void

Possible Exceptions

Operato r Se rv ice


moveAppAccountToGroupAssociates an Application Account for a specific Service Provider with an Application Group.

ACCESS_DENIED

CommonException

Table 2-5 moveAppAccountToGroup(spAccountId, appAccountId, appGroupId)


Input

spAccountId xsd:string The ID of the Service Provider Account.

appAccountId xsd:string The ID of the Application Account.

appGroupId xsd:string The ID of the Application Account Group.

Returns

moveAppAccountToGroupReturn

void

Possible Exceptions

ACCESS_DENIED

CommonException If any of the accounts od groups does not exist, this exception is thrown.

Table 2-4 deleteAppGroup(appGroupId)


Web Serv i ce


getAppGroupIdRetrieves the ID of the Application Group for a given Service Provider Account and Application Account combination.

updateAppGroupUpdates an Application Group with new SLA data.

Table 2-6 getAppGroupId(spAccountId, appAccountId)


Input



Returns

getAppGroupIdReturn xsd:string ID of the Application Group.

Possible Exceptions

ACCESS_DENIED

CommonException If any of the accounts does not exist or no group is associated, this exception is thrown.

Table 2-7 updateAppGroup(appGroupId, appGroup)


Input


Operato r Se rv ice


listSpGroupsLists all Service Provider Groups

appGroup tns1:AppGroup The Application-level SLA, and CRM/PRM application-defined properties in the form of name-value pairs. See “AppGroup” on page 2-49

Returns

updateAppGroupReturn void

Possible Exceptions

ACCESS_DENIED

CommonException If group does not exist or if the SLA contains errors, this exception is thrown.

Table 2-8 listSpGroups()


Input

no input parameters

Returns

listSpGroupsReturn Array of xsd:string A list of all service Provider Group IDs.

Possible Exceptions

ACCESS_DENIED

CommonException

Table 2-7 updateAppGroup(appGroupId, appGroup)


Web Serv i ce


getSpGroupRetrieves details about a specific Service Provider Group.

createSpGroupCreates a new Service Provider Group with a certain ID.

Table 2-9 getSpGroup(spGroupId)


Input

spGroupId xsd:string The ID of the group.

Returns

getSpGroupReturn tns1:SpGroup Data structure with details about the Service Provider Group. See “SpGroup” on page 2-51.

Possible Exceptions

ACCESS_DENIED

CommonException

Table 2-10 createSpGroup(spGroupId, spGroup)


Input

spGroupId xsd:string ID of the Service Provider Group ID.

spGroup tns1:SpGroup Data structure describing the group. See “SpGroup” on page 2-51.

Returns

createSpGroupReturn void

Operato r Se rv ice


deleteSpGroupDeletes a Service Provider Group. There must be no Service Provider Accounts associated with the group in order to delete it

Possible Exceptions

ACCESS_DENIED

CommonException

Table 2-11 deleteSpGroup(spGroupId)


Input


Returns

deleteSpGroupReturn void

Possible Exceptions

ACCESS_DENIED

CommonException If there are Service Provider accounts associated with the group, this exception is thrown.

Table 2-10 createSpGroup(spGroupId, spGroup)


Web Serv i ce


moveSpToGroupAssociates a Service Provider Account with a Service Provider Group.

getSpGroupIdRetrieves the ID of the Service Provider Group for a given Service Provider Account.

Table 2-12 moveSpToGroup(spAccountId, SpGroupId)


Input


SpGroupId xsd:string The ID of the Service provider Group.

Returns

moveSpToGroupReturn void

Possible Exceptions

ACCESS_DENIED

CommonException If any of the accounts does not exist, this exception is thrown.

Table 2-13 getSpGroupID(spAccountId)


Input


Returns

getSpGroupIdReturn xsd:string ID of the Service Provider Group.

Operato r Se rv ice


updateSpGroupUpdates an Service Provider Group with new SLA data.

Possible Exceptions

ACCESS_DENIED

CommonException If the account does not exist, this exception is thrown.

Table 2-14 updateSpGroup(spGroupId,spGroup)


Input


spGroup tns1:SpGroup The Service Provider-level SLA, and CRM/PRM application-defined properties in the form of name-value pairs. See “SpGroup” on page 2-51.

Returns

updateSpGroupReturn void

Possible Exceptions

ACCESS_DENIED


Table 2-13 getSpGroupID(spAccountId)


Web Serv i ce


listAppInstGroupsLists all Application Instance groups for a given combination of Service Provider Account and Application Account. Filtering is possible on the state of the Application Instance Group

Table 2-15 listAppInstGroups(spAccountId, appAccountId, state)


Input

spAccountId xsd:string The ID of the Service Provider Account. If null, here is no filtering on Service Provider ID.

appAccountId xsd:string The ID of the Application Account. If null, there is no filtering on Application Account ID.

state tns1:State Indicates which states to filter the result on. See “State” on page 2-51.

Returns

listAppInstGroupsReturn Array of tns1:AppInstGroupRef

Data structure containing a references to the Application Instance Group. See “AppInstGroupRef” on page 2-48.

Possible Exceptions

ACCESS_DENIED

CommonException

Operato r Se rv ice


getAppInstGroupRetrieves details about a specific Application Instance Group.

getAppInstGroupStateGets the state of specific Application Instance Group.

Table 2-16 getAppInstGroup(spAccountId, appAccountId, appInstGroupId)


Input



appInstGroupId xsd:string The ID of the Application Instance Group.

Returns

getAppInstGroupReturn tns1:AppInstGroup Data structure with details about the Application Instance Group. See “AppInstGroup” on page 2-49.

Possible Exceptions

ACCESS_DENIED

CommonException

Table 2-17 getAppInstGroupState(spAccountId, appAccountId, appInstGroupId)


Input


Web Serv i ce


registerAppInstGroupReqRequest to register an Application Instance Group for a specific combination of a Service Provider Account and Application Account. When this request has been approved by the Operator, see “registerAppInstGroupRes” on page 2-34, the newly registered application has all login credentials necessary to log in to the traffic interfaces of the Network Gatekeeper.



Returns

getAppInstGroupStateReturn

tns1:State The state of the Application Instance Group. See “State” on page 2-51.

Possible Exceptions

ACCESS_DENIED

CommonException

Table 2-18 registerAppInstGroupReq(spAccountId, appAccountId, appInstGroupId, appInstGroup, password)


Input



appInstGroupId xsd:string The ID of the Application Instance Group to be registered.

Table 2-17 getAppInstGroupState(spAccountId, appAccountId, appInstGroupId)


Operato r Se rv ice


deleteAppInstGroupReqRequest to deletes an Application Instance Group. In order to delete it, there must be no Application Instance Group SLA associated with the combination of Service Provider Account, Application Account, and Application Instance Group. The Application Instance Group must be in state INACTIVE in order for this call to be accepted. The request must be approved before the Application Instance Group it is deleted, this is done using “deleteAppInstGroupRes” on page 2-15,

appInstGroup The Application Instance Group-level SLA, and CRM/PRM application-defined properties in the form of name-value pairs.

password xsd:string The password the newly created application will use when logging in to the Network Gatekeeper

Returns

registerAppInstGroupReqReturn

void

Possible Exceptions

ACCESS_DENIED

CommonException

Table 2-19 deleteAppInstGroupReq(spAccountId, appAccountId, appInstGroupId)


Input

spAccountId xsd:string The ID of the group.

Table 2-18 registerAppInstGroupReq(spAccountId, appAccountId, appInstGroupId, appInstGroup, password)


Web Serv i ce


deleteAppInstGroupResResponse to a request for deleting an Application Instance Group for a specific combination of Service Provider Account and Application Account.

It is possible to approve or disapprove the request. Both cases triggers a state transition for the Application Instance Group. If approved, the Application Instance group is deleted, and the

appAccountId xsd:string

appInstGroupId xsd:string

Returns

deleteAppInstGroupReqReturn

void

Possible Exceptions

ACCESS_DENIED

CommonException If there is a SLA associated with the combination of Service Provider Accounts, Application Account, and Application Instance Group associated with the group, this exception is thrown.

INVALID_STATE

Table 2-19 deleteAppInstGroupReq(spAccountId, appAccountId, appInstGroupId)


Operato r Se rv ice


Service Provider Account, Application Account and Application Instance Group cannot be used to log in to the traffic interfaces of Network Gatekeeper.

Table 2-20 deleteAppInstGroupRes(spAccountId, appAccountId, appInstGroupId, response)


Input




response tns1:RequestResponse The response to the request. See “RequestResponse” on page 2-50.

Returns


void

Possible Exceptions

ACCESS_DENIED


INVALID_STATE

Web Serv i ce


updateAppInstGroupUpdates an Application Instance Group with new SLA data.

updateAppInstGroupResResponse to a request for updating Application Instance Group for a specific combination of Service Provider Account and Application Account.

Table 2-21 updateAppInstGroup(spAccountId, appAccountId, appInstGroupId, appInstGroup)


Input




appInstGroup tns1:AppInstGroup Data-structure with the Application Instance Group SLA and application-defined properties in the form of name-value pairs. See “AppInstGroup” on page 2-49.

Returns

updateAppInstGroupReturn

void

Possible Exceptions

ACCESS_DENIED


Operato r Se rv ice


It is possible to approve or disapprove the request. Both cases triggers a state transition for the Application Instance Group to state ACTIVE. If approved, the Application Instance Group is updated with the information given by the Service Provider via the Service Provider interface, see “updateAppInstGroupReq” on page 8-8.

getUpdatePendingAppInstGroupGet details about an specific Application Instance Group that is state UPDATE_PENDING, the details includes Application Instance Group SLA, and CRM/PRM application-defined properties in the form of name-value pairs.

Table 2-22 updateAppInstGroupRes(spAccountId, appAccountId, appInstGroupId, response)


Input





Returns

updateAppInstGroupResReturn

void

Possible Exceptions

ACCESS_DENIED


Web Serv i ce


setAppInstGroupPasswordSet the password associated with an Application Instance Group. This password is a part of the login credentials an application use to login and use the traffic interfaces exposed by Network Gatekeeper.

Table 2-23 getUpdatePendingAppInstGroup(spAccountId, appAccountId, appInstGroupId)


Input




Returns

getUpdatePendingAppInstGroupReturn

tns1:AppInstGroup Application Instance Group SLA, and CRM/PRM application-defined properties in the form of name-value pairs. See “AppInstGroup” on page 2-49.

Possible Exceptions

ACCESS_DENIED

CommonException

INVALID_STATE If the Application instance Group is not in state UPDTATE_PENDING this exception is thrown.

Operato r Se rv ice


.

unlockAppInstGroupUnlock a locked Application Instance Group. The group may have been locked by too many faulty login attempts to the traffic interfaces exposed by the Network Gatekeeper.

Table 2-24 setAppInstGroupPassword(spAccountId, appAccountId, appInstGroupId, newPassword)


Input




newPassword xsd:string The new password.

Returns

setAppInstGroupPasswordReturn

void

Possible Exceptions

ACCESS_DENIED

CommonException

Table 2-25 unlockAppInstGroup(spAccountId, appAccountId, appInstGroupId, newPassword)


Input


Web Serv i ce


activateSpAccountActivate a Service Provider Account. Change the state of the account to ACTIVE.



Returns

unlockAppInstGroupReturn

void

Possible Exceptions

ACCESS_DENIED

CommonException

Table 2-26 activateSpAccount(spAccountId)


Input


Returns

activateSpAccountReturn void

Possible Exceptions

ACCESS_DENIED

Table 2-25 unlockAppInstGroup(spAccountId, appAccountId, appInstGroupId, newPassword)


Operato r Se rv ice


deactivateSpAccountDeactivate a Service Provider Account. Change the state of the account to INACTIVE.

CommonException

INVALID_STATE If the state of the Service Provider Account does not allow the account to be activated, this exception is thrown.

Table 2-27 deactivateSpAccount(spAccountId)


Input


Returns

deactivateSpAccountReturn

void

Possible Exceptions

ACCESS_DENIED

CommonException

INVALID_STATE If the state of the Service Provider Account does not allow the account to be deactivated, this exception is thrown.

Table 2-26 activateSpAccount(spAccountId)


Web Serv i ce


getSpAccountRetrieves details about a specific Service Provider Account. The details includes contact details and CRM/PRM application-defined properties in the form of name-value pairs.

getSpAccountStateRetrieves the state of a specific Service Provider Account.

Table 2-28 getSpAccount(spAccountId)


Input

spAccountId xsd:string The ID of the account.

Returns

getSpAccountReturn tns1:SpAccount Data structure with details on the Service Provider account. See “SpAccount” on page 2-50.

Possible Exceptions

ACCESS_DENIED

CommonException

Table 2-29 getSpAccountState(spAccountId)


Input

spAccountId xsd:string The ID of the account.

Returns

getSpAccountStateReturn tns1:State Information of the state of the Service Provider Account. See “State” on page 2-51.

Operato r Se rv ice


registerAppAccountReqRequest to register an Application Account for a specific Service Provider Account. When this request has been approved by the Operator, see “registerAppAccountRes” on page 2-25, the Application Account can be associated with an Application Account Group and an Application Instance Group.

Possible Exceptions

ACCESS_DENIED

CommonException

Table 2-30 registerAppAccountReq(spAccountId, appAccountId, appAccount)


Input



appAccount tns1:AppAccount Data structure with details on the Application Account, including CRM/PRM application-defined properties in the form of name-value pairs. See “AppAccount” on page 2-48.

Returns


void

Table 2-29 getSpAccountState(spAccountId)


Web Serv i ce


registerAppAccountResResponse to a request for registering an Application Account for a specific Service Provider Account. An Application Account Group is also associated with the Application Account.

It is possible to approve or disapprove the request. Both cases triggers a state transition for the Application Account. If approved, the Application Account is transferred into state ACTIVE. If Disapproved, the Application Account is deleted.

Possible Exceptions

ACCESS_DENIED

CommonException

INVALID_STATE

Table 2-31 registerAppAccountRes(spAccountId, appAccountId, appGroupId, appAccountRef, response)


Input



appGroupId xsd:string The ID of the Application Account Group to be associate with the Application Account.

appAccountRef xsd:string Internal ID of the Application Account. This ID is used to correlate the Application Account ID with an Operator-internal ID.

Table 2-30 registerAppAccountReq(spAccountId, appAccountId, appAccount)


Operato r Se rv ice


updateAppAccountResResponse to a request for updating an Application Account for a specific Service Provider.

It is possible to approve or disapprove the request. Both cases triggers a state transition for the Application Account state Active. If approved, the Application Account is updated with the information given by the Service Provider via the Service Provider interface, see “updateAppAccountReq” on page 8-7.


Returns


void

Possible Exceptions

ACCESS_DENIED

CommonException

INVALID_STATE

Table 2-32 updateAppAccountRes(spAccountId, appAccountId, response)


Input




Table 2-31 registerAppAccountRes(spAccountId, appAccountId, appGroupId, appAccountRef, response)


Web Serv i ce


getUpdatePendingAppAccountGet details about pending update requests for a specific combination of Service Provider and Application Account. The details includes descriptions and CRM/PRM application-defined properties in the form of name-value pairs. Valid only for Application Accounts in state UPDATE_PENDING.

Returns

updateAppAccountResReturn

void

Possible Exceptions

ACCESS_DENIED

CommonException

INVALID_STATE If the status of the Application Account is not in state UPDATE_PENDING, this exception is thrown.

Table 2-33 getUpdatePendingAppAccount(spAccountId, appAccountId)


Input



Returns

Table 2-32 updateAppAccountRes(spAccountId, appAccountId, response)


Operato r Se rv ice


deleteAppAccountReqRequest to delete an Application Account. In order to delete it, there must be no Application Instance Group associated with the combination of Service Provider Account, Application Account. The request must be approved before the Application Account is deleted, this is done using “deleteAppAccountRes” on page 2-29. The Application Account must be in state INACTIVE in order for this call to be accepted.

getUpdatePendingAppAccountReturn

tns1:AppAccount Data structure describing the Application Account. See “AppAccount” on page 2-48.

Possible Exceptions

ACCESS_DENIED

CommonException

INVALID_STATE If the status of the Application Account is not in state UPDATE_PENDING, this exception is thrown.

Table 2-34 deleteAppAccountReq(spAccountId, appAccountId)


Input



Returns

Table 2-33 getUpdatePendingAppAccount(spAccountId, appAccountId)


Web Serv i ce


deleteAppAccountResResponse to a request for deleting an Application Account for a specific Service Provider Account. The Application Account must be in state DELETE_PENDING in order for this call to be accepted.

It is possible to approve or disapprove the request. Both cases triggers a state transition for the Application Account. If approved, the Application Account is simply deleted. If Disapproved, the Application Account is transferred into state INACTIVE.

deleteAppAccountReqReturn

void

Possible Exceptions

ACCESS_DENIED

CommonException

INVALID_STATE

Table 2-35 deleteAppAccountRes(spAccountId, appAccountId, response)


Input



Returns

deleteAppAccountResReturn

void

Possible Exceptions

Table 2-34 deleteAppAccountReq(spAccountId, appAccountId)


Operato r Se rv ice


updateAppAccountUpdates an Application Account with new data.

ACCESS_DENIED

CommonException

INVALID_STATE

Table 2-36 updateAppAccount(spAccountId, appAccountId, appAccount)


Input



appAccount tns1:AppAccount Data structure with details on the Application Account, including CRM/PRM application-defined properties in the form of name-value pairs. See “AppAccount” on page 2-48.

Returns

updateAppAccountReturn void

Possible Exceptions

ACCESS_DENIED

Table 2-35 deleteAppAccountRes(spAccountId, appAccountId, response)


Web Serv i ce


getAppAccountRetrieves details about a specific Application Account. The operation includes a data structure with details on the Application Account, including CRM/PRM application-defined properties in the form of name-value pairs.

CommonException

INVALID_STATE

Table 2-37 getAppAccount(spAccountId, appAccountId)


Input



Returns

getAppAccountReturn tns1:AppAccount Data structure with details about the Application Account. See “AppAccount” on page 2-48.

Possible Exceptions

ACCESS_DENIED

CommonException

Table 2-36 updateAppAccount(spAccountId, appAccountId, appAccount)


Operato r Se rv ice


getAppAccountStateRetrieves the state of a specific Application Account.

activateAppAccountActivate an Application Account. Change the state of the account to ACTIVE. The current state of the account must be INACTIVE.

Table 2-38 getAppAccountState(spAccountId, appAccountId


Input



Returns

getAppAccountStateReturn

tns1:State Information of the state of the Application Account. See “State” on page 2-51

Possible Exceptions

ACCESS_DENIED

CommonException

Table 2-39 activateAppAccount(spAccountId, appAccountId)


Input



Web Serv i ce


deactivateAppAccountDeactivate an Application Account. Change the state of the account to INACTIVE. The current state of the account must be ACTIVE.

Returns

activateAppAccountReturn void

Possible Exceptions

ACCESS_DENIED

CommonException

INVALID_STATE If the state of the Application Account does not allow the account to be activated, this exception is thrown.

Table 2-40 deactivateAppAccount(spAccountId, appAccountId)


Input



Returns

deactivateAppAccountReturn

void

Possible Exceptions

ACCESS_DENIED

Table 2-39 activateAppAccount(spAccountId, appAccountId)


Operato r Se rv ice


registerAppInstGroupResResponse to a request for registering an Application Instance group for a specific combination of a Service Provider Account and Application Group.

It is possible to approve or disapprove the request. Both cases triggers a state transition for the Application Instance Group. If approved, the Application Instance Group is transferred into state ACTIVE and the application can login and use the traffic interfaces exposed by Network Gatekeeper. If Disapproved, the Application Instance Group is deleted.

CommonException


Table 2-41 registerAppInstGroupRes(spAccountId, appAccountId, appInstGroupId, appInstGroupRef, response)


Input




appInstGroupRef xsd:string Internal ID of the Application Instance Group. This ID is used to correlate the Application Instance Group ID with an Operator-internal ID.

Table 2-40 deactivateAppAccount(spAccountId, appAccountId)


Web Serv i ce


activateAppInstGroupActivate an Application Instance Group. Change the state of the group to ACTIVE.


Returns

registerAppInstGroupResReturn

void

Possible Exceptions

ACCESS_DENIED

CommonException

INVALID_STATE

Table 2-42 activateAppInstGroup(spAccountId, appAccountId, appInstGroupId)


Input




Returns

activateAppInstGroupReturn

void

Table 2-41 registerAppInstGroupRes(spAccountId, appAccountId, appInstGroupId, appInstGroupRef, response)


Operato r Se rv ice


deactivateAppInstGroupDeactivate an Application Instance Group. Change the state of the group to INACTIVE.

Possible Exceptions

ACCESS_DENIED

CommonException

INVALID_STATE

Table 2-43 deactivateAppInstGroup(spAccountId, appAccountId, appInstGroupId)


Input




Returns

deactivateAppInstGroupReturn

void

Possible Exceptions

ACCESS_DENIED

Table 2-42 activateAppInstGroup(spAccountId, appAccountId, appInstGroupId)


Web Serv i ce


registerSpAccountReqRequest to register a Service Provider Account. Contact details is supplied in the request, together with CRM/PRM application-defined properties. This request must be approved by the Operator, see “registerSpAccountRes” on page 2-39,

CommonException

INVALID_STATE If the state of the Application Instance Group does not allow the account to be deactivated, this exception is thrown.

Table 2-44 registerSpAccountReq(spAccountId, spAccount, password)


Input

spAccountId xsd:string The desired ID of the Service Provider Account. The Service Provider will use this ID when logging in to the Service Provider part of the Partner Relationship Management interface, see “login” on page 7-1.

spAccount xsd:string Data structure with details about the Service Provider Account.

password xsd:string The password the Service Provider will use when logging in to the Service Provider part of the Partner Relationship Management interface, see “login” on page 7-1.

Table 2-43 deactivateAppInstGroup(spAccountId, appAccountId, appInstGroupId)


Operato r Se rv ice


listAppAccountsLists all Application Account IDs for a specific Service Provider. The result is filtered on the state of state of the Application Account

Returns

registerSpAccountReqReturn

void

Possible Exceptions

ACCESS_DENIED

CommonException

INVALID_STATE

Table 2-45 listAppAccounts(spAccountId, state)


Input

spAccountId xsd:string The ID of the Service Provider Account. If null, there is no filtering on Service Provider Account ID.

state tns1:State Indicates which states to filter the result on. “State” on page 2-51.

Returns

listAppAccountsReturn Array of tns1:AppAccountRef

Data structure containing references to Application Account Groups. See “AppAccountRef” on page 2-48.



Web Serv i ce


listSpAccountsLists all Service Provider Account IDs. The result is filtered on the state of state of the Service Provider Account

registerSpAccountResResponse to a request for registering a Service Provider Account.

It is possible to approve or disapprove the request. Both cases triggers a state transition for the Service Provider Account. If approved, the Service Provider Account is transferred into state

Possible Exceptions

ACCESS_DENIED

CommonException

Table 2-46 listSpAccounts(state)


Input

state tns1:State Indicates which states to filter the result on. See “State” on page 2-51.

Returns

listAppAccountsReturn Array of xsd:string A list of IDs of the Service Provider Accounts.

Possible Exceptions

ACCESS_DENIED

CommonException

Table 2-45 listAppAccounts(spAccountId, state)


Operato r Se rv ice


ACTIVE and the Service provider can log in and register for accounts for applications using the Network Gatekeeper traffic interfaces. If Disapproved, the Service Provider Account is deleted.

Table 2-47 registerSpAccountRes(spAccountId, spGroupId, spAccountRef, response)


Input


spGroupId xsd:string The ID of the Service Provider Group the Service Provider Account shall be associated with.

spAccountRef xsd:string Internal ID of the Service Provider. This ID is used to correlate the Service Provider ID with an Operator-internal ID.


Returns

registerSpAccountResReturn

void

Possible Exceptions

ACCESS_DENIED

CommonException

INVALID_STATE If the status of the Service Provider Account is not in state REGISTERED, this exception is thrown.

Web Serv i ce


deleteSpAccountReqRequest to delete a Service Provider Account. In order to delete it, the state of the Service Provider Account must be INACTIVE. The request must be approved before the Service Provider Account it is deleted, this is done using “deleteSpAccountRes” on page 2-41,

deleteSpAccountResResponse to a request for deleting a Service Provider Account. The Service Provider Account must be in state DELETE_PENDING in order for this call to be accepted.

It is possible to approve or disapprove the request. Both cases triggers a state transition for the Service Provider Account. If approved, the Service Provider Account is simply deleted. If Disapproved, the Service Provider Account is transferred into state INACTIVE.

Table 2-48 deleteSpAccountReq(spAccountId)


Input

spAccountId xsd:string The ID of the group.

Returns

deleteSpAccountReqReturn

void

Possible Exceptions

ACCESS_DENIED

CommonException If the status of the Service Provider Account is not in state INACTIVE, this exception is thrown.

INVALID_STATE

Operato r Se rv ice


updateSpAccountUpdates a Service Provider Account with new data.

Table 2-49 deleteSpAccountRes(spAccountId, response)


Input



Returns

deleteSpAccountResReturn

void

Possible Exceptions

ACCESS_DENIED

CommonException

INVALID_STATE If the status of the Service Provider Account is not in state INACTIVE, this exception is thrown.

Table 2-50 updateSpAccount(spAccountId, spAccount)


Input


Web Serv i ce


updateSpAccountResResponse to a request for updating a Service Provider Account.

It is possible to approve or disapprove the request. Both cases triggers a state transition for the Service Provider Account to state Active. If approved, the Service Provider Account is updated with the information given by the Service Provider via the Service Provider Interface, see “updateSpAccountReq” on page 8-6.

spAccount tns1:SpAccount Data structure with details on the Service Provider Account, including CRM/PRM application-defined properties in the form of name-value pairs. See “SpAccount” on page 2-50.

Returns

updateSpAccountReturn void

Possible Exceptions

ACCESS_DENIED

CommonException

INVALID_STATE

Table 2-51 updateSpAccountRes(spAccountId, response)


Input




Operato r Se rv ice


getUpdatePendingSpAccountGet details about an specific Service Provider account that is in state UPDATE_PENDING, the details includes contact information and CRM/PRM application-defined properties in the form of name-value pairs.

.


Returns

updateAppInstGroupResReturn

void

Possible Exceptions

ACCESS_DENIED

CommonException


Table 2-52 getUpdatePendingSpAccount(spAccountId)


Input


Returns

Table 2-51 updateSpAccountRes(spAccountId, response)


Web Serv i ce


setSpAccountPasswordSet the password the Service Provider uses to login to use the Partner Relationship Management Interface exposed by Network Gatekeeper.

.

getUpdatePendingSpAccountReturn

tns1:SpAccount Details about contact information and CRM/PRM application-defined properties in the form of name-value pairs. See “SpAccount” on page 2-50.

Possible Exceptions

ACCESS_DENIED

CommonException

INVALID_STATE If the Service Provide r Account is not in state UPDTATE_PENDING this exception is thrown.

Table 2-53 setSpAccountPassword(spAccountId, newPassword)


Input



Returns

setSpAccountPasswordReturn

void

Table 2-52 getUpdatePendingSpAccount(spAccountId)


Operato r Se rv ice


changeOpAccountPasswordChange the password the Operator uses to login to use the Partner Relationship Management Interface exposed by Network Gatekeeper. The Operator Account it the one the Operator is currently logged in as.

Possible Exceptions

ACCESS_DENIED

CommonException

Table 2-54 changeOpAccountPassword(oldPassword, newPassword)


Input

oldPassword xsd:string The password to be changed.


Returns

changeOpAccountPasswordReturn

void

Possible Exceptions

ACCESS_DENIED

CommonException

Table 2-53 setSpAccountPassword(spAccountId, newPassword)


Web Serv i ce


getUserLevelRetrieves the user level of the currently logged in Operator Account. Different user levels have different privileges, and are authorized to different sets of operations.

Exceptions

ACCESS_DENIEDExceptions of this type are raised when the operation is not permitted. The user has not enough privileges to perform the operation.


Table 2-55 changeOpAccountPassword(oldPassword, newPassword)


Input

No input parameters.

Returns

getUserLevelReturn tns1:UserLevel The user level of the currently logged in Operator Account. See “UserLevel” on page 2-51.

Possible Exceptions

ACCESS_DENIED

CommonException

Operato r Se rv ice


Data types

AppAccountDescription of an Application Account.

AppAccountRefReference to IDs of an Application Account.

AppInstGroupRefReference to IDs of an Application Instance Group.

Table 2-56 appAccount

Element name Datatype Description

name xsd:string Descriptive name of the Application Account.

description xsd:string Short description of the Application Account.

properties impl:ArrayOf_tns1_Property

CRM/PRM application-defined name value pairs. See “Property” on page 2-49.

Table 2-57 AppInstGroupRef


spAccountId xsd:string ID of the Service Provider Account associated with the Application Account.

appAccountId xsd:string ID of the Application Account.



spAccountId xsd:string ID of the Service Provider Account associated with the Application Instance Group.

Web Serv i ce


AppGroupContainer for Application-level SLA and CRM/PRM application-defined properties.

AppInstGroupContainer for Application Instance Group SLA and CRM/PRM application-defined properties.

PropertyArray of name-value pairs. This datatype is used in several other datatypes specific for this interface. The properties are accessible from the Service Provider interface and the Operator

appAccountId xsd:string ID of the Application Account associated with the Application Instance Group.

appInstGroupId xsd:string ID of the Application Instance Group.

Table 2-59 AppGroup


sla xsd:string The SLA for the Application Group.

properties mpl:ArrayOf_tns1_Property

CRM/PRM application-defined properties. Name-value pairs. See “Property” on page 2-49.

Table 2-60 AppGroup


name xsd:string Descriptive name of the Application Instance Group.

description xsd:string Short description of the Application Instance Group.

sla xsd:string The SLA for the Application Instance Group.





Operato r Se rv ice


interface, so they can be used for communicating information between the Service Provider and the Operator

RequestResponseEnumeration defining the operator’s response to an request

SpAccountDescription of a Service Provider Account, including contact details.

Table 2-61 Property


name xsd:string Name of the property, with the value defined in Value. Unique with the array.

value xsd:string The data associated with Name.

Table 2-62 RequestResponse


APPROVE xsd:string Used when the operator approves the request.

DISAPPROVE xsd:string Used when the operator disapproves the request.



name xsd:string Name of the Service Provider.

address xsd:string Address of the Service Provider.

eMailAddress xsd:string E-mail address of the Service Provider.

contactPerson xsd:string Contact person at the Service provider.

phoneNumber xsd:string Phone number to the Service Provider.



Web Serv i ce


SpGroupContainer for Service Provider SLA and CRM/PRM application-defined properties.

UserLevelDefining the user level of the currently logged in Operator user. Enumeration.

The user levels reflects the user levels defined for operations and maintenance of Network Gatekeeper. Each operation performed via the Partner Management Interface, results in one or more standard OAM operations. The user level of the currently logged in user must satisfy the user level necessary for each of these operations. If not so, the operation performed through the Partner Management Interface is denied.

StateDefines the state of a Service Provider Account, Service Provider Group, Application Account, Application Group, or Application Instance group. Enumeration.

Table 2-64 SpGroup


sla xsd:string The SLA for the Service Provider.

properties impl:ArrayOf_tns1_Property

CRM/PRM Application-defined properties. Name-value pairs. See “Property” on page 2-49.

Table 2-65 State


UNAUTHORIZED xsd:string The currently logged in user is not authorized to perform any OAM operations.

READ_ONLY xsd:string The currently logged in user is authorized to perform OAM read- or get- operations.

READ_WRITE xsd:string The currently logged in user is ia authorized to perform OAM write- or set- operations.

ADMINISTRATOR xsd:string The currently logged in user is authorized to perform administrator OAM operations tasks

Operato r Se rv ice


See WebLogic Network Gatekeeper Integration Guidelines for Partner Relationship Management for more information about states, and transitions between different states.


Table 2-66 State


REGISTERED xsd:string The account or group is has been registered. The registration request must be responded to by the Service Provider.

ACTIVE xsd:string Normal mode.

INACTIVE No traffic is allowed through the Network Gatekeeper when the account or group is in this state.

UPDATE_PENDING There is a pending update request. The request must be responded to by the Service Provider.

DELETE_PENDING There is a pending delete request on the account or group. The request must be responded to by the Service Provider.

LOCKED Only valid for an Application Instance Group. The group can be locked due to too many consecutive failed login attempts from an application.


C H A P T E R 3

Operator Alarm Utility

Web ServiceThe Operator Alarm Utility Web Service provides an application with functions for displaying alarms from WebLogic Network Gatekeeper.

countAlarmsCounts the number of alarms of a certain type of a given severity for a specified time interval

Table 3-1 countAlarms(alarmId, severity, fromDate, toDate)


Input

alarmId xsd:int The ID of the type of alarm.

severity tns1:AlarmSeverity Severity of the alarm. See “AlarmSeverity” on page 3-4. Use null in order to not to filter on this parameter.

fromDate xsd:dateTime From the date and time. Use null in order to not to filter on this parameter.

Operato r A la rm Ut i l i t y


listAlarmsRetrieve all alarms matching the given criteria

toDate xsd:dateTime To the date and time. Use null in order to not to filter on this parameter.

Returns

countAlarmsReturn xsd:long The number of alarms.

Possible Exceptions

ACCESS_DENIED

CommonException

Table 3-2 listAlarms(alarmId, severity, fromDate, toDate, startIndex, maxEntries)


Input

alarmId xsd:int The ID of the type of alarm.

severity tns1:AlarmSeverity Severity of the alarm. See “AlarmSeverity” on page 3-4. Use null in order to not to filter on this parameter.

fromDate xsd:dateTime From date and time.Use null in order to not to filter on this parameter.

toDate xsd:dateTime To date and time. Use null in order to not to filter on this parameter.

Table 3-1 countAlarms(alarmId, severity, fromDate, toDate)


Web Serv i ce


Exceptions


Data types

AlarmInfoData structure defining an alarm.

startIndex xsd:long Which entry, in the overall result set, to start the result list on (cursor).

maxEntries xsd:int The maximum number of alarms returned.

Returns

listAlarmsReturn Array of tns1:AlarmInfo List of alarms. See “AlarmInfo” on page 3-3.

Possible Exceptions

ACCESS_DENIED

CommonException

Table 3-3 AlarmInfo


alarmInstanceId xsd:long The ID of the emitted alarm. Unique identifier for an emitted alarm.

alarmId xsd:int The identifier for the alarm type. See the User’s Guide for a description of all alarm IDs.

Table 3-2 listAlarms(alarmId, severity, fromDate, toDate, startIndex, maxEntries)


Operato r A la rm Ut i l i t y


AlarmSeverityDefine the severity of an alarm. Enumeration


source xsd:string Specifies the name of the SLEE service name (software module) that raised the alarm and the IP address of the SLEE the service is installed in.

severity tns1:AlarmSeverity Specifies the alarm’s severity level. See “AlarmSeverity” on page 3-4.

timeStamp xsd:dateTime Specifies the time and date the alarm was raised.

info xsd:string Alarm information provided by the software module the raised the alarm.

Table 3-4 AlarmSeverity


WARNING xsd:string Severity level is Warning.

MINOR xsd:string Severity level is Minor.

MAJOR xsd:string Severity level is Major.

CRITICAL xsd:string Severity level is Critical.

Table 3-3 AlarmInfo



C H A P T E R 4

Operator CDR Utility

Web ServiceThe Operator CDR Utility Web Service provides an application with functions for retrieving CDRs from WebLogic Network Gatekeeper.

countCdrsCounts the number of CDRs for a certain Service for a specified time interval

Table 4-1 countCdrs(serviceName, fromDate, toDate, completionStatus, spAccountId, appAccountId)


Input

serviceName xsd:string The SLEE name of the service capability for which to retrieve CDRs. See WebLogic Network Gatekeeper User’s Guide for the SLEE names.

Use empty string to if not to filter on this value.

fromDate xsd:dateTime From date and time. Use null in order to not to filter on this parameter.

Operato r CDR Ut i l i t y



completionStatus tns1:CdrCompletionStatus Completion status of the CDR. See “CdrCompletionStatus” on page 4-5.

spAccountId xsd:string ID of the Service Provider Account to filter the result on.

Use null in order to not to filter on this parameter.

appAccountId xsd:string ID of the Application Account to filter the result on.

Use null in order to not to filter on this parameter.

Returns

countCdrsReturn xsd:long The number of CDRs matching the given criteria.

Possible Exceptions

ACCESS_DENIED

CommonException

Table 4-1 countCdrs(serviceName, fromDate, toDate, completionStatus, spAccountId, appAccountId)


Web Serv i ce


listCdrsRetrieve all CDRs matching the given criteria.

Table 4-2 listCdrs(serviceName, fromDate, toDate, completionStatus, spAccountId, appAccountId, startIndex, maxEntries)


Input

serviceName xsd:string The SLEE name of the service capability for which to retrieve CDRs. Use null in order to not to filter on this parameter.



completionStatus tns1:CdrCompletionStatus Completion status of the CDR.See “CdrCompletionStatus” on page 4-5. Use null in order to not to filter on this parameter.

spAccountId xsd:string ID of the Service Provider Account to filter the result on. Use null in order to not to filter on this parameter.

appAccountId xsd:string ID of the Application Account to filter the result on. Use null in order to not to filter on this parameter.




Exceptions


Data types

CdrInfoData structure defining a CDR. All services that produce charging data do not use all fields, and they use the fields slightly different, depending on the type of the service. See the Product Description for WebLogic Network Gatekeeper for details of which fields that are relevant for the different services.


Returns

listCdrsReturn Array of tns1:CdrInfo List of CDRS. See “CdrInfo” on page 4-4.

Possible Exceptions

ACCESS_DENIED

CommonException

Table 4-2 listCdrs(serviceName, fromDate, toDate, completionStatus, spAccountId, appAccountId, startIndex, maxEntries)


Web Serv i ce


CdrCompletionStatusDefine the completion status of a CDR. Enumeration

Table 4-3 CdrInfo


transactionId xsd:long A unique ID for the transaction.

serviceName xsd:string The service capability module that has created the CDR.

timeStamp xsd:dateTime Specifies the name of the SLEE service name (software module) that raised the alarm and the IP address of the SLEE the service is installed in.

origAddr xsd:string The address of the originating party.

destAddr xsd:string The address of the destination party.

spAccountId xsd:string The ID of the Service Provider that generated the CDR.

appAccountId xsd:string The ID of the Application Account that generated the CDR.

completionStatus tns1:CdrCompletionStatus

Completion status of the CDR. See “CdrCompletionStatus” on page 4-5.

info xsd:string Additional info provided by the service capability module.

additionalProperties

impl:ArrayOf_tns1_Property

Application defined data. See “Property” on page 4-6.



COMPLETED xsd:string The CDR is complete. The operation generating the CDR succeed.

FAILED xsd:string The CDR is failed. The operation generating the CDR failed.



PropertyArray of name-value pairs.


PARTIAL xsd:string Depends on which service capability that created the CDR. See WebLogic Network Gatekeeper Product Description for details.

COMPLETED_NOTIFICATION_FAILED

xsd:string The CDR is completed, but the notification towards the application failed.

POLICY_DENIED

xsd:string Policy denied the operation.

Table 4-5 Property


Name xsd:string Name of the property, with the value defined in Value. Unique with the array.

Value xsd:string The data associated with Name.




C H A P T E R 5

Operator Statistics Utility

Web ServiceThe Operator Statistics Utility Web Service provides an application with functions for retrieving statistics from WebLogic Network Gatekeeper.

listStatisticTypesList the statistics type registered in WebLogic Network Gatekeeper.l

Table 5-1 listStatisticTypes()


Input


Returns

listStatisticTypesReturn Array of tns1:StatisticTypeDescriptor

Descriptions of available statistics types.

See “StatisticTypeDescriptor” on page 5-4.

Possible Exceptions

Operato r S ta t is t i cs Ut i l i t y


getStatisticsRetrieve statistics matching the given criteria.

ACCESS_DENIED

CommonException

Table 5-2 getStatistics(statisticType, fromDate, toDate, spAccountId, appAccountId)


Input

statisticType xsd:int Number representing the type of statistics to retrieve.

fromDate xsd:dateTime From date and time.

Use null value if not to filter on this value.

toDate xsd:dateTime To date and time.

Use null value if not to filter on this value.

spAccountId xsd:string ID of the Service Provider Account to filter the result on.


appAccountId xsd:string ID of the Application Account to filter the result on.


Returns



Web Serv i ce


Exceptions


Data types

StatisticsInfoData structure defining a statistics record. All services that produce statistics do not use all fields, and they use the fields slightly different, depending on the type of the service. See the Product Description for the WebLogic Network Gatekeeper for details of which fields that are relevant for the different services.

getStatisticsReturn Array of tns1:StatisticsInfo Statistics. See “StatisticsInfo” on page 5-3.

Possible Exceptions

ACCESS_DENIED

CommonException

Table 5-3 StatisticsInfo


statisticsType xsd:string The statistics type. See WebLogic Product Description for information on available statistics types.

timeStampStart xsd:dateTime The starting time of the interval during which the statistics were gathered.



Operato r S ta t is t i cs Ut i l i t y


StatisticTypeDescriptorDefines the type of statistics.


timeStampEnd xsd:dateTime The end time of the interval during which the statistics were gathered.

numberOfTransactions

xsd:int The number of transactions during the interval.

spAccountId xsd:string The ID of the Service Provider that generated the statistics.

appAccountId xsd:string The ID of the Application Account that generated the statistics.



transactionTypeName

xsd:string Name of a transaction type that statistics can be generated for.

transactionTypeId xsd:int Numeric ID of the transaction type.




C H A P T E R 6

Operator Messaging Management Utility

Web ServiceThe Operator Messaging Management Utility Web Service provides an application with functions for creation and handling of mailboxes and mailbox translations. For information about mailboxes and mailbox translations, see WebLogic Network Gatekeeper Product Description.

listMailboxesList defined mailboxes that are assigned to a given Service Provider and Application Account.l

Table 6-1 listMailboxes(spAccountId, appAccountId)


Input

spAccountId xsd:string ID of the Service Provider Account.


Returns

listMailboxesReturn Array of xsd:string A list of IDs of mailboxes.

Possible Exceptions

Operato r Messag ing Management Ut i l i t y


createMailboxCreate a new mailbox for an application..

ACCESS_DENIED

CommonException

Table 6-2 createMailbox(SpAccountId, appAccountId, mailbox, mailboxPassword)


Input

SpAccountId xsd:string ID of the Service Provider Account.


mailbox xsd:string ID of the mailbox.

mailboxPassword xsd:string Password associated with the mailbox.

Returns

createMailboxReturn Void

Possible Exceptions

ACCESS_DENIED

CommonException

Table 6-1 listMailboxes(spAccountId, appAccountId)


Web Serv i ce


removeMailboxRemoves a mailbox.

addMailboxTranslationSpecifies a destination address short code and message prefix for a mailbox..

Table 6-3 removeMailbox(mailbox)


Input

mailbox xsd:string ID of the mailbox.

Returns

removeMailboxReturn Void

Possible Exceptions

ACCESS_DENIED

CommonException

Table 6-4 addMailboxTranslation(destAddr, msgPrefix, mailbox)


Input

destAddr xsd:string The destination address short code to be use instead of the real mailbox address.



deleteMailboxTranslationDeletes a mailbox translation.

msgPrefix xsd:string The keyword to be entered in the beginning of the message. The message prefix is case sensitive. If left empty, this mailbox will be the default mailbox for the destination address short code. That is, it will be used for messages that does not start with a valid message prefix.

mailbox ID of the mailbox.

Returns

addMailboxTranslationReturn

Void

Possible Exceptions

ACCESS_DENIED

CommonException



Input

destAddr xsd:string The destination address in the mailbox translation.

msgPrefix xsd:string The keyword in the mailbox translation.

Table 6-4 addMailboxTranslation(destAddr, msgPrefix, mailbox)


Web Serv i ce


listMailboxTranslationsLists all mailbox translations defined in the Network Gatekeeper..

Returns

deleteMailboxTranslationReturn

Void

Possible Exceptions

ACCESS_DENIED

CommonException

Table 6-6 listMailboxTranslations()


Input

No input parameters

Returns

listMailboxTranslationsReturn

Array of tns1:MailboxTranslation

List of mailbox translations. See “MailboxTranslation” on page 6-7.

Possible Exceptions

ACCESS_DENIED

CommonException





listMailboxTranslationsForAddressLists all mailbox translations defined for a given address..

Exceptions


NO_TRANSLATIONThis exception is raised when there is no mailbox translation available.

Table 6-7 listMailboxTranslationsForAddress(address)


Input

address xsd:string The address, shortcode or fully qualified number, to list translation for.

Returns

listMailboxTranslationsForAddressReturn

tns1:MailboxTranslation List of mailbox translations for a specific address. See “MailboxTranslation” on page 6-7.

Possible Exceptions

ACCESS_DENIED

CommonException

NO_TRANSLATION



Data types

MailboxTranslationData structure defining a mailbox translation.

MailboxPrefixTranslationData structure defining a keyword, or message prefix and the mailbox corresponding to the keyword


Table 6-8 MailboxTranslation


destAddr xsd:string The address, shortcode or fully qualified number.

defaultMailbox xsd:string The mailbox to distribute any incoming message to, if the keyword in the message does not match any of the defined.

prefixTranslations Array of tns1:MailboxPrefixTranslation

A set of mailbox prefix translations. See “MailboxPrefixTranslation” on page 6-7.

Table 6-9 MailboxPrefixTranslation


msgPrefix xsd:string Prefix, or keyword, of a message. The keyword is case sensitive.

mailbox xsd:string The mailbox corresponding to the keyword.




C H A P T E R 7

Service Provider Login

Web ServiceThe Service Provider Login Web Service provides an application with functions for logging in to the Partner Relationship Management module in WebLogic Network Gatekeeper.

When an application session has been created, a loginTicket is returned. This loginTicket is used to identify the login session.

loginUsed by an application to login and retrieve a loginTicket that servers as an identifier when the Service Provider interface is used.

Table 7-1 String login(spAccountId, password)


Input

spAccountId xsd:string The ID of Service provider Account. See “registerSpAccountReq” on page 7-3 for information on how to request a Service Provider Account.

Se rv i ce P rov ider Log in


logoutUsed by an application to logout.This method call destroys the login session and the corresponding loginTicket

password xsd:string The password associated with the Service Provider login account.

Returns

loginReturn xsd:string Returns a loginTicket used to identify the login session. This ticket shall be supplied in the SOAP header for each method invocation.

Possible Exceptions

ACCESS_DENIED

CommonException



Input

loginTicket xsd:string The loginTicket retrieved when logging in.

Returns

logoutReturn void

Possible Exceptions

Table 7-1 String login(spAccountId, password)


Web Serv i ce


registerSpAccountReqRequest to register a new Service Provider Account. When this request has been approved by the Operator, see “registerSpAccountRes” on page 2-39, the Service Provider can log in to the Partner Relationship Management module, see “login” on page 7-1.

ACCESS_DENIED

CommonException



Input

spAccountId xsd:string The desired ID the Service Provider Account.

spAccount tns1:SpAccount Data structure with details on the Service Provider account. See “SpAccount” on page 7-4.

password xsd:string The password associated with the Service Provider login account.

Returns

registerSpAccountReqReturn

void

Possible Exceptions

ACCESS_DENIED

CommonException





Exceptions


Complex data types


PropertyArray of name-value pairs. This datatype is used in several other datatypes specific for this interface. The properties are accessible from the Service Provider interface and the Operator



Name xsd:string Name of the Service Provider.

Address xsd:string Address of the Service Provider.

EMailAddress xsd:string E-mail address of the Service Provider.

ContactPerson xsd:string Contact person at the Service provider.

PhoneNumber xsd:string Phone number to the Service Provider.

Properties mpl:ArrayOf_tns1_Property




interface, so they can be used for communicating information between the Service Provider and the Operator


Table 7-5 Property







C H A P T E R 8

Service Provider Service

Web ServiceThe Service Provider Service Web Service provides an application with functions for handling Service Provider Accounts, Application Accounts, and Applications Instance groups.

To use this interface, the application must have logged in and retrieved a loginTicket using the Service Provider Login Web Service, see “login” on page 7-1.

deleteSpAccountReqRequest to delete the Service Provider Account. In order to delete it, the state of the Service Provider Account must be INACTIVE. The request must be approved before the Service Provider Account it is deleted, this is done using “deleteSpAccountRes” on page 2-41,

Table 8-1 deleteSpAccountReq()


Input


Returns

deleteSpAccountReqReturn

void

Possible Exceptions

Se rv i ce P rov ider Se rv ice


deactivateSpAccountDeactivate the Service Provider Account. Change the state of the account to INACTIVE.

ACCESS_DENIED

CommonException


Table 8-2 deactivateSpAccount()


Input

No input parameters

Returns

deactivateSpAccountReturn

void

Possible Exceptions

ACCESS_DENIED

CommonException

INVALID_STATE If the state of the Service Provider Account does not allow the account to be deactivated, this exception is thrown.

Table 8-1 deleteSpAccountReq()


Web Serv i ce


activateSpAccountActivate the Service Provider Account. Change the state of the account to ACTIVE.

getSpAccountRetrieves details about the Service Provider Account. The details includes contact details and CRM/PRM application-defined properties in the form of name-value pairs.

Table 8-3 activateSpAccount()


Input


Returns

activateSpAccountReturn void

Possible Exceptions

ACCESS_DENIED

CommonException

INVALID_STATE If the state of the Service Provider Account does not allow the account to be activated, this exception is thrown.

Table 8-4 getSpAccount()


Input


Returns



getSpAccountStateRetrieves the state of the Service Provider Account.

getSpAccountReturn tns1:SpAccount Data structure with details on the Service Provider account. See “SpAccount” on page 8-24.

Possible Exceptions

ACCESS_DENIED

CommonException

Table 8-5 getSpAccountState()


Input


Returns

getSpAccountStateReturn tns1:State Information of the state of the Service Provider Account. See “State” on page 8-25.

Possible Exceptions

ACCESS_DENIED

CommonException

Table 8-4 getSpAccount()


Web Serv i ce


registerAppAccountReqRequest to register an Application Account for the Service Provider Account. This request must be approved by the Operator, see “registerAppAccountRes” on page 2-25.

deleteAppAccountReqRequest to delete an Application Account associated with the Service Provider. The request must be approved by the Operator before the Application Account is deleted, this is done using

Table 8-6 registerAppAccountReq(appAccountId, app)


Input


app tns1:AppAccount Data structure with details on the Application Account, including CRM/PRM application-defined properties in the form of name-value pairs. See “AppAccount” on page 8-23.

Returns


void

Possible Exceptions

ACCESS_DENIED

CommonException

INVALID_STATE



“deleteAppAccountRes” on page 2-29. The Application Account must be in state INACTIVE in order for this call to be accepted.

updateSpAccountReqRequest to update the Service Provider Account with new data.

Table 8-7 deleteAppAccountReq(appAccountId)


Input


Returns

deleteAppAccountReqReturn

void

Possible Exceptions

ACCESS_DENIED

CommonException

INVALID_STATE



Input

spAccount tns1:SpAccount Data structure with details on the Service Provider Account, including CRM/PRM application-defined properties in the form of name-value pairs. See “SpAccount” on page 8-24.

Returns

Web Serv i ce


updateAppAccountReqRequest to update an Application Account associated with the Service Provider with new data.

updateSpAccountReturn void

Possible Exceptions

ACCESS_DENIED

CommonException

INVALID_STATE

Table 8-9 updateAppAccount(appAccountId, appAccount)


Input


app tns1:AppAccount Data structure with details on the Application Account, including CRM/PRM application-defined properties in the form of name-value pairs. See “AppAccount” on page 8-23.

Returns

updateAppAccountReturn void

Possible Exceptions

ACCESS_DENIED





updateAppInstGroupReqRequest to update an Application Instance Group with new SLA data. The request must be approved by the Operator. See “updateAppInstGroupRes” on page 2-17.

CommonException

INVALID_STATE

Table 8-10 updateAppInstGroup(appAccountId, appInstGroupId, appInstGroup)


Input



appInstGroup tns1:AppInstGroup Data-structure with the Application Instance Group SLA and CRM/PRM application-defined properties in the form of name-value pairs. See “AppInstGroup” on page 8-24.

Returns

updateAppInstGroupReturn

void

Possible Exceptions

ACCESS_DENIED

Table 8-9 updateAppAccount(appAccountId, appAccount)


Web Serv i ce


deleteAppInstGroupReqRequest to deletes an Application Instance Group. The request must be approved by the Operator. This is done using “deleteAppInstGroupRes” on page 2-15,

CommonException

INVALID_STATE

Table 8-11 deleteAppInstGroupReq(appAccountId, appInstGroupId)


Input



Returns


void

Possible Exceptions

ACCESS_DENIED


INVALID_STATE

Table 8-10 updateAppInstGroup(appAccountId, appInstGroupId, appInstGroup)




listAppAccountsLists all Application Account IDs for the Service Provider. The result is filtered on the state of state of the Application Account

getAppAccountRetrieves details about a specific Application Account. The operation returns a data structure with details on the Application Account, including CRM/PRM application-defined properties in the form of name-value pairs.

Table 8-12 listAppAccounts(state)


Input

state tns1:State Indicates which states to filter the result on. “State” on page 8-25.

Returns

listAppAccountsReturn Array of xsd:string A list of IDs of Application Accounts.

Possible Exceptions

ACCESS_DENIED

CommonException

Table 8-13 getAppAccount(appAccountId)


Input


Returns

Web Serv i ce


getAppAccountStateRetrieves the state of a specific Application Account.

getAppAccountReturn tns1:AppAccount Data structure with details about the Application Account. See “AppAccount” on page 8-23.

Possible Exceptions

ACCESS_DENIED

CommonException

Table 8-14 getAppAccountState(appAccountId


Input


Returns

getAppAccountStateReturn

tns1:State Information of the state of the Application Account. See “State” on page 8-25

Possible Exceptions

ACCESS_DENIED

CommonException

Table 8-13 getAppAccount(appAccountId)




activateAppAccountActivate an Application Account. Change the state of the account to ACTIVE. The current state of the account must be INACTIVE.

deactivateAppAccountDeactivate an Application Account. Change the state of the account to INACTIVE. The current state of the account must be ACTIVE.

Table 8-15 activateAppAccount(appAccountId)


Input


Returns

activateAppAccountReturn void

Possible Exceptions

ACCESS_DENIED

CommonException


Table 8-16 deactivateAppAccount(appAccountId)


Input


Returns

Web Serv i ce


activateAppInstGroupActivate an Application Instance Group. Change the state of the group to ACTIVE.

deactivateAppAccountReturn

void

Possible Exceptions

ACCESS_DENIED

CommonException


Table 8-17 activateAppInstGroup(appAccountId, appInstGroupId)


Input



Returns

activateAppInstGroupReturn

void

Possible Exceptions

ACCESS_DENIED

Table 8-16 deactivateAppAccount(appAccountId)




getAppInstGroupStateGet the state of an Application Instance Group.

CommonException

INVALID_STATE If the state of the Application Instance Group does not allow the account to be activated, this exception is thrown.

Table 8-18 getAppInstGroupState(appAccountId, appInstGroupId)


Input



Returns

getAppInstGroupStateReturn

tns1:State The state of the Application Instance Group. See “State” on page 8-25.

Possible Exceptions

ACCESS_DENIED

CommonException

Table 8-17 activateAppInstGroup(appAccountId, appInstGroupId)


Web Serv i ce



registerAppInstGroupReqRequest to register an Application Instance Group for a specific Application Account. When this request has been approved by the Operator, see “registerAppInstGroupRes” on page 2-34, an

Table 8-19 deactivateAppInstGroup(appAccountId, appInstGroupId)


Input



Returns


void

Possible Exceptions

ACCESS_DENIED

CommonException




application has all login credentials necessary to log in to the traffic interfaces of the Network Gatekeeper.

Table 8-20 registerAppInstGroupReq(appAccountId, appInstGroupId, appInstGroup, password)


Input



appInstGroup tns1:AppInstGroup The Application Instance Group-level SLA, and CRM/PRM application-defined properties in the form of name-value pairs. See “AppInstGroup” on page 8-24.

password xsd:string The password the application will use when logging in to the Network Gatekeeper

Returns


void

Possible Exceptions

ACCESS_DENIED

CommonException

INVALID_STATE

Web Serv i ce



Table 8-21 deactivateAppInstGroup(appAccountId, appInstGroupId)


Input



Returns


void

Possible Exceptions

ACCESS_DENIED

CommonException




registerAppInstGroupReqRequest to register an Application Instance Group for an Application Account. When this request has been approved by the Operator, see “registerAppInstGroupRes” on page 2-34, an application has all login credentials necessary to log in to the traffic interfaces of the Network Gatekeeper.

Table 8-22 registerAppInstGroupReq(appAccountId, appInstGroupId, appInstGroup, password)


Input



appInstGroup tns1:AppInstGroup The Application Instance Group-level SLA, and CRM/PRM application-defined properties in the form of name-value pairs. See “AppInstGroup” on page 8-24.

password xsd:string The password the application will use when logging in to the Network Gatekeeper

Returns


void

Possible Exceptions

ACCESS_DENIED

CommonException

INVALID_STATE

Web Serv i ce


listAppInstGroupsLists all Application Instance groups for an Application Account. Filtering is possible on the state of the Application Instance Group

getAppInstGroupRetrieves details about a specific Application Instance Group.

Table 8-23 listAppInstGroups(appAccountId, state)


Input


state tns1:State Indicates which states to filter the result on. See “State” on page 8-25

Returns

listAppInstGroupsReturn Array of xsd:string A list of all Service Application Instance Group IDs matching the given criteria.

Possible Exceptions

ACCESS_DENIED

CommonException

Table 8-24 getAppInstGroup(appAccountId, appInstGroupId)


Input




getSpAccountSlaRetrieves the Service Provider SLA.


Returns

getAppInstGroupReturn tns1:AppInstGroup Data structure with details about the Application Instance Group. See “AppInstGroup” on page 8-24.

Possible Exceptions

ACCESS_DENIED

CommonException

Table 8-25 getSpAccountSla()


Input


Returns

getSpAccountSlaReturn xsd:string The Service Provider SLA.

Possible Exceptions

ACCESS_DENIED

CommonException

Table 8-24 getAppInstGroup(appAccountId, appInstGroupId)


Web Serv i ce


getAppAccountSlaRetrieves the Application-level SLA.

setAppInstGroupPasswordSet the password associated with an Application Instance Group. This password is a part of the login credentials an application use to login and use the traffic interfaces exposed by Network Gatekeeper.

.

Table 8-26 getAppAccountSla(appAccountId)


Input

appAccountId xsd:string The Application Account to retrieve the SLA for.

Returns

getAppAccountSlaReturn xsd:string The application-level SLA.

Possible Exceptions

ACCESS_DENIED

CommonException

Table 8-27 setAppInstGroupPassword(appAccountId, appInstGroupId, newPassword)


Input






changeSpAccountPasswordChange the Service provider Account password. This password is the password the Service Provider use to login to the Service Provider part of the Partner Management Interfaces exposed by Network Gatekeeper.

.

Returns

setAppInstGroupPasswordReturn

void

Possible Exceptions

ACCESS_DENIED

CommonException

Table 8-28 changeSpAccountPassword(oldPassword, newPassword


Input

oldPassword xsd:string The current password.


Returns

changeSpAccountPasswordReturn

void

Possible Exceptions

ACCESS_DENIED

CommonException

Table 8-27 setAppInstGroupPassword(appAccountId, appInstGroupId, newPassword)


Web Serv i ce


Exceptions

ACCESS_DENIEDExceptions of this type are raised when the operation is not permited. The user has not enough privileges to perform the operation.


INVALID_STATEThe operation is not valid since the operation results in a state transition, and the transition from the current state to the state the operation results in is not allowed.

Data types

AppAccountDescription of an Application Account.



Name xsd:string Descriptive name of the Application Account.

Description xsd:string Short description of the Application Account.

Properties impl:ArrayOf_tns1_Property




AppInstGroupContainer for Application Instance Group SLA and CRM/PRM application-defined properties.

PropertyArray of name-value pairs. This datatype is used in several other datatypes specific for this interface. The properties are accessible from the Service Provider interface and the Operator interface, so they can be used for communicating information between the Service Provider and the Operator


Table 8-30 AppGroup


Name xsd:string Descriptive name of the Application Instance Group.

Description xsd:string Short description of the Application Instance Group.

SLA xsd:string The SLA for the Application Instance Group.



Table 8-31 Property






Name xsd:string Name of the Service Provider.

Address xsd:string Address of the Service Provider.

Web Serv i ce


StateDefines the state of a Service Provider Account, Service Provider Group, Application Account, Application Group, or Application Instance group. Enumeration.

See WebLogic Network Gatekeeper Integration Guidelines for Partner Relationship Management for more information about states, and transitions between different states.

EMailAddress xsd:string E-mail address of the Service Provider.

ContactPerson xsd:string Contact person at the Service provider.

PhoneNumber xsd:string Phone number to the Service Provider.



Table 8-33 State


REGISTERED xsd:string The account or group is has been registered. The registration request must be responded to by the Service Provider.

ACTIVE xsd:string Normal mode.

INACTIVE No traffic is allowed through the Network Gatekeeper when the account or group is in this state.

UPDATE_PENDING There is a pending update request. The request must be responded to by the Service Provider.

DELETE_PENDING There is a pending delete request on the account or group. The request must be responded to by the Service Provider.

LOCKED Only valid for an Applicator Instance Group. The group can be locked due to too many consecutive failed login attempts from an application.







C H A P T E R 9

Service Provider CDR Utility

Web ServiceThe Service Provider Utility Web Service provides an application with functions for retrieving CDRs generated by the Service Provider from WebLogic Network Gatekeeper.

countCdrsCounts the number of CDRs for a certain Service for a specified time interval

Table 9-1 countCdrs(serviceName, fromDate, toDate, completionStatus, appAccountId)


Input




Se rv i ce P rov ide r CDR Ut i l i t y


listCdrsRetrieve all CDRs matching the given criteria.

completionStatus tns1:CdrCompletionStatus Completion status of the CDR. See “CdrCompletionStatus” on page 9-5. Use null in order to not to filter on this parameter.


Returns

countCdrsReturn xsd:long The number of CDRs matching the given criteria.

Possible Exceptions

ACCESS_DENIED

CommonException

Table 9-2 listCdrs(serviceName, fromDate, toDate, completionStatus, appAccountId, startIndex, maxEntries)


Input


Table 9-1 countCdrs(serviceName, fromDate, toDate, completionStatus, appAccountId)


Web Serv i ce




completionStatus tns1:CdrCompletionStatus Completion status of the CDR.See “CdrCompletionStatus” on page 9-5. Use null in order to not to filter on this parameter.




Returns

listCdrsReturn Array of tns1:CdrInfo List of CDRS. See “CdrInfo” on page 9-4.

Possible Exceptions

ACCESS_DENIED

CommonException

Table 9-2 listCdrs(serviceName, fromDate, toDate, completionStatus, appAccountId, startIndex, maxEntries)




Exceptions


Data types

CdrInfoData structure defining a CDR. All services that produce charging data do not use all fields, and they use the fields slightly different, depending on the type of the service. See the Product Description for the WebLogic Network Gatekeeper for details of which fields that are relevant for the different services.

Table 9-3 AlarmInfo


transactionId xsd:long A unique ID for the transaction.

serviceName xsd:string The service capability module that has created the CDR.

timeStamp xsd:dateTime Specifies the name of the SLEE service name (software module) that raised the alarm and the IP address of the SLEE the service is installed in.

origAddr xsd:string The address of the originating party.

destAddr xsd:string The address of the destination party.

spAccountD xsd:string The ID of the Service Provider that generated the CDR.

appAccountID xsd:string The ID of the Application Account that generated the CDR.

completionStatus tns1:CdrCompletionStatus

Completion status of the CDR. See “CdrCompletionStatus” on page 9-5.

info xsd:string Additional info provided by the service capability module.

additionalProperties

impl:ArrayOf_tns1_Property

Application defined data. See “Property” on page 9-5.



CdrCompletionStatusDefine the completion status of a CDR. Enumeration

PropertyArray of name-value pairs.


Table 9-4 CdrCompletionStatus


COMPLETED xsd:string The CDR is complete. The operation generating the CDR succeeded.

FAILED xsd:string The CDR is failed. The operation generating the CDR failed.

PARTIAL xsd:string Depends on which service capability that created the CDR. See WebLogic Network Gatekeeper Product Description for details.

COMPLETED_NOTIFICATION_FAILED

xsd:string The CDR is completed, but the notification towards the application failed.

POLICY_DENIED

xsd:string Policy denied the operation.

Table 9-5 Property







C H A P T E R 10

Service Provider Statistics Utility

Web ServiceThe Service Provider Statistics Utility Web Service provides an application with functions for retrieving statistics generated by the Service Provider from WebLogic Network Gatekeeper.

listStatisticTypesList the statistics type registered in WebLogic Network Gatekeeper.l



Input


Returns

listStatisticTypesReturn Array of tns1:StatisticTypeDescriptor

Descriptions of available statistics types.

See “StatisticTypeDescriptor” on page 10-4.

Possible Exceptions

Se rv i ce P rov ider S tat i s t i cs Ut i l i t y


getStatisticsRetrieve statistics matching the given criteria.

ACCESS_DENIED

CommonException



Input

statisticType xsd:int Number representing the type of statistics to retrieve. Use null in order to not to filter on this parameter.




Returns

getStatisticsReturn Array of tns1:StatisticsInfo Statistics. See “StatisticsInfo” on page 10-3.

Possible Exceptions

CommonException



Web Serv i ce


Exceptions


Data types

StatisticsInfoData structure defining a statistics record. All services that produce statistics do not use all fields, and they use the fields slightly different, depending on the type of the service. See the Product Description for the WebLogic Network Gatekeeper for details of which fields that are relevant for the different services.



statisticsType xsd:string The statistics type. See WebLogic Product Description for information on available statistics types.

timeStampStart xsd:dateTime The starting time of the interval during which the statistics were gathered.

timeStampEnd xsd:dateTime The end time of the interval during which the statistics were gathered.

numberOfTransactions

xsd:int The number of transactions during the interval.

spAccountD xsd:string The ID of the Service Provider that generated the statistics.

appAccountID xsd:string The ID of the Application Account that generated the statistics.

Se rv i ce P rov ider S tat i s t i cs Ut i l i t y


StatisticTypeDescriptorHolds a description for each type of statistics.


Table 10-4 StatisticTypeDescriptor


transactionTypeName

xsd:string Name of a transaction type that statistics can be generated for.

transactionTypeID xsd:int Numeric ID of the transaction type.


C H A P T E R 11

Service Provider Messaging Management Utility

Web ServiceThe Service Provider Messaging Management Utility Web Service provides an application with the ability to view which mailboxes that are assigned to the logged in service provider. For information about mailboxes, see WebLogic Network Gatekeeper Product Description.

listMailboxesList mailboxes that are assigned to a the Service Provider.l

Table 11-1 listMailboxes(applicationID)


Input

applicationID xsd:string ID of the Application Account.

Returns

listMailboxesReturn Array of xsd:string A list of IDs of mailboxes.

Possible Exceptions

ACCESS_DENIED

CommonException

Se rv i ce P rov ider Messag ing Management Ut i l i t y


Exceptions


Data typesThere are no data types specified specifically for this interface.


BEAWebLogic Network Gatekeeper · Send us e-mail at [email protected] if you have questions or comments. Your comments will be reviewed directly by the BEA professionals who create

Documents