Versions Compared

Version Old Version 1 New Version Current
Changes made by

Yana Brilevskaya

Yana Brilevskaya

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: HUB-11252 TransferRate/@VehQuantity attribute was added

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

GP_TransferResRS*:

*mandatory

Element

Attribute

Type

Description

Min…Max occurs

TransactionIdentifier

Unique transaction ID generated by GP Travel 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

0...99

TransferReservations/TransferReservation*

Represents booking information.

1...1

ResStatus*

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

The reservation status that can be one of:

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

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

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

1...1

TransferReservations/TransferReservation/Transfers/Transfer*

Represents a transfer details.

1...*

TransferReservations/TransferReservation/ResGuests/ResGuest*

For more information see Reservation Initiate Request section.

1...*

TransferReservations/TransferReservation/ResGlobalInfo*

For more information see Reservation Initiate Request section.

1...1

GP_TransferResRS/TransferReservations/TransferReservation/Transfers/Transfer*:

Element

Attribute

Type

Description

Min…Max occurs

TransferRates/TransferRate*

Describes transfer offer.

1...1

TransferDate*

For more information see Common Data Description section in Glossary.

1...1

TransferSegments/TransferSegment

Describes Pick-Up and Drop-Off point of the transfer.

0..1

TransferSegments/TransferSegment/TransferPickUpDetails*

For more information see Reservation Initiate Request section.

0..1

TransferSegments/TransferSegment/TransferDropOffDetails*

0..1

Total*

Total offer price for all requested travelers.

1...1

CurrencyCode*

For more information see Common Data Description section in Glossary.

1...1

AmountAfterTax*

1...1

BasicTransferInfo*

Contains general information about transfer.

1...1

GP_TransferResRS/TransferReservations/TransferReservation/Transfers/Transfer/TransferRates/TransferRate*:

Element

Attribute

Type

Description

Min…Max occurs

RateCode*

string (1 - 64)

Offer code as returned by supplier.

1..1

RateName*

string (1 - 255)

Offer name as returned by supplier.

1..1

AvailabilityStatus*

PromotionCode

string(

"AvailableForSale", "OnRequest"

“DI”)

Offer availability, whether it is

Indicates whether the offer comes from Dynamic Inventory.

Info

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

0..1

AvailabilityStatus*

string ("AvailableForSale", "OnRequest")

Offer availability, whether it is immediately available (AvailableForSale) or on request (OnRequest).

1...1

BookingCode*

string

An unique offer identifier for further transfer reservation step.

1..1

Language*

For more information see Common Data Description section in Glossary.

1..1

Type*

string ("Group", "Individual", "UNKNOWN")

Identifies if the transfer is private (“Individual”) or public (“Group”) or undefined (“UNKNOWNmi”).

1..1

RPH*

integer (1)

A transfer identifier. Must start from 1 and must be unique within booking. Together with ResGuestRPH this element allows to allocate passengers in transfers.

1..1

Rates/Rate*

For more information see Transfer Availability Response section.

1...*

Rates/Rate/Total*

1...1

Rates/Rate/TotalRetail

0...1

RateDescription

0...

VehQuantity

integer

Determines the number of vehicles provided at a given rate to transport all res guests.

0..1

DriverLanguage

 

 

Language in which transfer is operated.

0..1

Type*

string (“Undefined”,“Unescorted”,“Local”, “List”)

The next values are possible as Type options:

  • “Undefined” - in case the language is not provided by supplier;

  • “Unescorted” - in case transfer does not require speaker assistance; this information should be provided by supplier;

  • “Local” - in case transfer operates in local language; this information should be provided by supplier.

  • “List” - in case transfer supplier provides transfer language

1...1

DriverLanguage/LanguageList/Language

 

 

 

0..*

Code*

2-character ISO language code

Language code in which transfer is operated.

1..1

Rates/Rate*

For more information see Transfer Availability Response section.

1...*

Rates/Rate/Total*

1...1

