Search Charge Conditions

The Search Charge Conditions provides the client with a means of determining charge conditions for either booked items or potential booking items. All requests will need to be sent in a SYNCHRONOUS mode; any requests send in an ASYNCHRONOUS will return an error.

Source Parameters

Please refer to the API Architecture document.

Search Charge Conditions Request parameters

The XML Search Charge Conditions Request can be used to request charge conditions for the following: -

  • A booked item whose details are contained within <ChargeConditionsBookingItem>
  • A potential booking item.

NOTE: Information provided for each item type must be sufficient to identify a bookable item that can be separately priced. For example the identification of an apartment item must include the unique item and unit code combination.

The following item types are allowed: -

  • A potential apartment booking contained within <ChargeConditionsApartment>
  • A potential hotel booking contained within <ChargeConditionsHotel>
  • A potential sightseeing booking contained within <ChargeConditionsSightseeing>
  • A potential transfer booking contained within <ChargeConditionsTransfer>

Booking Item Charge Conditions

The XML message below gives a sample of the expected elements needed by the API to execute a Search Charge Conditions Request for a booked item.

<?xml version="1.0" encoding="UTF-8"?>
<Request>
  <Source>
<RequestorID Client="123456" EMailAddress="clientName@client.co.uk" Password="clientPassword" />
    <RequestorPreferences Language="en">
		  <RequestMode>SYNCHRONOUS</RequestMode> 
    </RequestorPreferences>
  </Source>
	<RequestDetails>
		<SearchChargeConditionsRequest>
                 <DateFormatResponse/>

		<ChargeConditionsBookingItem>
			<BookingReference>BOOK1002</BookingReference>
			<ItemReference>1</ItemReference>
		</ChargeConditionsBookingItem>
		</SearchChargeConditionsRequest>
	</RequestDetails>
</Request>

Booking Item Charge Conditions parameters

This request will be used to retrieve charge conditions for a booked item. The following sub-elements must be specified:

Element

Description

DateFormatResponse

Optional. If present the ‘FromDay’ and ‘ToDay’ attributes of the <SearchChargeConditionsResponse> will be returned as ‘FromDate’ and ‘ToDate’ attributes instead and the values will be returned in date format rather than as days prior to arrival.

BookingReference

Mandatory. This will contain a reference to identify booking(s).

 

Attribute

Description

 

ReferenceSource

Values allowed (if not specified will default to “client”): -

  • “client” - the unique client reference. If found this would return a single booking.
  • “api” - the unique GTA reference. If found this would return a single booking.

ItemReference

Mandatory. The breakdown will be given for the booking item with the specified item reference.


Apartment Charge Conditions

The XML message below gives a sample of the expected elements needed by the API to execute a Search Charge Conditions Request for a potential apartment item.

 

<?xml version="1.0" encoding="UTF-8"?>
<Request>
  <Source>
<RequestorID Client="123456" EMailAddress="clientName@client.co.uk" Password="clientPassword" />
    <RequestorPreferences Language="en">
		  <RequestMode>SYNCHRONOUS</RequestMode> 
    </RequestorPreferences>
  </Source>
	<RequestDetails>
	<SearchChargeConditionsRequest>
              <DateFormatResponse/>
		<ChargeConditionsApartment>
			<City>PAR</City>
			<Item>BRI6</Item>
			<UnitCode>SC</UnitCode>
			<PeriodOfStay>
				<CheckInDate>2005-07-10</CheckInDate>
				<Duration>7</Duration>
			</PeriodOfStay>
			<Occupancy>
            	<NumberOfAdults>3</NumberOfAdults>
	           <Children>
    	       		<Age>5</Age>
	           	<Age>10</Age>
       	    	</Children>
            	<NumberOfCots>1</NumberOfCots>
			</Occupancy>
		</ChargeConditionsApartment>
	</SearchChargeConditionsRequest>
	</RequestDetails>
</Request>

A price for the apartment must be available for the period of stay specified.

Apartment Charge Conditions parameters

This request will be used to retrieve charge conditions for a potential apartment item. The following sub-elements must be specified: 

Parameters

Description

DateFormatResponse

Optional. If present the ‘FromDay’ and ‘ToDay’ attributes of the <SearchChargeConditionsResponse> will be returned as ‘FromDate’ and ‘ToDate’ attributes instead and the values will be returned in date format rather than as days prior to arrival.

City

