Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 8 Current »

Reservation Initiate Response returns final price and availability of the requested offer.

GP_ExcursionResRS*:

*mandatory

Element

Attribute

Type

Description

Min…Max occurs

TransactionIdentifier

Unique transaction ID generated by GP HUB. This attribute must be further passed on Step 2 to identify the booking request.

0...1

Success

For more information see Common Data Description section in Glossary.

0...1

Warnings/Warning

For more information see Common Data Description section in Glossary.

0...99

ExcursionReservations/ExcursionReservation*

Include booking information.

1...1

ResStatus*

string (“Reserved”, “Request denied”, “Requested”)

The reservation status. Can be:

"Reserved" - means that excursion is available and can be booked.

"Request denied" - means that supplier denied this request and excursion can not be booked.

"Requested" - means that GP Hub has done best effort to ensure that excursion can be booked, however, this status doesn't guarantee, that excursion will be booked. This status usually denotes that supplier doesn't support two-pass booking.

1...1

ExcursionReservations/ExcursionReservation/Excursions/Excursion*

Contains information about the excursion.

1...*

ExcursionReservations/ExcursionReservation/ResGuests/ResGuest*

For more information see Reservation Initiate Request section.

1...*

ExcursionReservations/ExcursionReservation/ResGlobalInfo*

For more information see Reservation Initiate Request section.

1...1

GP_ExcursionResRS/ExcursionReservations/ExcursionReservation/Excursions/Excursion*:

Element

Attribute

Type

Description

Min…Max occurs

ExcursionRates/ExcursionRate*

Describes excursion offer.

Elements are the same as in Excursion Availability Response, but there are no ExcursionDate, AvailableTicketQuantities, CitizenCountryName and PersonName elements and ExcursionRates/ExcursionRate/NonRefundable attribute. Also some elements are added:

1...*

RPH*

integer (1)

Must always be 1.

1...1

FreeCancellationDeadline

yyyy-MM-dd,
yyyy-MM-dd'T'hh-MM-ss or yyyy-MM-dd'T'hh:MM:ssXXX

Shows the last date and time of cancellation without penalty for refundable offers.

0...1

ExcursionRates/ExcursionRate/AdditionalQuestions/AdditionalQuestion

Remarks from supplier.

Note: This functionality supported for limited suppliers. Please check with GP Travel HUB development if you are interested in specific supplier.

0...*

ExcursionRates/ExcursionRate/CancelPenalties/CancelPenalty*

For more information see Excursion Charges Response section.

1...*

ExcursionDate*

For more information see Common Data Description section in Glossary.

1...1

Services/Service

For more information see Excursion Availability Response section.

Note: Reservation Initiate Response will return ONLY services that were requested at Reservation Initiate Request, not all the services available.

0...999

Departure

For more information see Excursion Availability Response section.

0...1

Total*

Total offer price for all requested travelers.

1...1

AmountAfterTax*

For more information see Common Data Description section in Glossary.

1...1

CurrencyCode*

1...1

Total/Taxes/Tax

For more information see Excursion Availability Response section.

0...100

BasicExcursionInfo*

For more information see Excursion Availability Response section.

Please. note, that MultimediaDescription and Departure elements are not included in BasicExcursionInfo.

1…1

GP_ExcursionResRS/ExcursionReservations/ExcursionReservation/Excursions/Excursion/ExcursionRates/ExcursionRate/AdditionalQuestions/AdditionalQuestion:

Element

Attribute

Type

Description

Min…Max occurs

ID*

string (1 – 32)

Contains unique remark identifier.

1...1

TypeDescription

string (“Boolean”, “Numeric”, “NumericRange”, “Text”, “RegExpText”, “List”)

Contains short description of remark type. For more information see "Remark Types" in Glossary.

0...1

TypeID*

