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 2 Current »

Reservation Confirmation Response returns information about booking that has been made, it's status, and reservation IDs.

GP_VehResRS*:

*mandatory

Element

Attribute

Type

Description

Min…Max occurs

Success

For more information see Common Data Description section in Glossary.

Warnings/Warning

VehResRSCore/VehReservation

Represents the car reservation.

0...1

GP_VehResRS/VehResRSCore/VehReservation:

Element

Attribute

Type

Description

Min…Max occurs

ResStatus*

string ("Reserved", "Waitlisted", "Request denied")

A reservation status that can be one of:

"Reserved" - means that car was successfully reserved in supplier’s inventory.

"Waitlisted" - means that booking is waiting for confirmation. In this case you need to send Booking Retrieval request to get an actual state of booking.

"Request denied - means that supplier rejected booking.

1...1

VehSegmentCore*

All elements are the same as in Reservation Initiate Response, but there are no BookingCode and AvailabilityStatus in VehRentalCore in Reservation Confirmation Response.

1...1

ResGuests/ResGuest*

For more information see Reservation Initiate Request section.

1...*

VehSegmentInfo*

Supplemental information associated with the vendor and cars availability .

1...1

TPA_Extensions

Contains additional information (e.g. messages and data that should be included into voucher according suppliers requirements).

0...1

TPA_Extensions/VoucherProperties/Property

Represents a piece of voucher details.

Note: VoucherProperties element contains only the information that is not available through other elements in GP Travel HUB messages.

0..*

Name*

string

An information identifier. Normally it has the value similar to voucher’s field. Following properties names are recommended to use: “vat”, ”notes”, ”payableThrough”, ”itemPayableBy”, ”emergencyPhone”, ”confirmationNumber”, ”Latitude”, ”Longitude”, ”meals”, ”ItemConfirmationReference”, ”policyRemark”, ”policyDescription”,” bookingReferenceNumber”, ”paymentGuaranteedBy”.

1..1

Value*

string

Contains the value that should be put in Voucher.

1..1

GP_VehResRS/VehResRSCore/VehReservation/VehSegmentCore*:

Element

Attribute

Type

Description

Min…Max occurs

Vendor

 

 

 

 

 

Represents vendor. The element exists only if the information available from supplier.

0...1

CompanyShortName*

string (1 - 32)

Specifies vendor's name.

1...1

Code*

string (1 - 32)

Specifies vendor's code.

1...1

CodeContext*

string (1 - 32)

Supplier code context.

1...1

VehRentalCore*

 

 

 

 

Contains information that is common to all requests and responses associated with the reservation of a car.

1...1

PickUpDateTime*

yyyy-mm-dd or yyyy-mm-ddThh-mm-ss

Identify The Date & Time to pickup/return a car.

1...1

ReturnDateTime*

yyyy-mm-dd or yyyy-mm-ddThh-mm-ss

1...1

VehRentalCore/PickUpLocation*

Identifies pickup location.

1...1

Name*

string (1 - 255)

Name of the pickup location.

1...1

CodeContext*

string (1 - 32)

Defines context in which the LocationCode is specified:

for “Airport” point there must be IATA airport code;

for “City” point there could be GEO or supplier or client context;

for “Point” type here must be supplier identifier.

1...1

LocationCode*

string (1 - 32)

Depending on LocationType: specify IATA Airport code for “Airport” type; specify City Code for “City” type; specify supplier-specific location code for “Point” type.

1...1

VehRentalCore/ReturnLocation*

Identifies return location.

1...1

Name*

string (1 - 255)

Name of the return location.

1...1

CodeContext*

string (1 - 32)

Attributes description is the same as in PickUpLocation element mentioned above.

1...1

LocationCode*

string (1 - 32)

1...1

Vehicle*

 

 

Elements and attributes are the same as in Car Availability Search Response, but VendorCarType attribute is missed in this message. Also TransmissionType, Veh Class and Size, PictureURL and VehIdentity are mandatory for Reservation Confirmation Response.

1...1

RentalRate

 

 

For more information see Car Availability Response section.

0...1

PricedEquips/PricedEquip

 

 

For more information see Car Rental Conditions Response section.

0...25

Liabilities/Coverages/Coverage

 

 

For more information see Car Rental Location Detail Response section.

0...99

Fees/Fee

 

 

 

 

 

 Contains information about specific fee.

0...99

Amount*

 

For more information see Common Data Description section in Glossary.

1...1

CurrencyCode*

 

1...1

Purpose*

integer (6, 22, 23)

Refers to the list of Vehicle Charge Purpose Types supported by HUB. Possible values: “6” - Fee, “22” - Prepay amount, “23” - Pay on arrival amount.

1...1

CancelPenalties/CancelPenalty

 

 

For more information see Car Rental Conditions Response section.

0...*

TotalCharge*

 

 

For more information see Car Availability Response section.

1...1