Mandatory. Specifies the city for the Item.

Item

Mandatory. Specifies the item (apartment) for which the charge conditions are required.

UnitCode

Mandatory. Specifies the GTA unit code for the apartment.

PeriodOfStay

Mandatory. Defines the check-in day and either the check-out day or the duration of stay.

Occupancy

Mandatory. Defines the combination of adults, children and requested cots for the stay.


Occupancy element 

The <Occupancy> element can have the following sub-elements:

Element

Description

NumberOfAdults

Mandatory. This will contain the number of adults to be included in the price for apartment item. Must be in the range 1 to 9 inclusive.

Children

Optional. A list of <Age> elements specifying the children’s ages, which must be between 2 and 18 inclusive.

NumberOfCots

Optional. The number of required cots, up to a maximum value of 2 inclusive.


Hotel Charge Conditions

The XML message below gives a sample of the expected elements needed by the API to execute a Search Charge Conditions Request for a potential hotel item.

 

<?xml version="1.0" encoding="UTF-8"?>
<Request>
  <Source>
<RequestorID Client="123456" EMailAddress="clientName@client.co.uk" Password="clientPassword" />
    <RequestorPreferences Language="en">
		  <RequestMode>SYNCHRONOUS</RequestMode> 
    </RequestorPreferences>
  </Source>
	<RequestDetails>
	<SearchChargeConditionsRequest>
          <DateFormatResponse/>
		<ChargeConditionsHotel>
			<City>AMS</City>
			<Item>APP</Item>
			<PeriodOfStay>
				<CheckInDate>2005-05-29</CheckInDate>
				<Duration>10</Duration>
			</PeriodOfStay>
			<Rooms>
				<Room Code="TB" NumberOfCots="1">
					<ExtraBeds>
						<Age>14</Age>
					</ExtraBeds>
				</Room>
			</Rooms>
		</ChargeConditionsHotel>
	</SearchChargeConditionsRequest>
	</RequestDetails>
</Request>

Table 1. Search Charge Condition search request. Flat structure (Participation Level 0).

<?xml version="1.0" encoding="UTF-8"?>
<Request>
  <Source>
<RequestorID Client="123456" EMailAddress="clientName@client.co.uk" Password="clientPassword" />
    <RequestorPreferences Language="en">
		  <RequestMode>SYNCHRONOUS</RequestMode> 
    </RequestorPreferences>
  </Source>
	<RequestDetails>
	<SearchChargeConditionsRequest>
          <DateFormatResponse/>
		<ChargeConditionsHotel>
			<City>AMS</City>
			<Item>APP</Item>
			<PeriodOfStay>
				<CheckInDate>2005-05-29</CheckInDate>
				<Duration>10</Duration>
			</PeriodOfStay>
			<Rooms>
				<Room Code="TB" Id = "001:APP1:22681:S22237:33643:121162" NumberOfCots="1">
					<ExtraBeds>
						<Age>14</Age>
					</ExtraBeds>
				</Room>
			</Rooms>
		</ChargeConditionsHotel>
	</SearchChargeConditionsRequest>
	</RequestDetails>
</Request>

Table 2 . Search Charge Condition search request. Flat structure (Participation Level 2).

A price for the hotel must be available for the period of stay specified.

Hotel Charge Conditions parameters

This request will be used to retrieve charge conditions for a potential hotel item. The following sub-elements must be specified: 

Parameters

Description

DateFormatResponse

Optional. If present the ‘FromDay’ and ‘ToDay’ attributes of the <SearchChargeConditionsResponse> will be returned as ‘FromDate’ and ‘ToDate’ attributes instead and the values will be returned in date format rather than as days prior to arrival.

City

Mandatory. Specifies the city for the Item.

Item

Mandatory. Specifies the item (hotel) for which the price breakdown is required.

PeriodOfStay

Mandatory. Defines the check-in day and either the check-out day or the duration of stay.

Rooms

Mandatory. A list of the requested hotel rooms, with information on the number of rooms, the number of cots and the ages of any extra children staying in.


Room parameter

The client can request a number of rooms through the <Rooms> element. The latter is made up of a list of <Room> sub-elements, one element for each different requested room type.

An example of a <Room> element, for one twin room with one cot and one extra bed (for child aged 10), is shown below:

 

<Room Code = "TB" NumberOfCots = "1">
    <ExtraBeds>
        <Age>10</Age>
    </ExtraBeds>
