Inquiry: groups

Description

Query type groups returns a unique list of objects and variants of the fields in the group.

In version 2.1 is required to provide a list of filters that are to be returned in the response.

Inquiry

Field nametypecontains
calc_foundintminimum number of offers returned in count (maximum 1000)
excludeFromRulestextrule name
external_search_idtextexternal search id
extraDataxmlAdditional info about offers
geo_xCircleintSearch in max radius='dstance' (in kilometers) from lat,long
geo_xPolygonintSearch in polygon described by at least 3 pairs of lat,long
group_bycharname of the field after which data will be grouped
includeFromRulestextrule name
limit_countintNumber of records per page (default 10, max 100)
limit_fromintfirst record (default 1, max 1000)
maxPriceintmaximum price for an adult
minPriceintminimum price per adult
data:fields:names:mixtexttype of mixed offers
obj_bookBedsboolIf reservation on individual beds is possible
obj_categoryintCategory of the object multiplied by 10
obj_xCityFtstextString allows searching offers by town name
obj_codeNameFtstextEnabling search of offers based by string name of the hotel
obj_codecharhotel code
obj_nametextThe name of the object (the hotel / cruise / circuit / package)
obj_roomcharRoom code/ accommodation
obj_tourOpAndCodechar${kod_operatora}_${kod_obiektu}
obj_typecharObject type (hotel/round trip/cruise /...)
obj_xAttributesCountintMinimum number of required attributes that match the offer
obj_xAttributesNotInbitmaskObject's attributes / flag offer
obj_xAttributesbitmaskObject's attributes / flag offer
obj_xCityIdtextThe city in which the object is assigned by MerlinX (original or revised)
obj_xCodeintID assigned to the hotel by MerlinX
obj_xDistBeachintDistance from beach
obj_xDistSkiintDistance from ski lift
obj_xNametextObject's name that is assigned by MerlinX (original or revised)
obj_xRoomDescCountintMinimum number of required Room description that match the offer
obj_xRoomDesccharRoom description processed by MerlinX
obj_xServiceIdintID meal/service assigned by MerlinX
obj_zScoreCntintsearch based of amount of Zoover opinions
obj_zScoreintsearch based of Zoover rating
ofr_candybitmaskCandy (bonus)
ofr_catalogcharCatalog code
ofr_tourOpchartouroperator code
ofr_typecharType of offer
ofr_xCatalogcharcatalogs unified by MerlinX
ofr_xStatuscharoffer availability
order_bycharnumber for sorting
par_adtintnumber of adults
par_chdAgetextage of children or children bitrh dates
par_chdintNumber of children
par_infintnumber of infants
selectAnswerFieldstextfields name
totalPriceboolreturns the total price for the asked product
trp_depCodecharCode of departure location/airport ( IATA Code )
trp_depDatedateDate of departure / departure / start of trip
trp_depNametextplace of departure / start
trp_depNametextplace of departure / start
trp_destinationintRegion of the trip/event
trp_durationMintnumber of days
trp_durationintnumber of days
trp_rDepCodechardeparture code of the return place
trp_rDesCodechardestination code of the return trip
trp_retDatedatepossible late date of the return trip
trp_skiDestinationintDestination regions for ski.
wtr_biintsearch by forecast biking activities score (1-10)
wtr_bintsearch by forecast beach activities score (1-10)
wtr_cintsearch by forecast camping activities score (1-10)
wtr_pcintsearch by forecast precipitation chance (%)
wtr_pintsearch by forecast precipitation (mm)
wtr_sdintsearch by sun hours duration
wtr_tnintsearch by forecast tennis score (1-10)
wtr_trintsearch by forecast terrace activities score (1-10)
wtr_tintsearch by forecast temperature ( in degrees Celsius )
wtr_uvintsearch by UV index
wtr_wkintsearch by forecast walking activities score (1-10)
wtr_wtintsearch by forecast water sports activities score (1-10)
useMerlinMarginboolreturns price with agency margin
<?xml version='1.0'?>
<mds>
   <auth>
       <login>login</login>
       <pass>pass</pass>
   </auth>
   <request>
     <type>groups</type>
     <conditions>
       <ofr_type>F</ofr_type>
       <par_adt>2</par_adt>     
       <trp_depDate>20101122:20101124</trp_depDate>
       <obj_codeNameFts>Resort</obj_codeNameFts>
     </conditions>
   </request>