integer (1 – 6

Contains unique remark type identifier. The attribute can be set to 1, 2, 3, 4, 5, 6. For more information see "Remark Types" in Glossary.

1...1

QuestionText*

string

Contains remark text.

1...1

DepartureRPHList

string

In case the value of the “IsMandatory” attribute is set to false, the DepartureRPHList attribute can contain a list of Departure RPHs for which the remark is mandatory. Presented only in the Excursion Descriptive Info response.

0…1

IsConditional

boolean (default - false)

Specifies if the remark is conditional. If it is set to "true", the remark is conditional and whether you need to answer it depends on the answer to questions with TypeDescription=”ConditionalList”.

0…1

IsPerPerson

boolean

Specifies if the remark is related to the whole offer or it is related to each guest individually. If it is set to "true", the remark is related to each guest individually. If it is set to "false", the remark is related to the whole offer.

0...1

IsMandatory*

boolean

Specifies if the remark is mandatory. If it is set to "true", the remark is mandatory. If it is set to "false", the remark isn't mandatory.

1...1

MinValue

integer

Specifies min values for remarks with TypeDescription=”NumericRange”.

0...1

MaxValue

integer

0...1

RegExpValue

string

Specifies regex for remarks with TypeDescription=” RegExpText”. RegExpValue can take on values ([A-Z]{2}).

0...1

MultiSelection

boolean

Attribute for remarks with TypeDescription=” List”. The attribute specifies whether it is allowed to choose multiple between the options from the list of ValidValues. If it is set to "true", multiple choice is allowed. If it is set to "false", multiple choice isn't allowed.

0...1

GuestUniqueID

Сontains possible response for remarks with all TypeDescription for specific travelers.

0...*

ID*

integer

Unique remark identifier.

1...1

GuestUniqueID/ValidValues/Value

string

Contains the response text for question for specific traveler.

0...*

Code

string

Corresponding to the code from ValidValues/Value element.

0...1

ConditionalValues/ConditionalValue

 

 

Specifies possible answer for remarks with TypeDescription=”ConditionalList”.

0...*

ConditionalValues/ConditionalValue/Value

 

string

Specifies possible answer value for remarks with TypeDescription=”ConditionalList”.

0...1

 

Code

string

0...1

ConditionalValues/ConditionalValue/MandatoryQuestions*

 

 

Сontains a list of remarks that need to be additionally answered depending on the answer for the remark with TypeDescription=”ConditionalList”.

1…1

ConditionalValues/ConditionalValue/MandatoryQuestions/MandatoryQuestion*

 

 

Сontains a remark that needs to be additionally answered depending on the answer for the remark with TypeDescription=”ConditionalList”.

1...*

 

ID*

integer

Unique remark identifier.

1...1

GuestUniqueID/AnswerValues/Value*

string

Contains the response text for the question.

1...*

Code

string

Corresponding to the code from ValidValues/Value element.

0...1

ValidValues/Value

string

Specifies possible answer for remarks with TypeDescription=” List”.

0...*

Code

string

0...1

ValidValues/Value

string

Specifies possible answer for remarks with TypeDescription=” List”

0...*

Code

string

0...1

 Excursion Reservation Initiate Response Sample XML
<GP_ExcursionResRS EchoToken="EchoToken" TransactionIdentifier="187001" Version="2" xmlns="http://www.opentravel.org/OTA/2003/05">
   <Success/>
   <ExcursionReservations>
      <ExcursionReservation ResStatus="Reserved">
         <Excursions>
            <Excursion>
               <ExcursionRates>
                  <ExcursionRate AvailabilityStatus="AvailableForSale" BookingCode="133d083473" RPH="1" Language="en" RateCode="1030489112#LONDDAY" RateName="Tour">
                     <Rates>
                        <Rate RateSource="Calculated" AgeQualifyingCode="10">
                           <Total AmountAfterTax="145.35" CurrencyCode="EUR"/>
                        </Rate>
                        <Rate RateSource="Calculated" AgeQualifyingCode="10">
                           <Total AmountAfterTax="145.35" CurrencyCode="EUR"/>
                        </Rate>
                        <Rate RateSource="Calculated" AgeQualifyingCode="8">
                           <Total AmountAfterTax="133.72" CurrencyCode="EUR"/>
                        </Rate>
                        <Rate RateSource="Calculated" AgeQualifyingCode="7">
                           <Total AmountAfterTax="0.00" CurrencyCode="EUR"/>
                        </Rate>
                     </Rates>
                     <RateDescription Name="paymentData">
                        <Text Language="en">Name Beds On Line, Bank: CITIBANK(Citigroup Centre, Canary Wharf, London, E14 5LB. United Kingdom) Account:ES3514740000100012272006,  SWIFT:CITIESMXXXX,  7 days prior to clients arrival (except group bookings with fixed days in advance at the time of the confirmation) . Please indicate our reference number when making payment. Thank you for your cooperation., NOTICE: SWIFT CODE CHANGED</Text>
                     </RateDescription>
                     <Total AmountAfterTax="424.42" CurrencyCode="EUR"/>
                     <CancelPenalties>
                        <CancelPenalty End="2021-10-07T23:59:59+00:00" Start="2021-10-05T00:00:00+00:00">
                           <AmountPercent Amount="424.42" CurrencyCode="EUR"/>
                        </CancelPenalty>
                     </CancelPenalties>
                  </ExcursionRate>
               </ExcursionRates>
               <ExcursionDate End="2021-10-07" Start="2021-10-07"/>
               <Total AmountAfterTax="424.42" CurrencyCode="EUR"/>
               <BasicExcursionInfo ExcursionCityCode="LON" ExcursionCode="E-U02-A0ABNO0050" ExcursionCodeContext="supplierCode" ExcursionName="London In One Day Tour with Changing of the Guard &amp; London Eye" OperatedBy="EVAN EVANS TOURS">
                  <Categories>
                     <Category Code="CTOUR">
                        <Text Language="en">City tours</Text>
                     </Category>
                  </Categories>
                  <VendorMessages>
                     <VendorMessage InfoType="2">
                        <SubSection>
                           <Paragraph>
                              <Text>Meeting point: Victoria Coach Station  // Meeting point instructions: Welcome Desk is located in-front of Gates 1 and 2: Please arrive 30 minutes before your scheduled departure time ready for boarding. // Start/Opening time: 9am // End/Closing time: 6:30pm // End point: London Eye // Inclusions: Expert Guide. Wi-Fi On-board. Personal Audio Headset. Superior Coach. USB Charging On-board. Entrance &amp; a guided tour of St. Paul's Cathedral. Entrance &amp; a guided tour of The Tower of London. 1 way River Cruise from Tower Pier to Westminster Pier. Entry to The London Eye (Standard Entry) // Exclusions: Lunch. Hotel Pick-up &amp; Drop-off.  // Mandatory instructions: The London Eye isa a standard ticket basd on timed entry between 6pm - 6:30pm on the same day // Supplier name: EVAN EVANS // Supplier emergency phone: 0044 207 950 1777  (6am - 10pm)  // Voucher type: Printed Voucher. Print and bring the voucher to enjoy the activity // 	Recommendations: At Evan Evans the health and well-being of our guests, guides, drivers and team members will always be our primary concern. We have put numerous new measures in place to elevate our hygiene standards and protocols, and to give peace of mind as travel beings to reopen. Details of our new operating protocols can be found on the following link: https://evanevanstours.com/travel-guide/experts-in-sightseeing/travel-health/		
					.</Text>
                           </Paragraph>
                        </SubSection>
                     </VendorMessage>
                  </VendorMessages>
               </BasicExcursionInfo>
            </Excursion>
         </Excursions>
         <ResGuests>
         <ResGuests>
            <ResGuest AgeQualifyingCode="10" ResGuestRPH="1">
               <Profiles>
                  <ProfileInfo>
                     <UniqueID ID="1" Type="1"/>
                     <Profile>
                        <Customer BirthDate="1980-06-12">
                           <PersonName>
                              <NamePrefix>Mr</NamePrefix>
                              <GivenName>Serge</GivenName>
                              <Surname>Courtois</Surname>
                           </PersonName>
                           <Telephone PhoneNumber="+2324234234"/>
                           <Email>test@gpsolutions.com</Email>
                           <CitizenCountryName Code="KW"/>
                        </Customer>
                     </Profile>
                  </ProfileInfo>
               </Profiles>
            </ResGuest>
            <ResGuest AgeQualifyingCode="10" ResGuestRPH="1">
               <Profiles>
                  <ProfileInfo>
                     <UniqueID ID="2" Type="1"/>
                     <Profile>
                        <Customer BirthDate="2003-06-12">
                           <PersonName>
                              <NamePrefix>Mrs</NamePrefix>
                              <GivenName>Thibault</GivenName>
                              <Surname>Courtois</Surname>
                           </PersonName>
                        </Customer>
                     </Profile>
                  </ProfileInfo>
               </Profiles>
            </ResGuest>
            <ResGuest AgeQualifyingCode="8" ResGuestRPH="1">
               <Profiles>
                  <ProfileInfo>
                     <UniqueID ID="3" Type="1"/>
                     <Profile>
                        <Customer BirthDate="2014-11-12">
                           <PersonName>
                              <NamePrefix>Mr</NamePrefix>
                              <GivenName>Mary</GivenName>
                              <Surname>Courtois</Surname>
                           </PersonName>
                        </Customer>
                     </Profile>
                  </ProfileInfo>
               </Profiles>
            </ResGuest>
            <ResGuest AgeQualifyingCode="7" ResGuestRPH="1">
               <Profiles>
                  <ProfileInfo>
                     <UniqueID ID="4" Type="1"/>
                     <Profile>
                        <Customer BirthDate="2019-11-12">
                           <PersonName>
                              <NamePrefix>Mr</NamePrefix>
                              <GivenName>John</GivenName>
                              <Surname>Courtois</Surname>
                           </PersonName>
                        </Customer>
                     </Profile>
                  </ProfileInfo>
               </Profiles>
            </ResGuest>
         </ResGuests>
         <ResGlobalInfo>
            <Comments>
               <Comment>
                  <Text>Please, arrange vegetarian meal.</Text>
               </Comment>
            </Comments>
            <ExcursionReservationIDs>
               <ExcursionReservationID ResID_Source="agent" ResID_Value="hjo8dfg"/>
               <ExcursionReservationID ResID_Source="client" ResID_Value="34rf4g3frre45"/>
            </ExcursionReservationIDs>
         </ResGlobalInfo>
      </ExcursionReservation>
   </ExcursionReservations>
</GP_ExcursionResRS>
  • No labels