28 About the Supported SOAP Parlay X 3.0 Facades

This chapter describes the Oracle Communications Services Gatekeeper interfaces in the supported Parlay X 3.0 facades and contains information specific to Services Gatekeeper not found in the specifications. For detailed descriptions of the interfaces, methods, and parameters, see the ETSI OSA Parlay X 3.0 specifications at:

http://www.etsi.org/deliver/etsi_es/202300_202399/20239111/01.02.01_60/es_20239111v010201p.pdf

Parlay X 3.0 Part 6: Payment

The Payment communication service interfaces follow Draft ETSI ES 202 504-6 v0.0.4 (2007-06), Open Service Access (OSA); Parlay X Web services; Part 6: Payment (Parlay X 3)

Interface: AmountCharging

The AmountCharging interface endpoint is: http://host:port/parlayx30/payment/AmountCharging

where values for host and port are the host name and port of the system on which Services Gatekeeper is installed.

chargeAmount

Charges the account indicated by the end user identifier.

Table 28-1 Exceptions and Error Codes

Exception Error Code Explanation

SVC0001

PAYMENT000002

A protocol-related error. This error is returned from the Diameter server. Make sure the server is running and reachable.

Check the log files for more information.

SVC0001

PAYMENT000003

A transient error. This error is returned from the Diameter server, for example, in an authentication failure. Make sure the server is reachable and has adequate storage space.

Check the log files for more information.

SVC0001

PLG-000004

General plug-in routing error.

SVC0001

PAYMENT000004

A permanent failure. This error is returned from the Diameter server, for example, when there is incorrect data in the AVP.

Check the log files for more information.

SVC0270

PAYMENT000004

A permanent failure. This error is returned from the Diameter server containing a Diameter error code and string. The Diameter charging server returns the error code and string to Services Gatekeeper, and the Services Gatekeeper charging plug-in returns it to the calling application in the Diameter-Error-Message Xparam using this syntax:

DIAMETERDiameter_error_code
Diameter-Error-Message="Diameter_error_string"

Where Diameter_error_code and Diameter_error_string are the codes and strings listed in Section 7.1 of Diameter RFC3588. For example:

DIAMETER5001
Diameter-Error-Message="DIAMETER_AVP_UNSUPPORTED"

