31 Understanding the Extended Web Services Common Definitions

This chapter describes the Oracle Communications Services Gatekeeper definitions that the Extended Web Services share.

Namespace

The namespace for the common data types is:

  • http://www.bea.com/wlcp/wlng/schema/ews/common

The namespace for the common faults is:

  • http://www.bea.com/wlcp/wlng/wsdl/ews/common/faults

XML Schema Datatype Definition

This section explains the XML schema datatype definition.

AdditionalProperty Structure

Defines a name-value pair.

Table 31-1 AdditionalProperty Structure

Element Name Element type Optional Description

name

xsd:string

Y

Name part.

value

xsd:string

Y

Value part.

ChargingInformation structure

For services that include charging as an inline message part, the charging information is provided in this data structure.

Table 31-2 ChargingInformation Structure

Element Name Element type Optional Description

description

xsd:string

N

Description text to be use for information and billing text.

currency

xsd:string

Y

Currency identifier as defined in ISO 4217.

amount

xsd:decimal

Y

Amount to be charged.

code

xsd:string

Y

Charging code, referencing a contract under which the charge is applied.

SimpleReference structure

For those services that require a reference to a Web service, the information required to create the endpoint information is provided in this data structure.

Table 31-3 SimpleReference Structure

Element Name Element type Optional Description

endpoint

xsd:anyURI

N

Description text to be use for information and billing text.

interfaceName

xsd:string

Y

Name of interface.

correlator

xsd:decimal

Y

Correlation information.

Fault Definitions

This section explains the fault definitions.

ServiceException

Faults related to the operation of the service, not including policy related faults, result in the return of a ServiceException message.

Table 31-4 ServiceException

Element Name Element type Optional Description

messageId

xsd:string

N

Message identifier, with prefix SVC.

text

xsd:string

N

Message text, with replacement variables marked with %#

variables

xsd:string [0...unbounded]

Y

Variables to substitute into text string.

Service exceptions are related to the operation of the service itself. The following exceptions are general:

  • SVC0001: Service error

  • SVC0002: Invalid input value

  • SVC0003: Invalid input value with list of valid values

  • SVC0004: No valid addresses

  • SVC0005: Duplicate correlator

  • SVC0006: Invalid group

  • SVC0007: Invalid charging information

  • SVC0008: Overlapping criteria

PolicyException

Faults related to policies associated with the service, result in the return of a PolicyException message.

Table 31-5 PolicyException

Element Name Element type Optional Description

messageId

xsd:string

N

Message identifier, with prefix POL.

text

xsd:string

N

Message text, with replacement variables marked with %#

variables

xsd:string [0...unbounded]

Y

Variables to substitute into text string.

PolicyExceptions are thrown when a policy has been violated, including violations of a service level agreements. The following general PolicyExceptions are defined:

  • POL0001: Policy error

  • POL0002: Privacy error

  • POL0003: Too many addresses specified

  • POL0004: Unlimited notifications not supported

  • POL0005: Too many notifications requested

  • POL0006: Groups not allowed

  • POL0007: Nested groups not allowed

  • POL0008: Charging not supported

  • POL0009: Invalid frequency requested