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 name	↓ type	contains
ofr_candy	bitmask	Candy (bonus)
obj_xAttributes	bitmask	Object's attributes / flag offer
obj_xAttributesNotIn	bitmask	Object's attributes / flag offer
useMerlinMargin	bool	returns price with agency margin
totalPrice	bool	returns the total price for the asked product
obj_bookBeds	bool	If reservation on individual beds is possible
obj_luggage	char	Info if main baggage is included
data:fields:names:obj_xroomdesc	char	Room description processed by MerlinX
order_by	char	number for sorting
ofr_catalog	char	Catalog code
trp_rDepCode	char	departure code of the return place
obj_room	char	Room code/ accommodation
ofr_xCatalog	char	catalogs unified by MerlinX
ofr_tourOp	char	touroperator code
ofr_type	char	Type of offer
trp_rDesCode	char	destination code of the return trip
trp_depCode	char	Code of departure location/airport ( IATA Code )
obj_type	char	Object type (hotel/round trip/cruise /...)
obj_code	char	hotel code
ofr_xStatus	char	offer availability
obj_tourOpAndCode	char	${kod_operatora}_${kod_obiektu}
group_by	char	name of the field after which data will be grouped
ofr_transferType	char	Info if transfer is included
ofr_refundable	char	Offer have some flex rules or not
ofr_resident	char	Resident is available or not
trp_retDate	date	possible late date of the return trip
trp_depDate	date	Date of departure / departure / start of trip
wtr_tn	int	search by forecast tennis score (1-10)
wtr_bi	int	search by forecast biking activities score (1-10)
wtr_uv	int	search by UV index
wtr_sd	int	search by sun hours duration
wtr_p	int	search by forecast precipitation (mm)
wtr_wk	int	search by forecast walking activities score (1-10)
wtr_t	int	search by forecast temperature ( in degrees Celsius )
geo_xPolygon	int	Search in polygon described by at least 3 pairs of lat,long
geo_xCircle	int	Search in max radius='dstance' (in kilometers) from lat,long
obj_zScore	int	search based of Zoover rating
obj_zScoreCnt	int	search based of amount of Zoover opinions
obj_xDistSki	int	Distance from ski lift
wtr_pc	int	search by forecast precipitation chance (%)
wtr_tr	int	search by forecast terrace activities score (1-10)
maxPrice	int	maximum price for an adult
obj_xServiceId	int	ID meal/service assigned by MerlinX
obj_category	int	Category of the object multiplied by 10
par_chd	int	Number of children
minPrice	int	minimum price per adult
obj_xDistBeach	int	Distance from beach
trp_duration	int	number of days
wtr_b	int	search by forecast beach activities score (1-10)
trp_skiDestination	int	Destination regions for ski.
obj_xAttributesCount	int	Minimum number of required attributes that match the offer
calc_found	int	minimum number of offers returned in count (maximum 1000)
trp_durationM	int	number of days
wtr_wt	int	search by forecast water sports activities score (1-10)
par_adt	int	number of adults
obj_xCode	int	ID assigned to the hotel by MerlinX
par_inf	int	number of infants
trp_destination	int	Region of the trip/event
obj_xRoomDescCount	int	Minimum number of required Room description that match the offer
limit_from	int	first record (default 1, max 1000)
limit_count	int	Number of records per page (default 10, max 100)
wtr_c	int	search by forecast camping activities score (1-10)
trp_flightChangeCount	int	Number of stops for ongoing flight
trp_rFlightChangeCount	int	Number of stops for return flight
excludeFromRules	text	rule name
par_chdAge	text	age of children or children bitrh dates
obj_xCityFts	text	String allows searching offers by town name
obj_codeNameFts	text	Enabling search of offers based by string name of the hotel
obj_xCityId	text	The city in which the object is assigned by MerlinX (original or revised)
obj_xName	text	Object's name that is assigned by MerlinX (original or revised)
trp_depName	text	place of departure / start
includeFromRules	text	rule name
trp_depName	text	place of departure / start
obj_name	text	The name of the object (the hotel / cruise / circuit / package)
selectAnswerFields	text	fields name
external_search_id	text	external search id
data:fields:names:mix	text	type of mixed offers
extraData	xml	Additional info about offers