</Room>

 

The <Room> element can contain an Id attribute which is used to specify the room category. This is an optional attribute and is dependant on the client’s Participation Level: 

The <Room> element can contain an Id attribute which is used to specify the room category. This is an optional attribute and is dependant on the client’s Participation Level: -

  • Participation Level – None

Must not be entered.

  • Participation Level – 1

Mandatory.

  • Participation Level – 2.

Mandatory.

<?xml version="1.0" encoding="UTF-8"?>
   <Request>
      <Source>
    <RequestorID Client="123456" EMailAddress="clientName@client.co.uk" Password="clientPassword" />
    <RequestorPreferences Language="en">
		  <RequestMode>SYNCHRONOUS</RequestMode> 
    </RequestorPreferences>
  </Source>
	<RequestDetails>
	<SearchChargeConditionsRequest>
          <DateFormatResponse/>
		<ChargeConditionsHotel>
			<City>AMS</City>
			<Item>APP</Item>
			<PeriodOfStay>
				<CheckInDate>2005-05-29</CheckInDate>
				<Duration>10</Duration>
			</PeriodOfStay>
			<Rooms>
				<Room Code="TB" NumberOfCots="1" Id = "001:APP1:22681:S22237:33643:121162" >
					<ExtraBeds>
						<Age>14</Age>
					</ExtraBeds>
				</Room>
			</Rooms>
		</ChargeConditionsHotel>
	</SearchChargeConditionsRequest>
	</RequestDetails>
</Request>

Table 2. Search Charge Condition search request. (Participation Level 1/2 or above)

Sightseeing Charge Conditions

The XML message below gives a sample of the expected elements needed by the API to execute a Search Charge Conditions Request for a potential sightseeing item.

<?xml version="1.0" encoding="UTF-8"?>
<Request>
  <Source>
<RequestorID Client="123456" EMailAddress="clientName@client.co.uk" Password="clientPassword" />
    <RequestorPreferences Language="en">
		  <RequestMode>SYNCHRONOUS</RequestMode> 
    </RequestorPreferences>
  </Source>
	<RequestDetails>
	<SearchChargeConditionsRequest>
       <DateFormatResponse/>
		<ChargeConditionsSightseeing>
			<City>LON</City>
			<Item>CATA01-GTA25</Item>
			<TourDate>2005-07-10</TourDate>
			<TourLanguage>E</TourLanguage>
			<SpecialCode>JS</SpecialCode>
     	<NumberOfAdults>3</NumberOfAdults>
     <Children>
     		<Age>5</Age>
       	<Age>10</Age>
    	</Children>
		</ChargeConditionsSightseeing>
	</SearchChargeConditionsRequest>
	</RequestDetails>
</Request>

A price for the sightseeing tour must be available for the tour date specified.

Sightseeing Charge Conditions parameters

This request will be used to retrieve charge conditions for a potential sightseeing item. The following sub-elements must be specified: 

Parameters

Description

DateFormatResponse

Optional. If present the ‘FromDay’ and ‘ToDay’ attributes of the <SearchChargeConditionsResponse> will be returned as ‘FromDate’ and ‘ToDate’ attributes instead and the values will be returned in date format rather than as days prior to arrival.

City

Mandatory. Specifies the city for the Item.

Item

Mandatory. Specifies the item (apartment) for which the charge conditions are required.

TourDate

Mandatory. Defines the date of the sightseeing item.

TourLanguage

Optional. Specifies the GTA language for the required item.

TourLanguageList

Optional. Specifies the GTA language list for the required item.

SpecialCode

Optional. Specifies the GTA Special Code for the required item.

NumberOfAdults

Mandatory. This will contain the number of adults to be included in the price for sightseeing item. Must be in the range 1 to 9 inclusive.

Children

Optional. A list of <Age> elements specifying the children’s ages, which must be between 2 and 18 inclusive.


Transfer Charge Conditions

The XML message below gives a sample of the expected elements needed by the API to execute a Search Charge Conditions Request for a potential transfer item.

 

<?xml version="1.0" encoding="UTF-8"?>
<Request>
  <Source>
