7 Extended Web Services Common

This chapter describes the Extended Web Services set of Web Services share common definitions.

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 7-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 7-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 contained in this type.

Table 7-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 7-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 Exception 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 7-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