<?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 name	↓ type	contains
obj_xAttributes	bitmask	Object's attributes / flag offer
ofr_candy	bitmask	Candy (bonus)
obj_bookBeds	bool	If reservation on individual beds is possible
ofr_sweet	bool	Candy - promoted flag ads (provided by the operator)
ofr_TFGincluded	bool	returns the price including TFG
obj_acomodation	char	DEPRECIATED! Code assignment, unites the value of the code room and board, used by the booking system
obj_desCode	char	Usually the airport code serving the area where hotel is located
obj_room	char	Room code/ accommodation
ofr_id	char	offer identifier. IMPORTANT: Do not assume that there will always be a hexadecimal string
ofr_status	char	last known status/availability of offers
trp_flightCode	char	service code for flight / transport
ofr_catalog	char	Catalog code
trp_rDepCode	char	departure code of the return place
ofr_tourOp	char	touroperator code
ofr_xCatalog	char	catalogs unified by MerlinX
trp_type2	char	supplement field trp_type
trp_type	char	service type of transport (plane / bus /...)
obj_type	char	Object type (hotel/round trip/cruise /...)
trp_tourCode	char
trp_rFlightCode	char	service code of the return flight / transport (information can be included also in the field trp_flightCode)
obj_code	char	hotel code
trp_season	char
trp_rDesCode	char	destination code of the return trip
ofr_operCurr	char	currency used by the operator
trp_desCode	char	Code of destination location/airport ( IATA Code )
obj_service	char	Service code/board
trp_depCode	char	Code of departure location/airport ( IATA Code )
ofr_type	char	Type of offer
data:fields:names:obj_xroomdesc	char	Room description processed by MerlinX
room_hash	char	Hotel room id
ofr_transferType	char	Info if transfer is included
obj_luggage	char	Info if main baggage is included
ofr_refundable	char	Offer have some flex rules or not
ofr_resident	char	Resident is available or not
trp_desDate	date	date of reach the destination
trp_rDepDate	date	Departure date of the return trip
trp_rDesDate	date	Date of return
trp_startDate	date	Tour start date
trp_depDate	date	Date of departure / departure / start of trip
obj_xLat	float	Latitude location of the object
obj_xLong	float	Longitude position of the object
trp_flightChangeCount	int	Number of stops for ongoing flight
obj_maxAdt	int	Maximum number of adults [DEPRECATED]
obj_xCountryId	int	ID assigned to a country by MerlinX
obj_maxPax	int	Maximum number of people [DEPRECATED]
obj_minAdt	int	The minimum number of adults [DEPRECATED]
obj_minPax	int	The minimum number of people [DEPRECATED]
obj_xCode	int	ID assigned to the hotel by MerlinX
obj_category	int	Category of the object multiplied by 10
obj_xServiceId	int	ID meal/service assigned by MerlinX
ofr_price	int	Price per adult (in the case ofr_operCurr pathologist from PLN should be taken as approximate this value!)
trp_duration	int	number of days
ofr_operPrice	int	Price per adult in the currency of the operator
trp_stay	int	number of nights
trp_durationM	int	number of days
count	int	number of matching results for the given query
obj_xRegionId	int	ID assigned to a region by MerlinX
trp_rFlightChangeCount	int	Number of stops for return flight
obj_country	text	Country
obj_name	text	The name of the object (the hotel / cruise / circuit / package)
trp_depName	text	place of departure / start
obj_xCity	text	The city in which the object is assigned by MerlinX (original or revised)
obj_rating !!! not available anymore !!!	text	Hotel rating by Zoover system
obj_xName	text	Object's name that is assigned by MerlinX (original or revised)
trp_busStopDesc	text	Description of the bus stop
trp_rCarrierCode	text	carrier code and flight number of return (if both information is available)
obj_city	text	The city in which the object is located
wtr	text	Weather information
trp_depName	text	place of departure / start
wtr_val	text	weather value
obj_serviceDesc	text	description of the meals / service
trp_carrierDesc	text	Name of carrier
obj_roomDesc	text	Description of room / accommodation
obj_region	text	The name of the region in which the object is located
trp_carrierCode	text	carrier code and flight number (if both of the information is available)
trp_busStop	text
trp_desDesc	text	place of trip/ directions
obj_xskiregpath	text	Information about ski regions
trp_flightOp	text	flight operator name
trp_rArrTime	time	time of arrival of the return trip
trp_rDepTime	time	Departure time of the return trip
trp_depTime	time	time of departure / start
trp_arrTime	time	times of trip / directions
extraData	xml	Additional info about offers

<?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>

MDSWS

Table of Contents

Inquiry: groups

Description

Inquiry

Answer

MDSWS

User Tools

Site Tools

Table of Contents

Inquiry: groups

Description

Inquiry

Answer

Page Tools