<RequestorID Client="123456" EMailAddress="clientName@client.co.uk" Password="clientPassword" />
    <RequestorPreferences Language="en">
		  <RequestMode>SYNCHRONOUS</RequestMode> 
    </RequestorPreferences>
  </Source>
	<RequestDetails>
	<SearchChargeConditionsRequest>
           <DateFormatResponse/>
		<ChargeConditionsTransfer>
			<City>PAR</City>
			<Item> 000000987003 </Item>
			<TransferDate>2005-07-10</TransferDate>
			<TransferTime>15.15</TransferTime>
			<TransferLanguage>E</TransferLanguage>
<Vehicle Code="SA" MaximumPassengers="2"	/>
		</ChargeConditionsTransfer>
	</SearchChargeConditionsRequest>
	</RequestDetails>
</Request>

A price for the transfer must be available for the transfer date specified.

Transfer Charge Conditions parameters

This request will be used to retrieve Charge conditions for a potential transfer item. The following sub-elements must be specified: 

Parameters

Description

DateFormatResponse

Optional. If present the ‘FromDay’ and ‘ToDay’ attributes of the <SearchChargeConditionsResponse> will be returned as ‘FromDate’ and ‘ToDate’ attributes instead and the values will be returned in date format rather than as days prior to arrival.

City

Mandatory. Specifies the city for the Item.

Item

Mandatory. Specifies the item (transfer) for which the Charge conditions are required.

TransferDate

Mandatory. Defines the date of the transfer item.

TransferTime

Mandatory. Defines the estimated time of the transfer.

  • If the time is within the range where out of hours supplement applies, charges will include the corresponding percentage mark-up.

TransferLanguage

Optional. Specifies the GTA language to identify the required language for the transfer.

Vehicle

If the transfer includes a vehicle, the following attributes must be specified to identify the required vehicle: -

  • Code - The GTA vehicle code
  • MaximumPassengers - The maximum passengers for the vehicle

Car Charge Condition

This module is no longer in use and has been removed from the specifications.

Example XML Search Charge Conditions Response

All of the options for Search Charge Conditions request will return a standard response.

The XML message below gives a sample of that given by the API in response to a Search Charge Conditions request.

<?xml version="1.0" encoding="UTF-8"?>
<Response ResponseReference="34567">
    <ResponseDetails Language="en">
	<SearchChargeConditionsResponse>
	    <ChargeConditions>
		<ChargeCondition Type="cancellation">
		    <Condition Charge="true" 
                          FromDay="0" 
                          ToDay="3" 
                          Currency="GBP" 
                          ChargeAmount="227.50"></Condition>
					<Condition Charge="true" 
                          FromDay="4" 
                          ToDay="7" 
                          Currency="GBP" 
                          ChargeAmount="113.75">
                   </Condition>
		    <Condition Charge="false" 
                          FromDay="8">
                   </Condition>
		</ChargeCondition>
		<ChargeCondition Type="amendment"  MaximumPossibleChargesShown="true">
		    <Condition Charge="true" 
                          FromDay="0" 
                          ToDay="0" 
                          Currency="GBP" 
                          ChargeAmount="113.75">
                   </Condition>
		    <Condition Charge="true" 
                          FromDay="1" 
                          ToDay="3" 
                          Currency="GBP" 
                          ChargeAmount="20.00">
                   </Condition>
		    <Condition Charge="true" 
                          FromDay="4" 
                          Currency="GBP" 
                          ChargeAmount="10.00">
                   </Condition>
		    </ChargeCondition>
                   <PossibleLeadTimeRestrictions>
                          <Condition FromDay = "0" ToDay = "90">
                          </Condition>
                          <EffectiveDates>
                              <FromDate>2006-04-25</FromDate>
                              <ToDate>9999-12-31</ToDate>
                          </EffectiveDates>
                   </PossibleLeadTimeRestrictions>
                   <PassengerNameChange Allowable="false"
                          FromDay="0"
                          ToDay="10">
                   </PassengerNameChange>
               </ChargeConditions>
           </SearchChargeConditionsResponse>
     </ResponseDetails>
</Response>	

The XML message below gives a sample of that given by the API in response to a Search Charge Conditions request where the </DateFormatResponse> parameter has been present.

