Versions Compared

Version Old Version 2 New Version 3
Changes made by

Yana Brilevskaya

Yana Brilevskaya

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

GP HUB shows these remarks in AdditionalQuestions element on Excursion Descriptive Info Response or Reservation Initiate Response depending on supplier:

Expand
titleExample of question on response Sample XML
Code Block
languagexml
<AdditionalQuestions>
   <AdditionalQuestion ID="7697-dyn|49211" IsMandatory="false" IsPerPerson="false" QuestionText="Would you like to pre-purchase photos?-Please check if you like to pre-purchase photos for $10." TypeDescription="Boolean" TypeID="1"/>
   <AdditionalQuestion ID="7697-dyn|49212" IsMandatory="false" IsPerPerson="false" QuestionText="Would you like to pre-purchase photos?-Please select which photo package you would like." TypeDescription="List" TypeID="6">
      <ValidValues>
         <Value Code="462600">Photo Option 1</Value>
         <Value Code="462601">Photo Option 2</Value>
         <Value Code="462602">Photo Option 3</Value>
      </ValidValues>
   </AdditionalQuestion>
   <AdditionalQuestion ID="7697-dyn|49214" IsMandatory="false" IsPerPerson="false" QuestionText="Would you like to pre-purchase photos?-Yes/No" TypeDescription="Text" TypeID="4"/>
</AdditionalQuestions>

...

AdditionalQuestions element should be specified on Reservation Initiate Request and Reservation Confirmation Request If supplier returns AdditionalQuestions on Excursion Descriptive Info Response.

Flow with AdditionalQuestions from Excursion Descriptive Info Response:

...

Expand
titleExcursion Reservation Confirmation response with Hotel PickUp Sample XML
Code Block
languagexml
<GP_ExcursionResRS EchoToken="EchoToken" Version="2" xmlns="http://www.opentravel.org/OTA/2003/05">
   <Success/>
   <ExcursionReservations>
      <ExcursionReservation ResStatus="Waitlisted">
         <Excursions>
            <Excursion>
               <ExcursionRates>
                  <ExcursionRate AvailabilityStatus="OnRequest" BookingCode="3ecrc0" Language="Undefined" NonRefundable="true" RateCode="Default" RateName="Standard">
                     <Rates>
                        <Rate AgeQualifyingCode="10" RateSource="Calculated">
                           <Total AmountAfterTax="2000.00" CurrencyCode="ZAR"/>
                        </Rate>
                        <Rate AgeQualifyingCode="8" RateSource="Calculated">
                           <Total AmountAfterTax="2000.00" CurrencyCode="ZAR"/>
                        </Rate>
                     </Rates>
                     <RateDescription Name="Standard">
                        <Text Language="en">Standard</Text>
                     </RateDescription>
                     <Total AmountAfterTax="4000.00" CurrencyCode="ZAR"/>
                     <PersonName OnlyLead="No"/>
                     <ExcursionDate End="2021-04-06" Start="2021-04-06"/>
                  </ExcursionRate>
               </ExcursionRates>
               <ExcursionDate Start="2021-05-20"/>
               <Departure RPH="1">
		  <StartTime>16:00:00</StartTime>
                  <Hotel HotelCodeContext="supplierCode" HotelCode="LON.ADA" HotelCityCode="LON"/>
               </Departure>
               <Total AmountAfterTax="4000.00" CurrencyCode="ZAR"/>
               <BasicExcursionInfo ExcursionCityCode="CPT" ExcursionCode="CPTDTEAT0012PLA21" ExcursionCodeContext="supplierCode" ExcursionName="Flavours of Cape Town Private Tour" OperatedBy="Eat Like A Local">
                  <Categories>
                     <Category Code="OTHR">
                        <Text Language="en">Private</Text>
                     </Category>
                  </Categories>
               </BasicExcursionInfo>
            </Excursion>
         </Excursions>
         <ResGuests>
            <ResGuest AgeQualifyingCode="10" ResGuestRPH="1">
               <Profiles>
                  <ProfileInfo>
                     <UniqueID ID="1" Type="1"/>
                     <Profile>
                        <Customer BirthDate="1980-06-12">
                           <PersonName>
                              <NamePrefix>Mr</NamePrefix>
                              <GivenName>John</GivenName>
                              <Surname>Black</Surname>
                           </PersonName>
                           <Telephone PhoneNumber="342342343"/>
                           <Email>test@gpsolutions.com</Email>
                           <CitizenCountryName Code="UA"/>
                        </Customer>
                     </Profile>
                  </ProfileInfo>
               </Profiles>
            </ResGuest>
            <ResGuest AgeQualifyingCode="8" ResGuestRPH="1">
               <Profiles>
                  <ProfileInfo>
                     <UniqueID ID="2" Type="1"/>
                     <Profile>
                        <Customer BirthDate="2015-06-12">
                           <PersonName>
                              <NamePrefix>Mr</NamePrefix>
                              <GivenName>Inna</GivenName>
                              <Surname>Black</Surname>
                           </PersonName>
                           <Telephone PhoneNumber="342342343"/>
                           <Email>test@gpsolutions.com</Email>
                        </Customer>
                     </Profile>
                  </ProfileInfo>
               </Profiles>
            </ResGuest>
         </ResGuests>
         <ResGlobalInfo>
            <DepositPayments>
               <GuaranteePayment Type="AcceptedPaymentForms">
                  <AcceptedPayments>
                     <AcceptedPayment CostCenterID="supplierCode"/>
                  </AcceptedPayments>
               </GuaranteePayment>
            </DepositPayments>
            <ExcursionReservationIDs>
               <ExcursionReservationID ResID_Source="agent" ResID_Value="agentnf"/>
               <ExcursionReservationID ResID_Source="client" ResID_Value="nfexc01"/>
               <ExcursionReservationID ResID_Source="supplier" ResID_SourceContext="supplierCode" ResID_Value="203576"/>
            </ExcursionReservationIDs>
         </ResGlobalInfo>
      </ExcursionReservation>
   </ExcursionReservations>
