Table of Contents

Retrieving Bookings, Client or Agent Profiles

The OTA_ReadRQ message allows to query Seaware for existing data such as Client or Travel Agent profiles or existing bookings, or it's history.

Booking Retrieval

Request Example

Example of request to query an existing booking by Reservation ID:

<OTA_ReadRQ xmlns="http://www.opentravel.org/OTA/2003/05" CorrelationID="fbab88a3-5ce9-463d-83d9-5685bcfcb7a9" Version="1">
<POS>
<Source>
<RequestorID Type="5" ID_Context="IATA" ID="33"/>
</Source>
</POS>
<ReadRequests>
<ReadRequest HistoryRequestedInd="false">
<UniqueID ID="10201" Type="14" ID_Context="SEAWARE"/>
</ReadRequest>
</ReadRequests>
</OTA_ReadRQ>

Response Example

<vx:OTA_ResRetrieveRS 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="fbab88a3-5ce9-463d-83d9-5685bcfcb7a9" 
  TargetName="SW_OTA_TEST@ORADEV" 
  TimeStamp="2021-09-04T14:05:18.293" 
  Version="1.999">
  <vx:Success/>
  <vx:ReservationsList>
    <vx:CruiseReservation>
      <vx:SailingInfo>
      [..sail, category, cabin details..]
      </vx:SailingInfo>
      <vx:ReservationInfo>
        <vx:ReservationID BookedDate="2021-09-04T14:05:14" ID="10201" ID_Context="SEAWARE" StatusCode="42" Type="14">
          <vx:CompanyName>OPENTRAVEL</vx:CompanyName>
          <vx:TPA_Extensions>
            <ns3:AgencyInfo Contact="Cruise Line Name Here" ContactID="1"/>
            <ns3:TWReferralInfo TWReferralCode="AC13F4D6-D4AB-438F-9C34-2FDCE0D264F2"/>
          </vx:TPA_Extensions>
        </vx:ReservationID>
        <vx:GuestDetails>
          [..guest details, selected secondary components (insurance, shorex, etc.)..]            
        </vx:GuestDetails>
      </vx:ReservationInfo>
      <vx:PaymentsDue>
        [..payment schedule and select invoice totals..]
      </vx:PaymentsDue>
    </vx:CruiseReservation>
  </vx:ReservationsList>
</vx:OTA_ResRetrieveRS>

Response Content

SailingInfo Element

The SailingInfo element, as in most booking-related responses, contains details of the sailing, and selected category and cabin (if selected).

PaymentsDue Element

The element PaymentsDue contains payment schedule and limited information on booking totals:

  • 1 – FIRST_DEPOSIT
  • 2 – SECOND_DEPOSIT
  • 3 – THIRD_DEPOSIT
  • 4 – FOURTH_DEPOSIT
  • 50 – FINAL_PAYMENT
  • 60 – FULL_DEPOSIT
  • 70 – Net Due
  • 71 – Gross Due
  • 80 – Invoice Total
  • 81 – Commission Total
  • 82 – Charge Total
Note

This response does not provide detailed price/invoice itemization. For that the OTA_CruisePriceBookingRQ message must be used as described in Booking Pricing article.

Stateful Mode Usage

The same request message can be used for a temporary booking in stateful mode to lock the booking. See SwOTA Stateful Mode for details.

The same message can be used to get Booking History.

Agent or Client Profile Retrieval

Same request can be used to look up a client or a travel agent record.

Client Lookup Example

Example of the client lookup by Client ID 437:

<OTA_ReadRQ xmlns="http://www.opentravel.org/OTA/2003/05" Version="1.0">
  <POS>
    [..]
  </POS>
  <ReadRequests>
    <ProfileReadRequest>
      <UniqueID Type="1" ID="437" ID_Context="SEAWARE"/>
    </ProfileReadRequest>
  </ReadRequests>
</OTA_ReadRQ>

Client Profile Response

<vx:OTA_ProfileReadRS 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="d163851f-7865-454d-872f-177c2ab47fb5" 
  TargetName="SW_OTA_TEST@ORADEV" 
  TimeStamp="2021-09-04T14:37:31.235" 
  Version="1.999">
  <vx:Success/>
  <vx:Profiles>
    <vx:ProfileInfo>
      <vx:UniqueID ID="437" ID_Context="SEAWARE" Type="1"/>
      <vx:Profile ProfileType="1">
        <vx:Customer BirthDate="1983-01-01" CustomerValue="REGULAR" Deceased="false" Language="ENG" Text="Test client">
          <vx:PersonName Language="ENG">
            <vx:GivenName>DON</vx:GivenName>
            <vx:MiddleName>PETE</vx:MiddleName>
            <vx:Surname>BLACK</vx:Surname>
            <vx:Document DocID="3334455" DocType="2"/>
          </vx:PersonName>
          <vx:Telephone CountryAccessCode="1" DefaultInd="true" PhoneNumber="40887691569780345" PhoneUseType="5" ShareMarketInd="No"/>
          <vx:Email DefaultInd="true" ShareMarketInd="Yes">don.black1569780345@none.com</vx:Email>
          <vx:Address DefaultInd="true" ShareMarketInd="Yes" Type="1">
            <vx:AddressLine>100 Avenue Street</vx:AddressLine>
            <vx:PostalCode>95132</vx:PostalCode>
            <vx:CountryName Code="US">UNITED STATES</vx:CountryName>
          </vx:Address>
          <vx:CitizenCountryName Code="US"/>
          <vx:Document BirthCountry="CA" BirthPlace="Vancouver" DocID="3334455" DocIssueAuthority="Kanzas" DocType="2" EffectiveDate="2000-01-01" ExpireDate="2050-10-10"/>
          <vx:Document DocID="12345" DocIssueCountry="US" DocIssueLocation="ACY" DocType="1" EffectiveDate="2012-03-06" ExpireDate="2022-03-06" Remark="B1"/>
          <vx:TPA_Extensions>
            <ns3:Household ID="100436" ID_Context="SEAWARE" Name="Black">
              <ns3:PersonName>
                <vx:Surname>BLACK</vx:Surname>
              </ns3:PersonName>
            </ns3:Household>
          </vx:TPA_Extensions>
        </vx:Customer>
        <vx:UserID ID="DON1569780345" ID_Context="WEB" Type="1"/>
      </vx:Profile>
    </vx:ProfileInfo>
  </vx:Profiles>
</vx:OTA_ProfileReadRS>

Client Search by Name

Example of client search by first and last names:

<ProfileReadRequest>
  <Customer>
    <PersonName>
      <GivenName>Don</GivenName>
      <Surname>Black</Surname>
    </PersonName>
  </Customer>
</ProfileReadRequest>

Other Search Parameters

  • Customer/Email
  • Customer/Telephone/PhoneNumber
  • Customer/BirthDate