Rates/Rate/TotalRetail

0...1

RateDescription

0...1

Services/Service

 

 

Additional services that can be booked with transfer.  

Info

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

Info

Note: In Reservation Initiate and Confirmation Responses price for the service is always included in Total Price.

Info

Note: In Reservation Initiate and Confirmation Responses Inclusive attribute will always have value Inclulsive=“true“.

Attributes remain the same as in Transfer Availability Response with additional attribute in Price element:

0..*

Services/Service/Price

GuestUniqueId

integer

If IsPerPerson=true in the Transfer Availability response, a Price element is returned for each pax for which a service with the GuestUniqueId attribute is booked.

0..1

AdditionalQuestions/AdditionalQuestion

Remarks from supplier.

Info

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

0...*

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 – 999)

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

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.

0...1

MinValue

integer

Specifies min and max 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

AdditionalQuestions/AdditionalQuestion/GuestUniqueID

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

0...*

ID*

integer

Unique remark identifier.

1...1

AdditionalQuestions/AdditionalQuestion/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

AdditionalQuestions/AdditionalQuestion/GuestUniqueID/AnswerValues/Value*

string

Contains the response text for the question.

1...*

Code

string

Corresponding to the code from ValidValues/Value element.

0...1

AdditionalQuestions/AdditionalQuestion/ValidValues/Value

string

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

0...*

Code

string

0...1

Total*

For more information see Transfer Availability Response section.

1...1

Occupancy

0..1

CancelPenalties/CancelPenalty*

For more information see Transfer Charges section.

1...*

GP_TransferResRS/TransferReservations/TransferReservation/Transfers/Transfer/BasicTransferInfo*:

Element

Attribute

Type

Description

Min…Max occurs

TransferCode*

string (1 - 32)

Transfer code as returned by supplier.

1..1

TransferName*

string (1 - 255)

Transfer name as returned by supplier.

1..1

TransferCodeContext*

string (1 - 32)

Supplier name who provides this transfer.

1..1

OperatedBy

string (1 - 255)

Indicates what exact company operates this transfer.

0..1

TransferDuration

double

Shows duration of transfer in hours. TransferDuration=”3.5” means that the transfer takes 3 hours and 30 minutes.

0..1

HotelCodeSupported

boolean

Identifies if Hotel Code is submitted for transfer reservation.

0..1

AddressSupported

boolean

Identifies if free Address submitted for transfer reservation.

0..1

Categories/Category

 

 

For more information see Transfer Availability Response section.

0...*

TransferDeparture*

Transfer’s departure point as it is provided as supplier’s offer. Attributes are the same as were specified in TransferDeparture element in Transfer Availability Request.

1..1

TransferDestination*

Transfer’s destination point as it is provided as supplier’s offer. Attributes are the same as were specified in TransferDestination element in Transfer Availability Request.

1..1

VendorMessages/VendorMessage

For more information see Transfer Availability Response section.

0...99