</GP_ExcursionResRS>

9.4. SEE PRICE FOR CANCELLATION ON RETRIEVE

On Retrieve after Cancellation you can see the total price of the booking and the total price of the cancellation.

RoomStays/RoomStay/RoomRates/RoomRate/Total/@AmountAfterTax - is the total price of the booking (even if the reservation has already been cancelled for free). This Amount has the same value that we show on Reservation.

RoomStays/RoomStay/Total/@AmountAfterTax - is the actual total price for the booking. This Amount is the price of the cancellation.

Expand
titleReservation Confirmation Response
Code Block
languagexml
<GP_ExcursionResRS xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="EchoToken" Version="2.0">
  <Success/>
  <ExcursionReservations>
    <ExcursionReservation ResStatus="Waitlisted">
      <Excursions>
        <Excursion>
          <ExcursionRates>
            <ExcursionRate BookingCode="49d4c9" Language="Undefined" RPH="1" RateCode="14005" RateName="FLY 'N DINE TO BOWEN ISLAND">
              <Rates>
                <Rate AgeQualifyingCode="10" RateSource="Calculated">
                  <Total AmountAfterTax="244.00" CurrencyCode="CAD"/>
                </Rate>
              </Rates>
              <RateDescription Name="FLY 'N DINE TO BOWEN ISLAND">
                <Text Language="en">FLY 'N DINE TO BOWEN ISLAND - HARBOUR AIR</Text>
              </RateDescription>
              <AdditionalQuestions>
                <AdditionalQuestion ID="40-257" IsMandatory="true" IsPerPerson="false" QuestionText="Departure Time" RegExpValue="(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]" TypeDescription="RegExpText" TypeID="5">
                  <AnswerValues>
                    <Value>12:00</Value>
                  </AnswerValues>
                </AdditionalQuestion>
                <AdditionalQuestion ID="40-509" IsMandatory="true" IsPerPerson="false" QuestionText="Dietary Restrictions" RegExpValue="^.{1,60}$" TypeDescription="RegExpText" TypeID="5">
                  <AnswerValues>
                    <Value>lala</Value>
                  </AnswerValues>
                </AdditionalQuestion>
                <AdditionalQuestion ID="40-252" IsMandatory="true" IsPerPerson="false" QuestionText="Drop off Location" RegExpValue="^.{1,100}$" TypeDescription="RegExpText" TypeID="5">
                  <AnswerValues>
                    <Value>Airport</Value>
                  </AnswerValues>
                </AdditionalQuestion>
              </AdditionalQuestions>
              <Total AmountAfterTax="244.00" CurrencyCode="CAD"/>
              <CancelPenalties>
                <CancelPenalty End="2021-07-14T23:59:59-07:00" Start="2021-07-12T00:00:00-07:00">
                  <AmountPercent Amount="244.00" CurrencyCode="CAD"/>
                  <PenaltyDescription Language="en">
                    <Text>Standard Cancellation Policy ( 100 % of Total )</Text>
                  </PenaltyDescription>
                </CancelPenalty>
                <CancelPenalty End="2021-07-15T23:59:59-07:00" Start="2021-07-15T00:00:00-07:00">
                  <AmountPercent Amount="244.00" CurrencyCode="CAD"/>
                </CancelPenalty>
              </CancelPenalties>
            </ExcursionRate>
          </ExcursionRates>
          <ExcursionDate Start="2021-07-15"/>
          <Total AmountAfterTax="244.00" CurrencyCode="CAD"/>
          <BasicExcursionInfo ExcursionCityCode="YVR" ExcursionCode="14005" ExcursionCodeContext="supplierCode" ExcursionName="FLY 'N DINE TO BOWEN ISLAND" OperatedBy="Harbour Air / West Coast Air / Whistler Air (A/C # 149062)">
            <Categories>
              <Category Code="OTHR">
                <Text Language="en">Day Tours</Text>
              </Category>
            </Categories>
          </BasicExcursionInfo>
        </Excursion>
      </Excursions>
      <ResGuests>
        <ResGuest AgeQualifyingCode="10" ResGuestRPH="1">
          <Profiles>
            <ProfileInfo>
              <UniqueID ID="1" Type="1"/>
              <Profile>
                <Customer BirthDate="2000-06-12">
                  <PersonName>
                    <NamePrefix>Mr</NamePrefix>
                    <GivenName>Ivan</GivenName>
                    <Surname>Ivanov</Surname>
                  </PersonName>
                  <Telephone PhoneNumber="+2324234234"/>
                  <Email>test@gpsolutions.com</Email>
                  <CitizenCountryName Code="KW"/>
                </Customer>
              </Profile>
            </ProfileInfo>
          </Profiles>
        </ResGuest>
      </ResGuests>
      <ResGlobalInfo>
        <Comments>
          <Comment>
            <Text>Please, arrange vegetarian meal.</Text>
          </Comment>
        </Comments>
        <DepositPayments>
          <GuaranteePayment Type="AcceptedPaymentForms">
            <AcceptedPayments>
              <AcceptedPayment CostCenterID="supplierCode"/>
            </AcceptedPayments>
          </GuaranteePayment>
        </DepositPayments>
        <ExcursionReservationIDs>
          <ExcursionReservationID ResID_Source="client" ResID_Value="tfdghdsff11"/>
          <ExcursionReservationID ResID_Source="agent" ResID_Value="tfdghdsff11"/>
          <ExcursionReservationID ResID_Source="supplier" ResID_SourceContext="supplierCode" ResID_Value="XXX4888"/>
        </ExcursionReservationIDs>
      </ResGlobalInfo>
    </ExcursionReservation>
  </ExcursionReservations>
