Item Information Download

The Item Information Download request provides the client with a file containing all our static data. At the moment it will be available for the hotel module only. It is possible to request a file for a complete download of all our static data, a file for incremental updates and a file for yesterday’s incremental updates.

All requests will need to be sent in a SYNCHRONOUS mode; any requests sent in an ASYNCHRONOUS mode will return an error.

An XML response will only be returned if the request generates an error. Otherwise a zip file containing multiple XML files will be returned. Clients will need to check the Content-Type of the HTTP response header: if the Content-Type=text/xml then an error is being returned; if the Content-Type=application/download then a zip file is being returned in the body of the HTTP response.  The client will have to read all the bytes of the HTTP response body and process this as a zip file,  i.e.: save the received bytes in a file (e.g.:  Full Download-March 2009.zip) and then process this file. Alternatively the client can process the bytes as a zip file in memory.

If a request for a complete download is sent the response will be broken down into multiple files for each property.If a time out (usually HTTP Status Response: 503) is received the client’s coding will have to have been set up to retry at a later time, but not earlier than one hour.

Source parameters

Please refer to the API Architecture document.

Example XML Item Information Download request

It is possible to request a file for a complete download of all our static data, a file for incremental updates and a file for yesterday’s incremental updates.

Item Information Download request for complete file

The XML message below gives a sample of the expected elements needed by the API to execute an Item Information Download request to receive the complete file of all our static data.

<?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>
		<ItemInformationDownloadRequest ItemType="hotel">
		</ItemInformationDownloadRequest>
	</RequestDetails>
</Request>

Table 1. Item Information Download  search request.

  Item Information Download request for incremental updates

The XML message below gives a sample of the expected elements needed by    the API to execute an Item Information Download request to receive the incremental updates.

<?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>
		<ItemInformationDownloadRequest ItemType="hotel">
                 <IncrementalDownloads>
                     <FromDate>2008-12-01</FromDate>
                     <ToDate>2008-12-31</ToDate>
                  </IncrementalDownloads>
		</ItemInformationDownloadRequest>
	</RequestDetails>
</Request>

Table 2. Item Information Download for incremental updates search request.

Item Information Download request for yesterday’s incremental updates

The XML message below gives a sample of the expected elements needed by the API to execute an Item Information Download request to receive only yesterday’s incremental update.

<?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>
      <ItemInformationDownloadRequest ItemType="hotel">
          <IncrementalDownloads>
          </IncrementalDownloads>
      </ItemInformationDownloadRequest>
  </RequestDetails>
</Request>

Item Information Download request attributes/parameters

An Item Information Download request can contain optional attributes/parameters to filter the items returned. The following list the attributes/parameters that can be specified:

Attribute

Description

ItemType

Mandatory. Identifies the type of item being processed. Currently only “hotel” is available.

Parameters

Description

IncrementalDownloads

Optional. Specifies the date range during which the item information was last updated. If not specified the complete file will be downloaded.

FromDate

Optional. The start date of the date range. If not present will default to yesterday’s date. Cannot be more than yesterday’s date -30.

Dates are calculated based on London time; e.g.: if a request is sent by a client based in the Far East on the 10th, day of the month the date range entered must take into consideration London time and therefore the 9th cannot be used if in London it is still on the 9thday of the month.

ToDate

Optional. The end date of the date range. If not present will default to yesterday’s date. Cannot be more than yesterday’s date -30.

Dates are calculated based on London time; e.g.: if a request is sent by a client based in the Far East on the 10th, day of the month the date range entered must take into consideration London time and therefore the 9th cannot be used if in London it is still on the 9thday of the month.

 Example XML Item Information Download response

Note

The API will be responsible for the level of information returned to the client. This will be determined as part of the contractual agreement with GTA and subsequently set up as system parameters within the GTA system.

Unlike our other XML responses, this response will not contain a ResponseReference attribute. The XML message below gives a sample of that given by the API in response to an Item Information Download Response.

