Application Development Guide

     Previous  Next    Open TOC in new window    View as PDF - New Window  Get Adobe Reader - New Window
Content starts here

Extended Web Services Common

The Extended Web Services set of Web Services share common definitions described in this section:

 


Namespace

The namespace for the common data types is:

The namespace for the common faults is:

 


XML Schema datatype definition

AdditionalProperty structure

Defines a name-value pair.

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.

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.

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

ServiceException

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

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:

PolicyException

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

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:


  Back to Top       Previous  Next