Expand
titleTransfer Reservation Initiate Response Sample XML - 1 adults 1 child
Code Block
languagexml
<GP_TransferResRS xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="EchoToken" TransactionIdentifier="188039" Version="2.0">
  <Success/>
  <Warnings>
    <Warning Code="209" Language="en" RecordID="supplierCode" ShortText="Transfer time has been changed" Status="SENT" Type="3">Transfer time has been changed to flight arrival time since the driver of the pickup car will check when the plane will land in order to be at the airport at the correct time.</Warning>
  </Warnings>
  <TransferReservations>
    <TransferReservation ResStatus="Reserved">
      <Transfers>
        <Transfer>
          <TransferRates>
            <TransferRate AvailabilityStatus="AvailableForSale" BookingCode="134b5074a6" Language="Undefined" RPH="1" RateCode="BS" RateName="Shared - Shuttle. Standard. Minivan" Type="Group">
              <Rates>
                <Rate AgeQualifyingCode="10" RateSource="Calculated">
                  <Total AmountAfterTax="26.71" CurrencyCode="EUR"/>
                </Rate>
                <Rate AgeQualifyingCode="8" RateSource="Calculated">
                  <Total AmountAfterTax="26.71" CurrencyCode="EUR"/>
                </Rate>
              </Rates>
              <RateDescription Name="ZRH SHRD ARAT20"/>
              <Total AmountAfterTax="53.42" CurrencyCode="EUR"/>
              <CancelPenalties>
                <CancelPenalty End="2020-10-29T23:59:59" Start="2020-10-28T00:00:00">
                  <AmountPercent Amount="53.42" CurrencyCode="EUR"/>
                </CancelPenalty>
              </CancelPenalties>
            </TransferRate>
          </TransferRates>
          <TransferDate DateTime="2020-10-29T14:00:00"/>
          <TransferSegments>
            <TransferSegment>
              <TransferPickUpDetails>
                <FlightDetails ArrivalCode="ZRH" CodeContext="IATA" DepartureCode="MSQ" FlightDateTime="2020-10-29T14:00:00" FlightNumber="KK999"/>
              </TransferPickUpDetails>
              <TransferDropOffDetails>
                <Hotel HotelCode="6419" HotelCodeContext="supplierCode" HotelName="Leonardo Boutique Hotel Rigihof Zurich"/>
              </TransferDropOffDetails>
            </TransferSegment>
          </TransferSegments>
          <Total AmountAfterTax="53.42" CurrencyCode="EUR"/>
          <BasicTransferInfo TransferCode="ZRH-ZRH#218-ZURICH#BS" TransferCodeContext="supplierCode" TransferName="Zürich, Kloten Airport(ZRH) - Zurich(Zurich zone)">
            <TransferDeparture CodeContext="supplierCode" LocationCode="ZRH" LocationType="Airport"/>
            <TransferDestination CodeContext="supplierCode" LocationCode="ZRH" LocationType="City"/>
            <VendorMessages>
              <VendorMessage InfoType="1">
                <SubSection>
                  <Paragraph>
                    <Text>Maximum</Text>
                  </Paragraph>
                </SubSection>
              </VendorMessage>
              <VendorMessage InfoType="1">
                <SubSection>
                  <Paragraph>
                    <Text>1 item of hand baggage allowed per person</Text>
                  </Paragraph>
                </SubSection>
              </VendorMessage>
              <VendorMessage InfoType="1">
                <SubSection>
                  <Paragraph>
                    <Text>1 piece of baggage allowed per person ( max.dimensions 158cm) length+width+height=158cm</Text>
                  </Paragraph>
                </SubSection>
              </VendorMessage>
              <VendorMessage InfoType="4">
                <SubSection>
                  <Paragraph>
                    <Text>In the event of being unable to locate the driver, please call the emergency number indicated in this voucher.</Text>
                  </Paragraph>
                </SubSection>
              </VendorMessage>
              <VendorMessage InfoType="4">
                <SubSection>
                  <Paragraph>
                    <Text>Remember to bring a printed copy of this voucher and a valid photo ID with you.</Text>
                  </Paragraph>
                </SubSection>
              </VendorMessage>
              <VendorMessage InfoType="4">
                <SubSection>
                  <Paragraph>
                    <Text>Child car seats and boosters are not included unless specified in your booking and can carry an extra cost. Should you need to book them, please contact your point of sale prior to travelling.</Text>
                  </Paragraph>
                </SubSection>
              </VendorMessage>
              <VendorMessage InfoType="4">
                <SubSection>
                  <Paragraph>
                    <Text>Adapted vehicles are suitable for foldable wheelchairs. If the wheelchair cannot be folded, an extra cost may be applicable for customers</Text>
                  </Paragraph>
                </SubSection>
              </VendorMessage>
              <VendorMessage InfoType="4">
                <SubSection>
                  <Paragraph>
                    <Text>Domestic arrivals: Journeys made within the borders of the same country OR journeys made within European airspace (Schengen) OR from Schengen space to any of these countries: Bulgaria, Cyprus, Croatia, Ireland, United Kingdom and Romania. Passengers do not have to go through customs controll</Text>
                  </Paragraph>
                </SubSection>
              </VendorMessage>
              <VendorMessage InfoType="4">
                <SubSection>
                  <Paragraph>
                    <Text>International arrivals: Journeys where the departure and the arrival take place in different countries OR journeys made with the origin outside of European airspace (Schengen) and arrival into it. Passengers must pass through customs control.</Text>
                  </Paragraph>
                </SubSection>
              </VendorMessage>
              <VendorMessage InfoType="4">
                <SubSection>
                  <Paragraph>
                    <Text>Once you have collected your luggage, a staff member will be waiting for you at the Arrivals Hall with a sign with your name on it. If you are unable to locate the driver/agent, please call ARATOURS GmbH  on 0041 797 987 777. Languages spoken at the call centre: English. Please do not leave the pick-up area without having contacted the agent/driver first. If the supplier doesn't answer the phone, please call our emergency telephone number listed at the bottom of the voucher before leaving the pick-up area.</Text>
                  </Paragraph>
                </SubSection>
              </VendorMessage>
              <VendorMessage InfoType="4">
                <SubSection>
                  <Paragraph>
                    <Text>Extra baggage allowed without additional fees per person</Text>
                  </Paragraph>
                </SubSection>
              </VendorMessage>
              <VendorMessage InfoType="5">
                <SubSection>
                  <Paragraph>
                    <Text>Maximum waiting time: 60 minutes</Text>
                  </Paragraph>
                </SubSection>
              </VendorMessage>
              <VendorMessage InfoType="5">
                <SubSection>
                  <Paragraph>
                    <Text>Maximum waiting time for domestic flights: 60 minutes</Text>
                  </Paragraph>
                </SubSection>
              </VendorMessage>
              <VendorMessage InfoType="5">
                <SubSection>
                  <Paragraph>
                    <Text>Maximum waiting time for international flights: 90 minutes</Text>
                  </Paragraph>
                </SubSection>
              </VendorMessage>
            </VendorMessages>
          </BasicTransferInfo>
        </Transfer>
      </Transfers>
      <ResGuests>
        <ResGuest AgeQualifyingCode="10" ResGuestRPH="1">
          <Profiles>
            <ProfileInfo>
              <UniqueID ID="1"/>
              <Profile>
                <Customer>
                  <PersonName>
                    <NamePrefix>Mr</NamePrefix>
                    <GivenName>Gastarbaiter</GivenName>
                    <Surname>Eins</Surname>
                  </PersonName>
                  <CitizenCountryName Code="MC"/>
                </Customer>
              </Profile>
            </ProfileInfo>
          </Profiles>
        </ResGuest>
        <ResGuest AgeQualifyingCode="8" ResGuestRPH="1">
          <Profiles>
            <ProfileInfo>
              <UniqueID ID="2"/>
              <Profile>
                <Customer BirthDate="2011-01-01">
                  <PersonName>
                    <NamePrefix>Mr</NamePrefix>
                    <GivenName>Gastarbaiter</GivenName>
                    <Surname>Zwei</Surname>
                  </PersonName>
                  <CitizenCountryName Code="MC"/>
                </Customer>
              </Profile>
            </ProfileInfo>
          </Profiles>
        </ResGuest>
      </ResGuests>
      <ResGlobalInfo>
        <Comments>
          <Comment>
            <Text>comment example</Text>
          </Comment>
        </Comments>
        <TransferReservationIDs>
          <TransferReservationID ResID_Source="agent" ResID_Value="4b4faca6ag"/>
          <TransferReservationID ResID_Source="client" ResID_Value="4b4faca6"/>
        </TransferReservationIDs>
      </ResGlobalInfo>
    </TransferReservation>
  </TransferReservations>
</GP_TransferResRS>