TotalRetailCharge

 

 

0...1

GP_VehResRS/VehResRSCore/VehReservation/VehSegmentInfo*:

Element

Attribute

Type

Description

Min…Max occurs

PaymentRules/PaymentRule

Payment rule associated with this reservation.

0...9

Amount*

For more information see Common Data Description section in Glossary.

1...1

CurrencyCode*

1...1

RuleType*

integer (1 - 4)

Refers to OTA Code List Rule Type (RUL). Possible values: “1” -Cancel, “2” - Prepay, “3” - Deposit, “4” - Guarantee.

1...1

DateTime

yyyy-mm-dd or yyyy-mm-ddThh-mm-ss

The date and time applicable to this monetary rule. For Cancellation rule (@RuleType=”1”) DateTime means date and time when the rule starts.

0...1

RentalPaymentAmount

Provides payment information.

0...1

CostCenterID*

string (1 - 32)

A CostCenter code that depends on supplier specific and contract between supplier and client. CostCenterID identifies the payment acceptor.

1...1

VendorMessages/VendorMessage

For more information see Car Availability Response section.

0...99

LocationDetails*

Elements and attributes are the same as in Car Rental Location Detail Response, but AdditionalInfo element is missed in this message.

1...2

CarReservationIDs/CarReservationID*

Unique rental reference. For more information see Unique Identifiers in GP Travel HUB Workflow section in Glossary.

1...*

ResID_Value*

string (1 - 64)

A value of booking reference that is generated by client application. It is supposed that this ID will be unique in your system. Can be used for further operations like cancellation or booking retrieval.

1...1

ResID_Source*

string (“client, agent“, “supplier“)

Allows to pass booking reference that is generated by application connecting to GP Travel HUB for identification of each booking.

1...1

ResID_SourceContext

string (1 - 64)

Additional attribute in case ResID_Source="supplier", contains supplier code to identify from which supplier this booking has been made.

0...1

 Car Reservation Confirmation Response Sample XML - 2 adults 1 infant