</mds>

Answer

Field nametypecontains
countintnumber of matching results for the given query
extraDataxmlAdditional info about offers
obj_accomodationcharCode assignment, unites the value of the code room and board, used by the booking system
obj_bookBedsboolIf reservation on individual beds is possible
obj_categoryintCategory of the object multiplied by 10
obj_citytextThe city in which the object is located
obj_codecharhotel code
obj_countrytextCountry
obj_desCodecharUsually the airport code serving the area where hotel is located
obj_maxAdtintMaximum number of adults
obj_maxPaxintMaximum number of people (occupancy)
obj_minAdtintThe minimum number of adults
obj_minPaxintThe minimum number of people (occupancy)
obj_nametextThe name of the object (the hotel / cruise / circuit / package)
obj_ratingtextHotel rating by Zoover system
obj_regiontextThe name of the region in which the object is located
obj_roomDesctextDescription of room / accommodation
obj_roomcharRoom code/ accommodation
obj_serviceDesctextdescription of the meals / service
obj_servicecharService code/board
obj_typecharObject type (hotel/round trip/cruise /...)
obj_xAttributesbitmaskObject's attributes / flag offer
obj_xCitytextThe city in which the object is assigned by MerlinX (original or revised)
obj_xCodeintID assigned to the hotel by MerlinX
obj_xCountryIdintID assigned to a country by MerlinX
obj_xLatfloatLatitude location of the object
obj_xLongfloatLongitude position of the object
obj_xNametextObject's name that is assigned by MerlinX (original or revised)
obj_xRegionIdintID assigned to a region by MerlinX
obj_xRoomDesccharRoom description processed by MerlinX
obj_xServiceIdintID meal/service assigned by MerlinX
obj_xskiregpathtextInformation about ski regions
ofr_candybitmaskCandy (bonus)
ofr_catalogcharCatalog code
ofr_idcharoffer identifier. ** IMPORTANT: ** Do not assume that there will always be a hexadecimal string
ofr_operCurrcharcurrency used by the operator
ofr_operPriceintPrice per adult in the currency of the operator
ofr_priceintPrice per adult (in the case ofr_operCurr pathologist from PLN should be taken as approximate this value!)
ofr_statuscharlast known status/availability of offers
ofr_sweetboolCandy - promoted flag ads (provided by the operator)
ofr_tourOpchartouroperator code
ofr_typecharType of offer
ofr_xCatalogcharcatalogs unified by MerlinX
room_hashcharHotel room id
trp_desDesctextplace of trip/ directions
trp_arrTimetimetimes of trip / directions
trp_busStopDesctextDescription of the bus stop
trp_busStoptext
trp_carrierCodetextcarrier code and flight number (if both of the information is available)
trp_carrierDesctextName of carrier
trp_depCodecharCode of departure location/airport ( IATA Code )
trp_depDatedateDate of departure / departure / start of trip
trp_depNametextplace of departure / start
trp_depNametextplace of departure / start
trp_depTimetimetime of departure / start
trp_desCodecharCode of destination location/airport ( IATA Code )
trp_desDatedatedate of reach the destination
trp_durationMintnumber of days
trp_durationintnumber of days
trp_flightCodecharservice code for flight / transport
trp_flightOptextflight operator name
trp_rArrTimetimetime of arrival of the return trip
trp_rCarrierCodetextcarrier code and flight number of return (if both information is available)
trp_rDepCodechardeparture code of the return place
trp_rDepDatedateDeparture date of the return trip
trp_rDepTimetimeDeparture time of the return trip
trp_rDesCodechardestination code of the return trip
trp_rDesDatedateDate of return
trp_rFlightCodecharservice code of the return flight / transport (information can be included also in the field trp_flightCode)
trp_seasonchar
trp_startDatedateTour start date
trp_stayintnumber of nights
trp_tourCodechar
trp_type2charsupplement field trp_type
trp_typecharservice type of transport (plane / bus /...)
wtr_valtextweather value
wtrtextWeather information
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<response>
	<grp>
		<ofr id="f6b87684a59b0ae6ba9ffc291ec965b822bb6c264abd6235cc9aae4395078577" catalog="KAT" tourOp="EXIM" type="F" sweet="0" status="BA" price="1399">
			<obj name="Regina Nuweiba Resort" city="Taba - Nuweiba" category="30" code="618" room="1" service="H" roomDesc="Standard/DBL" minPax="2" maxPax="4" minAdt="2" maxAdt="3" xCode="4037" region="Taba" acomodation="" xAttributes="0x51862030" type="H" serviceDesc="Sniadania i obiadokolacje" xServiceId="2" country="Egipt" bookBeds="0" rating="A:5/P:6/O:10/J:7/B:7/R:7/a:5.1/p:5.6/o:6.2/j:5/b:3.6/r:5.3" desCode="TCP" xName="Regina Nuweiba" xCity="Taba"/>
			<trp desCode="TCP" depCode="Warszawa" depDate="20101123" duration="7" flightCode="WAWTCP1" carrierCode="924" rFlightCode="TCPWAW1" rCarrierCode="925" depTime="1950" arrTime="0055" rDepTime="0355" rArrTime="0605" type="F" type2="" dstCode="11_203" depDesc="Warszawa" desDesc="Taba" rDepDate="20101201" desDate="20101124" rDesDate="20101201" rDepCode="TCP" rDesCode="WAW" startDate="20101123" tourCode="" busStop="" durationM="7" season="0" busStopDesc="" flightOp="" stay=""/>
		</ofr>
		<variants tourOp="EXIM"/>
	</grp>
	<grp>
 
		<ofr id="0ab763430e705a439c390dbfd3472a7005e04ec2019ac0e66912bc16c5a7c9de" catalog="KAT" tourOp="SRSU" type="F" sweet="0" status="OK" price="1515">
			<obj name="Sahara  Mexicana Sharm Resort" city="Sharm El Sheikh" category="30" code="573" room="19" service="H" roomDesc="Standard" minPax="2" maxPax="4" minAdt="2" maxAdt="3" xCode="1461" region="Sharm El Sheikh" acomodation="" xAttributes="0x550f3030" type="H" serviceDesc="Śniadania i obiadokolacje" xServiceId="2" country="Egipt" bookBeds="0" rating="a:7.2/p:6.3/o:6.5/j:6.4/b:4.5/r:6.8" desCode="SSH" xName="Creative Mexicana" xCity="Sharm El Sheikh"/>
			<trp desCode="SSH" depCode="Wrocław" depDate="20101123" duration="7" flightCode="WROSSH1" carrierCode="5573" rFlightCode="SSHWRO1" rCarrierCode="5574" depTime="1650" arrTime="2230" rDepTime="1220" rArrTime="1600" type="F" type2="" dstCode="11_154" depDesc="Wroclaw" desDesc="Sharm El Sheik" rDepDate="20101130" desDate="20101123" rDesDate="20101130" rDepCode="SSH" rDesCode="WRO" startDate="20101123" tourCode="" busStop="" durationM="7" season="0" busStopDesc="" flightOp="" stay=""/>
		</ofr>
		<variants tourOp="ALFA,SRSU,BFRE"/>
	</grp>
 
           (...)
	<count>11</count>
 
</response>
 
 
Recent changes RSS feed Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki