Table of Contents

Cabin Availability

Request a list of available cabins in the selected category with the CruiseCabinAvailRQ/RS message pair. The service will return a list of available cabins from which the traveler will make a selection.

Request Example

POST https://bookings-stage.sw.travelhx.com/ota/rest/OTA_CruiseCabinAvailRQ
Content-Type: application/xml

<OTA_CruiseCabinAvailRQ xmlns="http://www.opentravel.org/OTA/2003/05" CorrelationID="5ffafab0-8b0e-42b0-9f81-a23e73b2a6e4" Version="1.0">
  <POS>
    [..]
  </POS>
  <GuestCounts>
    <GuestCount Quantity="2"/>
  </GuestCounts>
  <SailingInfo>
    <SelectedSailing VoyageID="CS21711JUNKTN">
      <CruiseLine/>
    </SelectedSailing>
    <SelectedCategory PricedCategoryCode="A"/>
  </SailingInfo>
  <SelectedFare FareCode="BESTPRICE"/>
</OTA_CruiseCabinAvailRQ>

Response Example

Response will contain a list of CabinOption elements with available cabin numbers and details:

<vx:OTA_CruiseCabinAvailRS xmlns:ns3="http://www.versonix.com/ota" 
  xmlns:ns4="http://schemas.xmlsoap.org/soap/envelope/" 
  xmlns:vx="http://www.opentravel.org/OTA/2003/05" 
  CorrelationID="5ffafab0-8b0e-42b0-9f81-a23e73b2a6e4" 
  MoreIndicator="false" 
  TargetName="SW_OTA_TEST@ORADEV" 
  TimeStamp="2021-08-27T14:10:04.460" 
  Version="1.999">
  <vx:Success/>
  <vx:SailingInfo>
    [..]
  </vx:SailingInfo>
  <vx:SelectedFare FareCode="BESTPRICE"/>
  <vx:CabinOptions>
    <vx:CabinOption CabinCategoryCode="A" CabinCategoryStatusCode="36" CabinNumber="1002" 
          CabinRanking="1" DeckName="Deck #1" DeckNumber="1" DeclineIndicator="false" 
          HeldIndicator="false" MaxOccupancy="2" Status="36">
      <vx:Remark>Cabin description</vx:Remark>
    </vx:CabinOption>
    [..]
    <vx:CabinOption CabinCategoryCode="A" CabinCategoryStatusCode="36" CabinNumber="GTY" 
          CabinRanking="2" DeclineIndicator="false" 
          HeldIndicator="false" MaxOccupancy="2" Status="47">
      <vx:Remark>A GTY</vx:Remark>
    </vx:CabinOption>
  </vx:CabinOptions>
</vx:OTA_CruiseCabinAvailRS>
Note

Not-available cabins are NOT returned.

Response Limits

The number of available cabins returned may be limited in two ways:

  • The MaxResponses attribute can be provided in the OTA_CruiseCabinAvailRQ request message by the client application (partner)
  • The Seaware setting SwOtaCabinAvailMaxResponses can be configured (non-0) by the cruise line to enforce a server-side limit

GTY (Guarantee) Cabin

By default the response in addition to available cabin numbers will also contain a "GTY" cabin. This is to indicate to the customer or a client application that they can also select Guarantee without a cabin number.

By default this is returned always even if GTY is blocked in Seaware, because the real verification of GTY negatively affects performance.

GTY Verification

A Seaware setting SwOtaGTYErrorCode can be used to set up a real verification of the GTY selection eligibility if Seaware has rules that may prohibit it:

  • If the setting value is empty or 0 then default behavior is in place (GTY always returned, no verification).
  • If the value is an integer Code of a Seaware Error then SwOTA will try to identify if Guarantee selection is allowed for the booking by attempting to create a temporary booking with same sail and category and a GTY cabin selection and see if Seaware returns an error. If Seaware generates an error and the code of that error is the same as configured in SwOtaGTYErrorCode setting, then the CabinAvail response will NOT contain the "GTY" cabin.

If there are rules in Seaware restricting the GTY cabin selection and generating a specific error when these rules are broken, then that error code has to be set up in SwOtaGTYErrorCode setting for SwOTA to not suggest "GTY" cabin in cabin availability response.