data:request:groups
Table of Contents
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 |
|---|---|---|
| calc_found | int | minimum number of offers returned in count (maximum 1000) |
| excludeFromRules | text | rule name |
| external_search_id | text | external search id |
| extraData | xml | Additional info about offers |
| geo_xCircle | int | Search in max radius='dstance' (in kilometers) from lat,long |
| geo_xPolygon | int | Search in polygon described by at least 3 pairs of lat,long |
| group_by | char | name of the field after which data will be grouped |
| includeFromRules | text | rule name |
| limit_count | int | Number of records per page (default 10, max 100) |
| limit_from | int | first record (default 1, max 1000) |
| maxPrice | int | maximum price for an adult |
| minPrice | int | minimum price per adult |
| data:fields:names:mix | text | type of mixed offers |
| obj_bookBeds | bool | If reservation on individual beds is possible |
| obj_category | int | Category of the object multiplied by 10 |
| 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_code | char | hotel code |
| obj_luggage | char | Info if main baggage is included |
| obj_name | text | The name of the object (the hotel / cruise / circuit / package) |
| obj_room | char | Room code/ accommodation |
| obj_tourOpAndCode | char | ${kod_operatora}_${kod_obiektu} |
| obj_type | char | Object type (hotel/round trip/cruise /...) |
| obj_xAttributesCount | int | Minimum number of required attributes that match the offer |
| obj_xAttributesNotIn | bitmask | Object's attributes / flag offer |
| obj_xAttributes | bitmask | Object's attributes / flag offer |
| obj_xCityId | text | The city in which the object is assigned by MerlinX (original or revised) |
| obj_xCode | int | ID assigned to the hotel by MerlinX |
| obj_xDistBeach | int | Distance from beach |
| obj_xDistSki | int | Distance from ski lift |
| obj_xName | text | Object's name that is assigned by MerlinX (original or revised) |
| obj_xRoomDescCount | int | Minimum number of required Room description that match the offer |
| data:fields:names:obj_xroomdesc | char | Room description processed by MerlinX |
| obj_xServiceId | int | ID meal/service assigned by MerlinX |
| obj_zScoreCnt | int | search based of amount of Zoover opinions |
| obj_zScore | int | search based of Zoover rating |
| ofr_candy | bitmask | Candy (bonus) |
| ofr_catalog | char | Catalog code |
| ofr_refundable | char | Offer have some flex rules or not |
| ofr_resident | char | Resident is available or not |
| ofr_tourOp | char | touroperator code |
| ofr_transferType | char | Info if transfer is included |
| ofr_type | char | Type of offer |
| ofr_xCatalog | char | catalogs unified by MerlinX |
| ofr_xStatus | char | offer availability |
| order_by | char | number for sorting |
| par_adt | int | number of adults |
| par_chdAge | text | age of children or children bitrh dates |
| par_chd | int | Number of children |
| par_inf | int | number of infants |
| selectAnswerFields | text | fields name |
| totalPrice | bool | returns the total price for the asked product |
| trp_depCode | char | Code of departure location/airport ( IATA Code ) |
| trp_depDate | date | Date of departure / departure / start of trip |
| trp_depName | text | place of departure / start |
| trp_depName | text | place of departure / start |
| trp_destination | int | Region of the trip/event |
| trp_durationM | int | number of days |
| trp_duration | int | number of days |
| trp_flightChangeCount | int | Number of stops for ongoing flight |
| trp_rDepCode | char | departure code of the return place |
| trp_rDesCode | char | destination code of the return trip |
| trp_retDate | date | possible late date of the return trip |
| trp_rFlightChangeCount | int | Number of stops for return flight |
| trp_skiDestination | int | Destination regions for ski. |
| wtr_bi | int | search by forecast biking activities score (1-10) |
| wtr_b | int | search by forecast beach activities score (1-10) |
| wtr_c | int | search by forecast camping activities score (1-10) |
| wtr_pc | int | search by forecast precipitation chance (%) |
| wtr_p | int | search by forecast precipitation (mm) |
| wtr_sd | int | search by sun hours duration |
| wtr_tn | int | search by forecast tennis score (1-10) |
| wtr_tr | int | search by forecast terrace activities score (1-10) |
| wtr_t | int | search by forecast temperature ( in degrees Celsius ) |
| wtr_uv | int | search by UV index |
| wtr_wk | int | search by forecast walking activities score (1-10) |
| wtr_wt | int | search by forecast water sports activities score (1-10) |
| useMerlinMargin | bool | returns 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 name | type | contains |
|---|---|---|
| count | int | number of matching results for the given query |
| extraData | xml | Additional info about offers |
| obj_acomodation | char | DEPRECIATED! Code assignment, unites the value of the code room and board, used by the booking system |
| obj_bookBeds | bool | If reservation on individual beds is possible |
| obj_category | int | Category of the object multiplied by 10 |
| obj_city | text | The city in which the object is located |
| obj_code | char | hotel code |
| obj_country | text | Country |
| obj_desCode | char | Usually the airport code serving the area where hotel is located |
| obj_luggage | char | Info if main baggage is included |
| obj_maxAdt | int | Maximum number of adults [DEPRECATED] |
| 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_name | text | The name of the object (the hotel / cruise / circuit / package) |
| obj_rating !!! not available anymore !!! | text | Hotel rating by Zoover system |
| obj_region | text | The name of the region in which the object is located |
| obj_roomDesc | text | Description of room / accommodation |
| obj_room | char | Room code/ accommodation |
| obj_serviceDesc | text | description of the meals / service |
| obj_service | char | Service code/board |
| obj_type | char | Object type (hotel/round trip/cruise /...) |
| obj_xAttributes | bitmask | Object's attributes / flag offer |
| obj_xCity | text | The city in which the object is assigned by MerlinX (original or revised) |
| obj_xCode | int | ID assigned to the hotel by MerlinX |
| obj_xCountryId | int | ID assigned to a country by MerlinX |
| obj_xLat | float | Latitude location of the object |
| obj_xLong | float | Longitude position of the object |
| obj_xName | text | Object's name that is assigned by MerlinX (original or revised) |
| obj_xRegionId | int | ID assigned to a region by MerlinX |
| data:fields:names:obj_xroomdesc | char | Room description processed by MerlinX |
| obj_xServiceId | int | ID meal/service assigned by MerlinX |
| obj_xskiregpath | text | Information about ski regions |
| ofr_candy | bitmask | Candy (bonus) |
| ofr_catalog | char | Catalog code |
| ofr_id | char | offer identifier. ** IMPORTANT: ** Do not assume that there will always be a hexadecimal string |
| ofr_operCurr | char | currency used by the operator |
| ofr_operPrice | int | Price per adult in the currency of the operator |
| ofr_price | int | Price per adult (in the case ofr_operCurr pathologist from PLN should be taken as approximate this value!) |
| ofr_refundable | char | Offer have some flex rules or not |
| ofr_resident | char | Resident is available or not |
| ofr_status | char | last known status/availability of offers |
| ofr_sweet | bool | Candy - promoted flag ads (provided by the operator) |
| ofr_TFGincluded | bool | returns the price including TFG |
| ofr_tourOp | char | touroperator code |
| ofr_transferType | char | Info if transfer is included |
| ofr_type | char | Type of offer |
| ofr_xCatalog | char | catalogs unified by MerlinX |
| room_hash | char | Hotel room id |
| trp_desDesc | text | place of trip/ directions |
| trp_arrTime | time | times of trip / directions |
| trp_busStopDesc | text | Description of the bus stop |
| trp_busStop | text | |
| trp_carrierCode | text | carrier code and flight number (if both of the information is available) |
| trp_carrierDesc | text | Name of carrier |
| trp_depCode | char | Code of departure location/airport ( IATA Code ) |
| trp_depDate | date | Date of departure / departure / start of trip |
| trp_depName | text | place of departure / start |
| trp_depName | text | place of departure / start |
| trp_depTime | time | time of departure / start |
| trp_desCode | char | Code of destination location/airport ( IATA Code ) |
| trp_desDate | date | date of reach the destination |
| trp_durationM | int | number of days |
| trp_duration | int | number of days |
| trp_flightCode | char | service code for flight / transport |
| trp_flightOp | text | flight operator name |
| trp_flightChangeCount | int | Number of stops for ongoing flight |
| trp_rArrTime | time | time of arrival of the return trip |
| trp_rCarrierCode | text | carrier code and flight number of return (if both information is available) |
| trp_rDepCode | char | departure code of the return place |
| trp_rDepDate | date | Departure date of the return trip |
| trp_rDepTime | time | Departure time of the return trip |
| trp_rDesCode | char | destination code of the return trip |
| trp_rDesDate | date | Date of return |
| trp_rFlightCode | char | service code of the return flight / transport (information can be included also in the field trp_flightCode) |
| trp_rFlightChangeCount | int | Number of stops for return flight |
| trp_season | char | |
| trp_startDate | date | Tour start date |
| trp_stay | int | number of nights |
| trp_tourCode | char | |
| trp_type2 | char | supplement field trp_type |
| trp_type | char | service type of transport (plane / bus /...) |
| wtr_val | text | weather value |
| wtr | text | Weather 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>
data/request/groups.txt · Last modified: 2012/07/27 12:01 by marekj
Page Tools