<?xml version="1.0" encoding="UTF-8"?>
<Response ResponseReference="34567">
    <ResponseDetails Language="en">
	<SearchChargeConditionsResponse>
	    <ChargeConditions>
		<ChargeCondition Type="cancellation">
		    <Condition Charge="true" 
                          FromDate="2009-04-01" 
                          ToDate="2009-03-29" 
                          Currency="GBP" 
                          ChargeAmount="227.50">
                      </Condition>
			 <Condition Charge="true" 
                          FromDate="2009-03-28" 
                          ToDate="2009-02-10" 
                          Currency="GBP" 
                          ChargeAmount="113.75">
                   </Condition>
		    <Condition Charge="false" 
                          FromDate="2009-02-09">
                   </Condition>
		</ChargeCondition>
		<ChargeCondition Type="amendment"  
                          MaximumPossibleChargesShown="true">
		    <Condition Charge="true" 
                          FromDate="2009-04-01" 
                          ToDate="2009-03-27" 
                          Currency="GBP" 
                          ChargeAmount="113.75">
                   </Condition>
		    <Condition Charge="false" 
                          FromDate="2009-0-26" 
                   </Condition>
		    </ChargeCondition>
                   <PossibleLeadTimeRestrictions>
                          <Condition FromDate = "2009-03-21" 
                          ToDate = "2009-02-26">
                          <EffectiveDates>
                              <FromDate>2008-12-04</FromDate>
                              <ToDate>9999-12-31</ToDate>
                          </EffectiveDates>
                   </PossibleLeadTimeRestrictions>
                   <PassengerNameChange Allowable="false"
                          FromDate="2009-03-31"
                          ToDate="2009-03-16">
                   </PassengerNameChange>
               </ChargeConditions>
           </SearchChargeConditionsResponse>
     </ResponseDetails>
</Response>	

Search Charge Conditions response parameters

The API will return the following Booking level sub-elements: 

Element

Description

ChargeCondition

This will contain a list of <condition> elements for the charge condition type.

 

Attribute

Description

 

Type

Identifies the type of Charge condition (i.e. amendment/cancellation charges).

 

Allowable

If “false” restrictions are applicable for amendments, otherwise no output.

 

MaximumPossibleChargesShown

“true” if amendment charges otherwise not output.

Element

Description

PossibleLeadTimeRestrictions

If returned will indicate that lead time restrictions apply. This will contain a list of <condition> elements for the charge condition type.

This element is no longer in use and will be removed from the schema in the future.

EffectiveDates

Indicates the dates for which the lead time restrictions apply.

 

FromDate

Indicates which date the lead time restrictions are effective from.

 

ToDate

Indicates which date the lead time restrictions are effective to.

PassengerNameChange

If ‘false’ no passenger name changes are permitted for this booking item.

 

Attribute

Description

 

Allowable

If “false” restrictions are applicable for passenger name changes, otherwise “true”

 

FromDay

The “From” number of days (before check-in) for which the passenger name change restriction applies. This is usually the check-in or tour date of the booking indicated by “0”.

 

ToDay

The “To” number of days (before check-in) for which the amendment/cancellation rule applies. Not output if no upper limit, which means that if the ToDay attribute is not returned an amendment/cancellation without charge is not possible at any stage after booking confirmation. This is the first day for which the condition applies (the furthest from the check-in or tour date and the closest day to today’s date).


Conditions sub-elements

Specifies the amendment/cancellation rule. 

Attribute

Description

Allowable

“false” if amendment is not allowed (cancellations are currently always allowed).

Charge

“true” if a charge is applicable for the amendment/cancellation rule, otherwise “false”. If an amendment is not allowed this attribute will not be returned.

FromDay

The “From” number of days (before check-in) for which the amendment/cancellation rule applies. This is usually the check-in or tour date of the booking indicated by “0”.

FromDate

If the <DateFormatResponse/> parameter has been specified in the request, the FromDate parameter will be returned instead of the FromDay parameter. Indicates the date from which the amendment/cancellation rule applies.

ToDay

The “To” number of days (before check-in) for which the amendment/cancellation rule applies. Not output if no upper limit, which means that if the ToDay attribute is not returned an amendment/cancellation without charge is not possible at any stage after booking confirmation. This is the first day for which the condition applies (the furthest from the check-in or tour date and the closest day to today’s date).

ToDate

If the <DateFormatResponse/> parameter has been specified in the request, the ToDate parameter will be returned instead of ToDay parameter. Indicates the date until which the amendment/cancellation rule applies. Not output if no upper limit, which means that if the ToDate attribute is not returned an amendment/cancellation without charge is not possible at any stage after booking confirmation.

Currency

The currency of the charge amount.

ChargeAmount

The charge amount for the amendment/cancellation rule.

Docs Navigation