</GP_ExcursionResRS>
Expand
titleExcursion Cancellation Response
Code Block
languagexml
<OTA_CancelRS xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="EchoToken" Status="Cancelled" Version="2.0">
  <Success/>
  <UniqueID ID="tfdghdsff11" ID_Context="client" Type="10"/>
  <UniqueID ID="tfdghdsff11" ID_Context="agent" Type="10"/>
  <UniqueID ID="XXX4888" ID_Context="supplier" Type="10"/>
  <CancelInfoRS>
    <CancelRules>
      <CancelRule Amount="0.00" CurrencyCode="CAD"/>
    </CancelRules>
  </CancelInfoRS>
</OTA_CancelRS>
Expand
titleExcursion Booking Retrieval Quote Response
Code Block
languagexml
<GP_ExcursionResRS xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="EchoToken" Version="2.0">
  <Success/>
  <ExcursionReservations>
    <ExcursionReservation ResStatus="Cancelled">
      <Excursions>
        <Excursion>
          <ExcursionRates>
            <ExcursionRate BookingCode="49d4c9" Language="Undefined" RPH="1" RateCode="14005" RateName="FLY 'N DINE TO BOWEN ISLAND">
              <Rates>
                <Rate AgeQualifyingCode="10" RateSource="Calculated">
                  <Total AmountAfterTax="244.00" CurrencyCode="CAD"/>
                </Rate>
              </Rates>
              <RateDescription Name="FLY 'N DINE TO BOWEN ISLAND">
                <Text Language="en">FLY 'N DINE TO BOWEN ISLAND - HARBOUR AIR</Text>
              </RateDescription>
              <AdditionalQuestions>
                <AdditionalQuestion ID="40-257" IsMandatory="true" IsPerPerson="false" QuestionText="Departure Time" RegExpValue="(0[0-9]|1[0-9]|2[0-3]):[0-5][0-9]" TypeDescription="RegExpText" TypeID="5">
                  <AnswerValues>
                    <Value>12:00</Value>
                  </AnswerValues>
                </AdditionalQuestion>
                <AdditionalQuestion ID="40-509" IsMandatory="true" IsPerPerson="false" QuestionText="Dietary Restrictions" RegExpValue="^.{1,60}$" TypeDescription="RegExpText" TypeID="5">
                  <AnswerValues>
                    <Value>lala</Value>
                  </AnswerValues>
                </AdditionalQuestion>
                <AdditionalQuestion ID="40-252" IsMandatory="true" IsPerPerson="false" QuestionText="Drop off Location" RegExpValue="^.{1,100}$" TypeDescription="RegExpText" TypeID="5">
                  <AnswerValues>
                    <Value>Airport</Value>
                  </AnswerValues>
                </AdditionalQuestion>
              </AdditionalQuestions>
              <Total AmountAfterTax="244.00" CurrencyCode="CAD"/>
              <CancelPenalties>
                <CancelPenalty End="2021-07-14T23:59:59-07:00" Start="2021-07-12T00:00:00-07:00">
                  <AmountPercent Amount="244.00" CurrencyCode="CAD"/>
                  <PenaltyDescription Language="en">
                    <Text>Standard Cancellation Policy ( 100 % of Total )</Text>
                  </PenaltyDescription>
                </CancelPenalty>
                <CancelPenalty End="2021-07-15T23:59:59-07:00" Start="2021-07-15T00:00:00-07:00">
                  <AmountPercent Amount="244.00" CurrencyCode="CAD"/>
                </CancelPenalty>
              </CancelPenalties>
            </ExcursionRate>
          </ExcursionRates>
          <ExcursionDate Start="2021-07-15"/>
          <Total AmountAfterTax="0.00" CurrencyCode="CAD"/>
          <BasicExcursionInfo ExcursionCityCode="YVR" ExcursionCode="14005" ExcursionCodeContext="supplierCode" ExcursionName="FLY 'N DINE TO BOWEN ISLAND" OperatedBy="Harbour Air / West Coast Air / Whistler Air (A/C # 149062)">
            <Categories>
              <Category Code="OTHR">
                <Text Language="en">Day Tours</Text>
              </Category>
            </Categories>
          </BasicExcursionInfo>
        </Excursion>
      </Excursions>
      <ResGuests>
        <ResGuest AgeQualifyingCode="10" ResGuestRPH="1">
          <Profiles>
            <ProfileInfo>
              <UniqueID ID="1" Type="1"/>
              <Profile>
                <Customer BirthDate="2000-06-12">
                  <PersonName>
                    <NamePrefix>Mr</NamePrefix>
                    <GivenName>Ivan</GivenName>
                    <Surname>Ivanov</Surname>
                  </PersonName>
                  <Telephone PhoneNumber="+2324234234"/>
                  <Email>test@gpsolutions.com</Email>
                </Customer>
              </Profile>
            </ProfileInfo>
          </Profiles>
        </ResGuest>
      </ResGuests>
      <ResGlobalInfo>
        <Comments>
          <Comment>
            <Text>Please, arrange vegetarian meal.</Text>
          </Comment>
        </Comments>
        <DepositPayments>
          <GuaranteePayment Type="AcceptedPaymentForms">
            <AcceptedPayments>
              <AcceptedPayment CostCenterID="supplierCode"/>
            </AcceptedPayments>
          </GuaranteePayment>
        </DepositPayments>
        <ExcursionReservationIDs>
          <ExcursionReservationID ResID_Source="client" ResID_Value="tfdghdsff11"/>
          <ExcursionReservationID ResID_Source="agent" ResID_Value="tfdghdsff11"/>
          <ExcursionReservationID ResID_Source="supplier" ResID_SourceContext="supplierCode" ResID_Value="XXX4888"/>
        </ExcursionReservationIDs>
      </ResGlobalInfo>
    </ExcursionReservation>
  </ExcursionReservations>
</GP_ExcursionResRS>