Sending Booking Documents via SwOTA

The OTA_CruiseBookingDocumentRQ message allows to query Seaware documents for an existing booking (e.g., cruise itinerary, air itinerary etc.) the user wants and provide a delivery mode (e.g., e-mail, fax, mail etc.) using the OTA_CruiseBookingDocumentRQ/ReservationID and OTA_CruiseBookingDocumentRQ/CruiseDocument elements.

Request Example

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

<OTA_CruiseBookingDocumentRQ Version="1" xmlns="http://www.opentravel.org/OTA/2003/05" CorrelationID="5d0ac49b-8aa7-4c25-83d3-aea7bb90d144">
   <POS>
      [...]
   </POS>
   <ReservationID ID="12345" Type="14"/>
   <CruiseDocument DefaultIndicator="true" DeliveryMethodCode="2" DocumentDestination="CLIENT" DocumentLanguage="ENG"/>
</OTA_CruiseBookingDocumentRQ>

The response message OTA_CruiseBookingDocumentRS returns the status of each delivery request that was made.

Sending Specific Documents

OTA request to send just ONE specific document will be the same with the addition of DocumentTypeCode attribute to the CruiseDocument element.

The value for the attribute must be configured in the DocumentType external table in Seaware (map one of the OTA code list values to a Document Code).

Example: Sending Specific Document

So the following request will ONLY send the RES CONFIRMATION document if external table DocumentType in Seaware has value 3 mapped to RES CONFIRMATION document code:

<OTA_CruiseBookingDocumentRQ Version="1" xmlns="http://www.opentravel.org/OTA/2003/05" CorrelationID="5d0ac49b-8aa7-4c25-83d3-aea7bb90d144">
   <POS>
      [...]
   </POS>
   <ReservationID ID="12345" Type="14"/>
   <CruiseDocument DocumentTypeCode="3" DefaultIndicator="true" DeliveryMethodCode="2" DocumentDestination="CLIENT" DocumentLanguage="ENG"/>   
</OTA_CruiseBookingDocumentRQ>

Additional Features

Multiple Documents

Several CruiseDocument elements can be used to send several explicitly defined documents using one OTA request.

Custom Recipient

The person to send documents to can be explicitly defined if it is not the default document recipient set up in Seaware (it has to be an existing Seaware Client which can be identified by last name, email, phone and/or passport).

Example:

<CruiseDocument DeliveryMethodCode="2" DocumentLanguage="ENG">
    <VendorOption/>
    <RecipientInfo DefaultInd="false">
        <PersonName>
            <Surname>Smith</Surname>
        </PersonName>            
        <Email>john.smith@google.com</Email>            
    </RecipientInfo>
</CruiseDocument>

Alternative Destinations

Documents can also be sent to booking agency/agent using other values for the DocumentDestination attribute:

AGENT
AGENCY

Delivery Types

Delivery types supported are:

Email (most common)
Fax/SMS
Mail

Use the DeliveryMethodCode attribute to specify the delivery method. The values must be mapped/configured in the DistributionType external table in Seaware.

Document Section Configuration

Note

SwOTA works under its own document section and operations done via SwOTA will fail to issue the documents that are defined in another section unless it is specified in Seaware Setting DocSectionsToSearch (example: 'DEFAULT;VX_COMMON', add section with document to print here).

Table of Contents