<?xml version="1.0" encoding="UTF-8"?>
  <Response>
     <ResponseDetails Language="en">
         <SearchItemInformationResponse ItemType="hotel">
	           <ItemDetails>
		          <ItemDetail>
		                <City Code="PAR"><![CDATA[Paris]]></City>
		                <Item Code="ALB2"><![CDATA[Alba Opera]]></Item>
		             <LocationDetails>
		                <Location Code="G1"><![CDATA[Central]]></Location>
                     <Location Code="09"><![CDATA[09e Arrondissement]]></Location>
                     <Location Code="28"><![CDATA[Pigalle/Montmartre/Sacre Coeur]]></Location>
		             </LocationDetails>
		             <HotelInformation>
		                <AddressLines>
                        <AddressLine1><![CDATA[34 TER RUE DE LA TOUR D AUVERGNE]]></AddressLine1>
                        <AddressLine2><![CDATA[75009 PARIS]]></AddressLine2>
                        <AddressLine3><![CDATA[FRANCE]]></AddressLine3>
                        <Telephone><![CDATA[33-1-48788022]]></Telephone>
                        <Fax><![CDATA[33-1-42852313]]></Fax>
                        <EmailAddress><![CDATA[hotel-albaopera-residence@wanadoo.fr]]></EmailAddress>
		            </AddressLines>
		            <StarRating>3</StarRating>
                 <Category><![CDATA[Superior Tourist Class Traditional Hotel]]></Category>
                 <AreaDetails>
                     <AreaDetail><![CDATA[20 kms to the airport (charles de Gaulle)]]></AreaDetail>
                     <AreaDetail><![CDATA[20 kms to the airport (orly)]]></AreaDetail>
		  <AreaDetail><![CDATA[2 minute walk to the nearest metro station (notre dame de   lorette/cadet)]]></AreaDetail>
                     <AreaDetail><![CDATA[Close to the station (gare du nord)]]></AreaDetail>
                 </AreaDetails>
                 <Reports>
                   <Report Type="location"><![CDATA[Located in a quiet courtyard half way between Opera and Montmartre, a mere 5 minutes walk from the metro.]]></Report>
              <Report Type="rooms"><![CDATA[All the rooms are fully equipped. Very convenient for long stays as all the rooms are studios so all of them are larger than the Paris standard.]]></Report>
                   <Report Type="restaurant"><![CDATA[There is no restaurant in the hotel, but there are lot of typical and nice good restaurant in the area.]]></Report>
                   <Report Type="lobby"><![CDATA[The reception area is small and bright and has small seating area. The beautiful wrought iron old fashion lift is very small.]]></Report>
                   <Report Type="general"><![CDATA[Nice property in a quiet environment, yet within walking distance from shopping areas and lively spots of Paris like Montmartre.]]></Report>
                   <Report Type="inclusive"><![CDATA[All inclusive ***Test Only***]]></Report>
                   <Report Type="pleasenote"><![CDATA[****Test please note field****]]></Report>
                 </Reports>
                 <RoomTypes RoomCount="24">
	                  <RoomType Code="SB"><![CDATA[Single room]]></RoomType>
		                <RoomType Code="DB"><![CDATA[Double rooms]]></RoomType>
		                <RoomType Code="TB"><![CDATA[Twin rooms]]></RoomType>
                     <RoomType Code="TR"><![CDATA[Triple rooms]]></RoomType>
		                <RoomType Code="Q"><![CDATA[Quad roomd]]></RoomType>
	              </RoomTypes>
	              <RoomFacilities>
      <Facility Code="TV"><![CDATA[Television]]></Facility>
	      <Facility Code="*DD"><![CDATA[Direct dial phone]]></Facility>
      <Facility Code="*VL"><![CDATA[Voltage 200v]]></Facility>
	              </RoomFacilities>
	              <Facilities>
	     <Facility Code="*LS"><![CDATA[Small sized lobby]]></Facility>
	     <Facility Code="*EC"><![CDATA[Earliest check-in at 12:00]]></Facility>
     <Facility Code="*LF"><![CDATA[1 lift]]></Facility>
     <Facility Code="*PT"><![CDATA[Porterage 24 hour]]></Facility>
     <Facility Code="*FL"><![CDATA[6 floors]]></Facility>
     <Facility Code="*BS"><![CDATA[Baby sitting]]></Facility>
     <Facility Code="*LY"><![CDATA[Laundry facilities]]></Facility>
     <Facility Code="*DF"><![CDATA[Disabled facilities]]></Facility>
	             </Facilities>
               <Links>
		             <MapLinks>
         <MapLink><![CDATA[http://interface.test.gta-travel.com/gtaxml/IMapLink.jsp?prov=3&cty=PAR&itm=ALB2&typ=HH
]]></MapLink>
		             </MapLinks>
		             <ImageLinks>
	                   <ImageLink Height="269" Width="360">
			                 <Text><![CDATA[Entrance]]></Text>
          <ThumbNail><![CDATA[ http://images.test.gta-travel.com/HH/Images/F/PARth/PARALB29.jpg]]></ThumbNail>
          <Image><![CDATA[http://images.test.gta-travel.com/HH/Images/F/PARth/PARALB29.jpg]]></Image>
		         </ImageLink>
                  </ImageLinks>
               </Links>
               <GeoCodes>
                  <Latitude>48.879600000000000</Latitude>
                  <Longitude>2.342400000000000</Longitude>
               </GeoCodes>
             </HotelInformation>              
             <Copyright><![CDATA[c)Donvand Limited 2008]]></Copyright>
           </ItemDetail>
         </ItemDetails>
      </SearchItemInformationResponse>
   </ResponseDetails>
</Response>

                Table 2a. Item Information  search response – flat structure (no Participation Level).

<?xml version="1.0" encoding="UTF-8"?>
<Response>
   <ResponseDetails Language="en">
      <SearchItemInformationResponse ItemType="hotel">
	       <ItemDetails>
		     <ItemDetail>
		          <City Code="PAR"><![CDATA[Paris]]></City>
		          <Item Code="HIL"><![CDATA[Alba Opera]]></Item>
		       <LocationDetails>
		          <Location Code="G1"><![CDATA[Central]]></Location>
               <Location Code="09"><![CDATA[09e Arrondissement]]></Location>
               <Location Code="28"><![CDATA[Pigalle/Montmartre/Sacre Coeur]]></Location>
		       </LocationDetails>
		       <HotelInformation>
		          <AddressLines>
                   <AddressLine1><![CDATA[34 TER RUE DE LA TOUR D AUVERGNE]]></AddressLine1>
                   <AddressLine2><![CDATA[75009 PARIS]]></AddressLine2>
                   <AddressLine3><![CDATA[FRANCE]]></AddressLine3>
                   <Telephone><![CDATA[33-1-48788022]]></Telephone>
                   <Fax><![CDATA[33-1-42852313]]></Fax>
                   <EmailAddress><![CDATA[hotel-hilton@wanadoo.fr]]></EmailAddress>
		         </AddressLines>
		         <StarRating>3</StarRating>
              <Category><![CDATA[Superior Tourist Class Traditional Hotel]]></Category>
          <AreaDetails>
               <AreaDetail><![CDATA[20 kms to the airport (charles de gaulle)]]></AreaDetail>
               <AreaDetail><![CDATA[20 kms to the airport (orly)]]></AreaDetail>
		          <AreaDetail><![CDATA[2 minute walk to the nearest metro station (notre dame de   lorette/cadet)]]></AreaDetail>
               <AreaDetail><![CDATA[Close to the station (gare du nord)]]></AreaDetail>
          </AreaDetails>
          <Reports>
           <Report Type="location"><![CDATA[Located in a quiet courtyard half way between Opera and Montmartre, a mere 5 minutes walk from the metro.]]></Report>
           <Report Type="rooms"><![CDATA[All the rooms are fully equipped. Very convenient for long stays as all the rooms are studios so all of them are larger than the Paris standard.]]></Report>
           <Report Type="restaurant"><![CDATA[There is no restaurant in the hotel, but there are lot of typical and nice good restaurant in the area.]]></Report>
           <Report Type="exterior"><![CDATA[It is a 6 storey Haussmann style building.]]></Report>
           <Report Type="lobby"><![CDATA[The reception area is small and bright and has small seating area. The beautiful wrought iron old fashion lift is very small.]]></Report>
           <Report Type="general"><![CDATA[Nice property in a quiet environment, yet within walking distance from shopping areas and lively spots of Paris like Montmartre.]]></Report>
           <Report Type="inclusive"><![CDATA[All inclusive ***Test Only***]]></Report>
           <Report Type="pleasenote"><![CDATA[****Test please note field****]]></Report>
             </Reports>
             <RoomCategories>
	              <RoomCategory Id = "002:HIL1">
		               <Description><![CDATA[Standard]]></Description>
		               <RoomDescription>The medium sized bedrooms are typical Hilton style 		with two double beds in each twin room. All the rooms were renovated in 2001 with modern    furnishings in Italian style and strong, contrasting colours. The white tiled bathrooms are also in very good condition and the rooms offer all the facilities and the high 			standards that one would expect from a 5 star Hilton hotel.</RoomDescription>
	               </RoomCategory>
	              <RoomCategory Id = "002:HILTON:HL:04988:XXX:XXX:A02">
		                 <Description><![CDATA[King Junior Suite]]></Description>
	              </RoomCategory>
	              <RoomCategory Id = "002:HILTON:HL:04988:XXX:XXX:A10">
		                <Description><![CDATA[Standard Double]]></Description>
	              </RoomCategory>
	              <RoomCategory Id = "002:HILTON:HL:04988:XXX:XXX:A09">
		                 <Description><![CDATA[Executive King]]></Description>
		            <RoomDescription>The very large Executive King bedrooms are very comfortably furnished. There is a mini-audio system in each room. The bathrooms are fitted to a very high standard.</RoomDescription>
	              </RoomCategory>
	              <RoomCategory Id = "002:HILTON:HL:04988:XXX:XXX:A03">
		                <Description><![CDATA[Presidential Suite]]></Description>
	              </RoomCategory>
            </RoomCategories>
            <RoomTypes RoomCount="24">
		            <RoomType Code="SB"><![CDATA[Single room]]></RoomType>
		            <RoomType Code="DB"><![CDATA[Double rooms]]></RoomType>
		            <RoomType Code="TB"><![CDATA[Twin rooms]]></RoomType>
                 <RoomType Code="TR"><![CDATA[Triple rooms]]></RoomType>
		            <RoomType Code="Q"><![CDATA[Quad roomd]]></RoomType>
	          </RoomTypes>
		        <RoomFacilities>
	 <Facility Code="TV"><![CDATA[Television]]></Facility>
	 <Facility Code="*DD"><![CDATA[Direct dial phone]]></Facility>
 <Facility Code="*VL"><![CDATA[Voltage 200v]]></Facility>
		        </RoomFacilities>
		        <Facilities>
	  <Facility Code="*LS"><![CDATA[Small sized lobby]]></Facility>
	  <Facility Code="*EC"><![CDATA[Earliest check-in at 12:00]]></Facility>
  <Facility Code="*LF"><![CDATA[1 lift]]></Facility>
  <Facility Code="*PT"><![CDATA[Porterage 24 hour]]></Facility>
  <Facility Code="*FL"><![CDATA[6 floors]]></Facility>
  <Facility Code="*BS"><![CDATA[Baby sitting]]></Facility>
  <Facility Code="*LY"><![CDATA[Laundry facilities]]></Facility>
  <Facility Code="*DF"><![CDATA[Disabled facilities]]></Facility>
		        </Facilities>
             <Links>
		           <MapLinks>
       <MapLink><![CDATA[http://interface.test.gta-travel.com/gtaxml/IMapLink.jsp?prov=3&cty=PAR&itm=ALB2&typ=HH
]]></MapLink>
		           </MapLinks>
		           <ImageLinks>
	                <ImageLink Height="269" Width="360">
			           <Text><![CDATA[Entrance]]></Text>
    <ThumbNail><![CDATA[ http://images.test.gta-travel.com/HH/Images/F/PARth/PARALB29.jpg]]></ThumbNail>
    <Image><![CDATA[http://images.test.gta-travel.com/HH/Images/F/PARth/PARALB29.jpg]]></Image>
		             </ImageLink>
               </ImageLinks>
             </Links>
             <GeoCodes>
                <Latitude>48.879600000000000</Latitude>
                <Longitude>2.342400000000000</Longitude>
              </GeoCodes>
             </HotelInformation>              
             <Copyright><![CDATA[c)Donvand Limited 2008]]></Copyright>
           </ItemDetail>
         </ItemDetails>
      </SearchItemInformationResponse>
   </ResponseDetails>
</Response>                

Table 3b. Item Information  search response (Participation Level 1/ 2 or above)

Item Information Download response attributes/parameters

For details of the attributes and parameters returned with the <ItemInformationDownloadResponse> please refer to paragraphs 9.3 and 9.5 in this document (Search Item Information).

 

 

 

 

For details of the attributes and parameters returned with the <ItemInformationDownloadResponse> please refer to paragraphs 9.3 and 9.5 in this document (Search Item Information). 

Docs Navigation