For details on the error codes and strings see Diameter RFC3588 Section 7.1 (http://www.ietf.org/rfc/rfc3588.txt)

refundAmount

Refunds the account indicated by the end user identifier.

Table 28-2 Exceptions and Error Codes

Exception Error Code Explanation

SVC0001

PAYMENT000002

A protocol-related error. This error is returned from the Diameter server. Make sure the server is running and reachable.

Check the log files for more information.

SVC0001

PAYMENT000003

A transient error. This error is returned from the Diameter server, such as authentication failure. Make sure the server is reachable and has adequate storage space.

Check the log files for more information.

SVC0001

PLG-000004

General plug-in routing error.

SVC0001

PAYMENT000004

A permanent failure. This error is returned from the Diameter server, such as incorrect data in the AVP.

Check the log files for more information.

SVC0270

PAYMENT000004

A permanent failure. This error is returned from the Diameter server containing a Diameter error code and string. The Diameter charging server returns the error code and string to Services Gatekeeper, and the Services Gatekeeper charging plug-in returns it to the calling application in the Diameter-Error-Message Xparam using this syntax:

DIAMETERDiameter_error_code
Diameter-Error-Message="Diameter_error_string"

Where Diameter_error_code and Diameter_error_string are the codes and strings listed in Section 7.1 of Diameter RFC3588. For example:

DIAMETER5001
Diameter-Error-Message="DIAMETER_AVP_UNSUPPORTED"

For details on the error codes and strings see Diameter RFC3588 Section 7.1 (http://www.ietf.org/rfc/rfc3588.txt)

chargeSplitAmount

Charges multiple end user accounts concurrently.

Table 28-3 Exceptions and Error Codes

Exception Error Code Explanation

SVC0001

PAYMENT000002

A protocol-related error. This error is returned from the Diameter server. Make sure the server is running and reachable.

Check the log files for more information.

SVC0001

PAYMENT000003

A transient error. This error is returned from the Diameter server, for example, in an authentication failure. Make sure the server is reachable and has adequate storage space.

Check the log files for more information.

SVC0001

PLG-000004

General plug-in routing error.

SVC0001

PAYMENT000004

A permanent failure. This error is returned from the Diameter server, for example, such as incorrect data in the AVP.

Check the log files for more information.

SVC0270

PAYMENT000004

A permanent failure. This error is returned from the Diameter server containing a Diameter error code and string. The Diameter charging server returns the error code and string to Services Gatekeeper, and the Services Gatekeeper charging plug-in returns it to the calling application in the Diameter-Error-Message Xparam using this syntax:

DIAMETERDiameter_error_code
Diameter-Error-Message="Diameter_error_string"

Where Diameter_error_code and Diameter_error_string are the codes and strings listed in Section 7.1 of Diameter RFC3588. For example:

DIAMETER5001
Diameter-Error-Message="DIAMETER_AVP_UNSUPPORTED"

For details on the error codes and strings see Diameter RFC3588 Section 7.1 (http://www.ietf.org/rfc/rfc3588.txt)

Interface: VolumeCharging

The VolumeCharging interface endpoint is: http://host:port/parlayx30/payment/VolumeCharging

where values for host and port are the host name and port of the system on which Services Gatekeeper is installed.

chargeVolume

Charges the specified volume to the end user account.

Table 28-4 Exceptions and Error Codes

Exception Error Code Explanation

SVC0002

parameter

Invalid parameter value.

Check the log files for more information.

SVC0270

PAYMENT000004

Charge failed.

Check the log files for more information.

refundVolume

Refunds the specified volume to the end user account.

Table 28-5 Exceptions and Error Codes

Exception Error Code Explanation

SVC0002

parameter

Invalid parameter value.

Check the log files for more information.

SVC0270

PAYMENT000004

Refund failed

Check the log files for more information.

chargeSplitVolume

Charges a volume amount to multiple end user accounts based on percentages defined in a policy.

Table 28-6 Exceptions and Error Codes

Exception Error Code Explanation

SVC0002

parameter

Invalid parameter value.

Check the log files for more information.

SVC0270

PAYMENT000004

The charge failed.

Check the log files for more information.

SVC0271

  

Invalid sum of percentage allocations. The sum of percentage allocations must be 100.

POL0250

  

The number of endUserIdentifiers exceeds policy-defined maximum.

POL0251

  

Split charging is not supported by the defined policy.

getAmount

Converts the given volume to a currency amount.

chargeReservation

Charge the reserved volume to an end user account.

Table 28-7 Exceptions and Error Codes

Exception Error Code Explanation

SVC0002

parameter

Invalid parameter value.

Check the log files for more information.

SVC0270

PAYMENT000004

Charge reservation failed

Check the log files for more information.

releaseReservation

Release the reserved volume on an end user account.

Table 28-8 Exceptions and Error Codes

Exception Error Code Explanation

SVC0002

parameter

Invalid parameter value.

Check the log files for more information.

Interface: ReserveAmountCharging

The ReserveAmountCharging interface endpoint is: http://host:port/parlayx30/payment/ReserveAmountCharging

where values for host and port are the host name and port of the system on which Services Gatekeeper is installed.

reserveAmount

Reserves a charge for an account indicated by the end user identifier.

Table 28-9 Exceptions and Error Codes

Exception Error Code Explanation

SVC0001

PAYMENT000002

A protocol-related error. This error is returned from the Diameter server. Make sure the server is running and reachable.

Check the log files for more information.

SVC0001

PAYMENT000003

A transient error. This error is returned from the Diameter server, such as authentication failure. Make sure the server is reachable and has adequate storage space.

Check the log files for more information.

SVC0001

PLG-000004

General plug-in routing error.

SVC0001

PAYMENT000004

A permanent failure. This error is returned from the Diameter server, such as incorrect data in the AVP.

Check the log files for more information.

SVC0270

PAYMENT000004

A permanent failure. This error is returned from the Diameter server containing a Diameter error code and string. The Diameter charging server returns the error code and string to Services Gatekeeper, and the Services Gatekeeper charging plug-in returns it to the calling application in the Diameter-Error-Message Xparam using this syntax:

DIAMETERDiameter_error_code
Diameter-Error-Message="Diameter_error_string"

Where Diameter_error_code and Diameter_error_string are the codes and strings listed in Section 7.1 of Diameter RFC3588. For example:

DIAMETER5001
Diameter-Error-Message="DIAMETER_AVP_UNSUPPORTED"

For details on the error codes and strings see Diameter RFC3588 Section 7.1 (http://www.ietf.org/rfc/rfc3588.txt)

reserveAdditionalAmount

Adds to or subtracts from a charge to or from an existing reservation.

Table 28-10 Exceptions and Error Codes

Exception Error Code Explanation

SVC0001

PAYMENT000002

A protocol-related error. This error is returned from the Diameter server. Make sure the server is running and reachable.

Check the log files for more information.

SVC0001

PAYMENT000003

A transient error. This error is returned from the Diameter server, such as authentication failure. Make sure the server is reachable and has adequate storage space.

Check the log files for more information.

SVC0001

PLG-000004

General plug-in routing error.

SVC0001

PAYMENT000004

A permanent failure. This error is returned from the Diameter server, such as incorrect data in the AVP.

Check the log files for more information.

SVC0270

PAYMENT000004

A permanent failure. This error is returned from the Diameter server containing a Diameter error code and string. The Diameter charging server returns the error code and string to Services Gatekeeper, and the Services Gatekeeper charging plug-in returns it to the calling application in the Diameter-Error-Message Xparam using this syntax:

DIAMETERDiameter_error_code
Diameter-Error-Message="Diameter_error_string"

Where Diameter_error_code and Diameter_error_string are the codes and strings listed in Section 7.1 of Diameter RFC3588. For example:

DIAMETER5001
Diameter-Error-Message="DIAMETER_AVP_UNSUPPORTED"

For details on the error codes and strings see Diameter RFC3588 Section 7.1 (http://www.ietf.org/rfc/rfc3588.txt)

chargeReservation

Charges to a reservation indicated by the reservation ID.

Table 28-11 Exceptions and Error Codes

Exception Error Code Explanation

SVC0001

PAYMENT000002

A protocol-related error. This error is returned from the Diameter server. Make sure the server is running and reachable.

Check the log files for more information.

SVC0001

PAYMENT000003

A transient error. This error is returned from the Diameter server, such as authentication failure. Make sure the server is reachable and has adequate storage space.

Check the log files for more information.

SVC0001

PLG-000004

General plug-in routing error.

SVC0001

PAYMENT000004

A permanent failure. This error is returned from the Diameter server, such as incorrect data in the AVP.

Check the log files for more information.

SVC0270

PAYMENT000004

A permanent failure. This error is returned from the Diameter server containing a Diameter error code and string. The Diameter charging server returns the error code and string to Services Gatekeeper, and the Services Gatekeeper charging plug-in returns it to the calling application in the Diameter-Error-Message Xparam using this syntax:

DIAMETERDiameter_error_code
Diameter-Error-Message="Diameter_error_string"

Where Diameter_error_code and Diameter_error_string are the codes and strings listed in Section 7.1 of Diameter RFC3588. For example:

DIAMETER5001
Diameter-Error-Message="DIAMETER_AVP_UNSUPPORTED"

For details on the error codes and strings see Diameter RFC3588 Section 7.1 (http://www.ietf.org/rfc/rfc3588.txt)

releaseReservation

Returns funds left in a reservation to the account from which this reservation was made.

Table 28-12 Exceptions and Error Codes

Exception Error Code Explanation

SVC0001

PAYMENT000002

A protocol-related error. This error is returned from the Diameter server. Make sure the server is running and reachable.

Check the log files for more information.

SVC0001

PAYMENT000003

A transient error. This error is returned from the Diameter server, such as authentication failure. Make sure the server is reachable and has adequate storage space.

Check the log files for more information.

SVC0001

PLG-000004

General plug-in routing error.

SVC0001

PAYMENT000004

A permanent failure. This error is returned from the Diameter server, such as incorrect data in the AVP.

Check the log files for more information.

SVC0270

PAYMENT000004

A permanent failure. This error is returned from the Diameter server containing a Diameter error code and string. The Diameter charging server returns the error code and string to Services Gatekeeper, and the Services Gatekeeper charging plug-in returns it to the calling application in the Diameter-Error-Message Xparam using this syntax:

DIAMETERDiameter_error_code
Diameter-Error-Message="Diameter_error_string"

Where Diameter_error_code and Diameter_error_string are the codes and strings listed in Section 7.1 of Diameter RFC3588. For example:

DIAMETER5001
Diameter-Error-Message="DIAMETER_AVP_UNSUPPORTED"

For details on the error codes and strings see Diameter RFC3588 Section 7.1 (http://www.ietf.org/rfc/rfc3588.txt)

Interface: ReserveVolumeCharging

The ReserveVolumeCharging interface endpoint is: http://host:port/parlayx30/payment/ReserveVolumeCharging

where values for host and port are the host name and port of the system on which Services Gatekeeper is installed.

reserveVolume

Reserves a volume amount for the end user account.

Table 28-13 Exceptions and Error Codes

Exception Error Code Explanation

SVC0001

PAYMENT000002

Service error.

Check the log files for more information.

SVC0002

parameter

Invalid parameter value.

Check the log files for more information.

POL0001

  

Policy error.

Check the log files for more information.

reserveAdditionalVolume

Adds or reduces a volume amount to for an existing reservation on an end user account.

Table 28-14 Exceptions and Error Codes

Exception Error Code Explanation

SVC0002

parameter

Invalid parameter value.

Check the log files for more information.

getAmountReserveCharging

Converts a reserved volume to a currency amount.

Parlay X 3.0 Part 13: Address List Management

The Address List Management communication service interfaces follow 3GPP TS 29.199-13 V7.0.2 (2007-06), Open Service Access (OSA); Parlay X Web services; Part 13: Address List Management (Parlay X 3).

Interface: GroupManagement

This section describes the GroupManagement interface.

The GroupManagement interface endpoint is:

http://host:port/parlayx30/address_list/GroupManagement

where values for host and port are the host name and port of the system on which Services Gatekeeper is installed.

createGroup

Creates an Address List Management group.

Table 28-15 Exceptions and Error Codes

Exception Error Code Explanation

POL0212

n/a

Group name too long.

POL0213

n/a

Group already exists.

queryGroups

Queries an Address List Management group to return details about a particular group attribute, which is specified by attributeName.

deleteGroup

Deletes the specified Address List Management group.

setAccess

Sets access permissions for a member of an Address List Management group.

queryAccess

Queries the access permissions set for the group member passed in the requester parameter.

General Exceptions

See "General Exceptions".

Interface: Group

This section describes the Group interface.

The Group interface endpoint is:

http://host:port/parlayx30/address_list/Group

where values for host and port are the host name and port of the system on which Services Gatekeeper is installed.

addMember

Adds a single member to an Address List Management group.

addMembers

Adds multiple members to an Address List Management group.

Table 28-16 Exceptions and Error Codes

Exception Error Code Explanation

POL0210

n/a

Too many members in group.

POL0210

n/a

Subgroups not allowed.

queryMembers

Deletes the specified Address List Management group.

deleteMember

Deletes a single member from an Address List Management group.

deleteMembers

Deletes multiple members from an Address List Management group.

addGroupAttribute

Adds an attribute to an Address List Management group.

queryGroupAttribute

Queries an Address List Management group for the value associated with the passed attribute name. The attribute's value and status are returned.

deleteGroupAttribute

Deletes an attribute from an Address List Management group.

addGroupMemberAttribute

Adds an attribute to a member of an Address List Management group.

queryGroupMemberAttributes

Queries a member of an Address List Management group for list of attributes attached to the member.

deleteGroupMemberAttribute

Deletes an attribute from a member of an Address List Management group.

Interface: Member

This section describes the Member interface.

The Member interface endpoint is:

http://host:port/parlayx30/address_list/Member

where values for host and port are the host name and port of the system on which Services Gatekeeper is installed.

addMemberAttribute

Adds an attribute to a member outside of the context of a particular Address List Management group.

queryMemberAttributes

Queries a list of attributes for a member and retrieves their values.

deleteMemberAttribute

Deletes an attribute from a member.

Parlay X 3.0 Part 18: Device Capabilities and Configuration

The Device Capabilities and Configuration communication service interfaces follow ETSI ES 202 504-18 v0.0.1(2007-06), Open Service Access (OSA); Parlay X Web services; Part 18: Device Capabilities and Configuration (Parlay X 3).

Interface: DeviceCapabilities

This section describes the DeviceCapabilities interface.

The Device Capabilities interface endpoint is:

http://host:port/parlayx30/rest/device_capabilities

where values for host and port are the host name and port of the system on which Services Gatekeeper is installed.

getCapabilities

Retrieves the following capability information for a device:

  • The device's unique ID.

  • The name and model of the device.

  • A link to the UAProf file.

getDeviceId

Retrieves the device's equipment identifier.

General Exceptions

See "General Exceptions".

Interface: DeviceCapabilitiesNotificationManager

This section describes the DeviceCapabilitiesNotificationManager interface.

startNotification

Not supported.

endNotification

Not supported.

Interface: DeviceCapabilitiesNotification

This section describes the DeviceCapabilitiesNotification interface.

deviceNotification

Not supported.

deviceError

Not supported.

deviceEnd

Not supported.

Interface: DeviceConfiguration

This section describes the DeviceConfiguration interface.

pushConfiguration

Not supported.

getConfigurationList

Not supported.

getConfigurationHistory

Not supported.

General Exceptions

This section describes the exception handling for the Parlay X 3.0 interfaces.

The following exception types are defined:

  • Service exceptions

  • Policy exceptions

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

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

  • POL0001: Policy error

  • POL0002: Privacy error

  • POL0003: Too many addresses specified

  • POL0004: Unlimited notifications are not supported

  • POL0005: Too many notifications requested

  • POL0006: Groups not allowed

  • POL0007: Nested groups not allowed

  • POL0008: Charging not supported

  • POL0009: Invalid frequency requested

Within the exception, an error code is defined. The error code details why the exception was thrown.