API Information

Response Format
XML
Service Action Code
DisplayGroupRQ
Current Version
5.0.0
Target Audience
TN
Environment
Production
Documentation
Go to the Display Group documentation

What's New

  • With CWS API Version 5.0.0, partners will be able to get information on combinability of group rate options as offered on the sailing / group.

Functional Updates And Enhancements

In the Response

Optional

Parameter: CombPromoInfo

Type: String Array

Description: This segment provides information on which different promotions can be combined to get a higher discount. Information on all the rate option codes that can be combined with the specific rate option will be returned under this node. The node will only be returned if you are eligible for booking the rate option and a combinable promotion is offered by the cruise line for the specific rate option.

Sample Value:

<combPromoInfo> <rtOptCombWith>A10289284</rtOptCombWith> <rtOptName>FL Resident Promo</rtOpName> </combPromoInfo>
Parameter: rtOptCombWith

Type: String

Description: Combinable rate option code.

Sample Value:

<ns1:combPromoInfo> <ns1:rtOptCombWith>C2831879</ns1:rtOptCombWith> <ns1:rtOptEligibility>N</ns1:rtOptEligibility> <ns1:rtOptName>1-2-Free</ns1:rtOptName> <ns1:rtOptType>DIS</ns1:rtOptType> </ns1:combPromoInfo>
Parameter: rtOptName

Type: String

Description: Descriptive name associated with a Rate Option.

Sample Value:

<ns1:combPromoInfo> <ns1:rtOptCombWith>C2831879</ns1:rtOptCombWith> <ns1:rtOptEligibility>N</ns1:rtOptEligibility> <ns1:rtOptName>1-2-Free</ns1:rtOptName> <ns1:rtOptType>DIS</ns1:rtOptType> </ns1:combPromoInfo>
Parameter: rtOptType

Type: String

Description: Unique identifier for the type of rate option. Domain Table Reference(s): RtOptType.

Sample Value:

<ns1:combPromoInfo> <ns1:rtOptCombWith>C2831879</ns1:rtOptCombWith> <ns1:rtOptEligibility xsi:nil = "true"/> <ns1:rtOptName>1-2-Free</ns1:rtOptName> <ns1:rtOptType>DIS</ns1:rtOptType> </ns1:combPromoInfo>
Parameter: rtOptEligibility

Type: String

Description: An indicator (Y/N) to identify if the booking is eligible for a respective rate option.

Sample Value:

<ns1:combPromoInfo> <ns1:rtOptCombWith>C2831879</ns1:rtOptCombWith> <ns1:rtOptEligibility>Y</ns1:rtOptEligibility> <ns1:rtOptName>1-2-Free</ns1:rtOptName> <ns1:rtOptType>DIS</ns1:rtOptType> </ns1:combPromoInfo>