<GP_VehResRS xmlns="http://www.opentravel.org/OTA/2003/05" EchoToken="EchoToken" Version="2.0">
  <Success/>
  <VehResRSCore>
    <VehReservation ResStatus="Reserved">
      <VehSegmentCore>
        <Vendor Code="Vehicle" CodeContext="supplierCode" CompanyShortName="CompanyName"/>
        <VehRentalCore PickUpDateTime="2023-10-13T15:20:00" ReturnDateTime="2023-10-23T19:00:00">
          <PickUpLocation CodeContext="supplierCode" LocationCode="W42" Name="Midtown (between 10th &amp; 11th Avenues)"/>
          <ReturnLocation CodeContext="supplierCode" LocationCode="E43" Name="Midtown Manhattan E 43rd Street"/>
        </VehRentalCore>
        <Vehicle AirConditionInd="true" BaggageQuantity="3" Code="CCAR1JE" CodeContext="supplierCode" DriveType="Unspecified" FuelType="Unspecified" PassengerQuantity="3" TransmissionType="Automatic">
          <VehType DoorCount="4" VehicleCategory="1"/>
          <VehClass Size="4"/>
          <VehMakeModel Code="CCAR" Name="Group B - Ford Focus or similar"/>
          <PictureURL>https://www.avisloyalty.eu/assets/fleetmedium/Ford_Focus_2016.jpg</PictureURL>
          <VehIdentity VehicleAssetNumber="Unknown"/>
        </Vehicle>
        <RentalRate>
          <VehicleCharges>
            <VehicleCharge Amount="535.40" CurrencyCode="USD" Description="Minimum 2 Day(s)" IncludedInRate="true" Purpose="1" TaxInclusive="true"/>
            <VehicleCharge Amount="0.00" CurrencyCode="USD" Description="$10.00    EXTENSION FEE MAY APPLY" IncludedInRate="false" Purpose="28" TaxInclusive="false"/>
            <VehicleCharge Amount="0.00" CurrencyCode="USD" Description="FUEL POLICY IS FULL TO FULL" IncludedInRate="false" Purpose="28" TaxInclusive="false"/>
            <VehicleCharge Amount="0.00" CurrencyCode="USD" Description="$15.00    LATE FEE MAY APPLY" IncludedInRate="false" Purpose="28" TaxInclusive="false"/>
          </VehicleCharges>
          <RateQualifier VendorRateID="JE"/>
        </RentalRate>
        <PricedEquips>
          <PricedEquip>
            <Equipment EquipType="7" Quantity="1">
              <Description>Child Infant Seat</Description>
            </Equipment>
            <Charge Amount="70.00" CurrencyCode="USD" IncludedInRate="false" TaxInclusive="false"/>
          </PricedEquip>
          <PricedEquip>
            <Equipment EquipType="13" Quantity="1">
              <Description>GPS Unit</Description>
            </Equipment>
            <Charge Amount="147.55" CurrencyCode="USD" IncludedInRate="false" TaxInclusive="false"/>
          </PricedEquip>
        </PricedEquips>
        <Fees>
          <Fee Amount="0.00" CurrencyCode="USD" Purpose="23"/>
        </Fees>
        <CancelPenalties>
          <CancelPenalty End="2020-10-13T23:59:59" Start="2020-10-13T15:20:00">
            <AmountPercent Amount="535.40" CurrencyCode="USD"/>
            <PenaltyDescription Language="en">
              <Text>No cancellation fee will be charged if the rental is cancelled prior to rental commencement. No refund will apply on unused rental days once the rental has commenced.</Text>
            </PenaltyDescription>
          </CancelPenalty>
        </CancelPenalties>
        <TotalCharge CurrencyCode="USD" EstimatedTotalAmount="752.95"/>
      </VehSegmentCore>
      <ResGuests>
        <ResGuest AgeQualifyingCode="10" ResGuestRPH="1">
          <Profiles>
            <ProfileInfo>
              <UniqueID ID="1" Type="1"/>
              <Profile>
                <Customer BirthDate="1990-05-01">
                  <PersonName>
                    <NamePrefix>Mr</NamePrefix>
                    <GivenName>Jeck</GivenName>
                    <Surname>Decline</Surname>
                  </PersonName>
                  <Telephone PhoneNumber="239875443"/>
                  <Email>test@gpsolutions.com</Email>
                  <Address>
                    <AddressLine>11-53, 92 Str.</AddressLine>
                    <CityName>LittleCity</CityName>
                    <PostalCode>234633</PostalCode>
                    <StateProv>New York</StateProv>
                    <CountryName Code="US">New York</CountryName>
                  </Address>
                </Customer>
              </Profile>
            </ProfileInfo>
          </Profiles>
        </ResGuest>
        <ResGuest AgeQualifyingCode="10" ResGuestRPH="1">
          <Profiles>
            <ProfileInfo>
              <UniqueID ID="2" Type="1"/>
              <Profile>
                <Customer BirthDate="1986-11-01">
                  <PersonName>
                    <NamePrefix>Mrs</NamePrefix>
                    <GivenName>Olga</GivenName>
                    <Surname>Decline</Surname>
                  </PersonName>
                </Customer>
              </Profile>
            </ProfileInfo>
          </Profiles>
        </ResGuest>
        <ResGuest AgeQualifyingCode="7" ResGuestRPH="1">
          <Profiles>
            <ProfileInfo>
              <UniqueID ID="3" Type="1"/>
              <Profile>
                <Customer BirthDate="2019-11-01">
                  <PersonName>
                    <NamePrefix>Mr</NamePrefix>
                    <GivenName>Bob</GivenName>
                    <Surname>Decline</Surname>
                  </PersonName>
                </Customer>
              </Profile>
            </ProfileInfo>
          </Profiles>
        </ResGuest>
      </ResGuests>
      <VehSegmentInfo>
        <LocationDetails AtAirport="false" Code="W42" CodeContext="supplierCode" Name="Midtown (between 10th &amp; 11th Avenues)">
          <Address>
            <AddressLine>515 West 43rd Street</AddressLine>
            <CityName>New York City</CityName>
            <PostalCode>10036</PostalCode>
            <StateProv StateCode="NY">New York</StateProv>
            <CountryName Code="US">U S A</CountryName>
          </Address>
          <Telephone PhoneNumber="(1) 646-473-0088"/>
        </LocationDetails>
        <LocationDetails AtAirport="false" Code="E43" CodeContext="supplierCode" Name="Midtown Manhattan E 43rd Street">
          <Address>
            <AddressLine>225 East 43rd Street (Between 2nd Ave &amp; 3rd Ave)</AddressLine>
            <CityName>New York City</CityName>
            <PostalCode>10017</PostalCode>
            <StateProv StateCode="NY">New York</StateProv>
            <CountryName Code="US">U S A</CountryName>
          </Address>
          <Telephone PhoneNumber="(1) 212-682-1860"/>
        </LocationDetails>
        <CarReservationIDs>
          <CarReservationID ResID_Source="agent" ResID_Value="adfbgy2"/>
          <CarReservationID ResID_Source="client" ResID_Value="opinjdn354sfda"/>
          <CarReservationID ResID_Source="supplier" ResID_Value="13589936US3"/>
        </CarReservationIDs>
      </VehSegmentInfo>
      <TPA_Extensions>
        <VoucherProperties>
          <Property Name="accountNo" Value="AA0000000000"/>
          <Property Name="aanOrIata" Value="0123456N"/>
          <Property Name="agentName" Value="SergeyM"/>
        </VoucherProperties>
      </TPA_Extensions>
    </VehReservation>
  </VehResRSCore>
</GP_VehResRS>
  • No labels

0 Comments

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.