====== Info method ======
Info method is used to retrieve a product description, weather information, geo location, hotel ratings, climate information, ...
===== Valid content types =====
This method does not depend on any content type.
===== Description =====
public array info( array $searchData, mixed $headerData )
===== Parameters =====
* ''searchData (array)'' : this array must contain a combination of the following parameters:
* ''gid'' : GIATA ID - use it for product description and hotel ratings
* ''toc'' : touroperator code - use it to get touroperator description. If you don't set ''toc'' then a general description is returned
* ''htc'' : hotel code - hotel code or product code is defined by tour operators. Use this code to get exact offer description.
* ''vnd'' : check in date (enter an offer start tate, to get a correct catalog, since touroperators can have winter and summer catalogs - without this information, API will return the latest catalog and its description)
* ''rgc'' : region code - use it to get weather info
* ''zhc'' : destination code (IATA code) - use it to get weather info (for ''charter'' and ''onway'' content types).
* ''headerData (array)'' : [[soap_header|SOAP Header Information]]
Always use ''vnd'' attribute when searching for a description of specific offer! This will ensure, that customer will receive a correct catalog description.
===== Return Values =====
Returns different information , depending on search params.
Array
(
[xmlReq] =>
[hotel_info] => Array
(
[toc] => PALM
[ton] => Palma
[pic] => http://www.ors.si/ibe/ikonce/toc/palm.gif
[htn] => Hotel Marbel ***
[hon] => Can Pastilla
[gid] => 3264
[stc] => 0
[htcs] => Array
(
)
[kid] => 83
[kn] => MEDITERAN 2013
[ks] => 0
[catalog_start] => 2016-06-01
[catalog_end] => 2016-10-15
[kw] => keywords (comma separated)
[desc] => product description
[maps] => url from google maps
[pics] => Array
(
[0] => Array
(
[code] => an
[name] => Exterior
[url] => http://elive.ors.si/showPic.php?id=3914068
[url_big] =>
)
[1] => Array
(
[code] => an
[name] => Exterior
[url] => http://elive.ors.si/showPic.php?id=3914069
[url_big] =>
)
[2] => Array
(
[code] => an
[name] => Exterior
[url] => http://elive.ors.si/showPic.php?id=3914070
[url_big] =>
)
)
[fcts] => Array
(
[bea] => Array
(
[code] => bea
[value] => 0
[name] => directly on the beach
)
[ben] => Array
(
[code] => ben
[value] => 0
[name] => near the beach (approx. 100-500m)
)
[chf] => Array
(
[code] => chf
[value] => 0
[name] => family friendly
)
[clb] => Array
(
[code] => clb
[value] => 0
[name] => club hotel
)
[ani] => Array
(
[code] => ani
[value] => 0
[name] => entertainment program
)
[pol] => Array
(
[code] => pol
[value] => 0
[name] => pool
)
[wel] => Array
(
[code] => wel
[value] => 0
[name] => rich wellness offer
)
[spt] => Array
(
[code] => spt
[value] => 0
[name] => a wide range of sports activities
)
[sgl] => Array
(
[code] => sgl
[value] => 0
[name] => golf
)
[stn] => Array
(
[code] => stn
[value] => 0
[name] => tennis
)
[ski] => Array
(
[code] => ski
[value] => 0
[name] => skiing
)
)
[toc_desc] => 1
[htc_desc] => 0
[lang] => en
)
[weather_info] => Array
(
[cw] => Array
(
[temp] => 27
[pic] => http://www.ors.si/ibe/ikonce/vreme/30.png
)
[fw] => Array
(
[0] => Array
(
[day] => Aug 19
[d] => 19
[m] => 8
[hi] => 31
[low] => 20
[pic] => http://www.ors.si/ibe/ikonce/vreme/32.png
)
[1] => Array
(
[day] => Aug 20
[d] => 20
[m] => 8
[hi] => 30
[low] => 21
[pic] => http://www.ors.si/ibe/ikonce/vreme/34.png
)
[2] => Array
(
[day] => Aug 21
[d] => 21
[m] => 8
[hi] => 29
[low] => 20
[pic] => http://www.ors.si/ibe/ikonce/vreme/30.png
)
[3] => Array
(
[day] => Aug 22
[d] => 22
[m] => 8
[hi] => 30
[low] => 20
[pic] => http://www.ors.si/ibe/ikonce/vreme/34.png
)
[4] => Array
(
[day] => Aug 23
[d] => 23
[m] => 8
[hi] => 30
[low] => 19
[pic] => http://www.ors.si/ibe/ikonce/vreme/34.png
)
[5] => Array
(
[day] => Aug 24
[d] => 24
[m] => 8
[hi] => 31
[low] => 18
[pic] => http://www.ors.si/ibe/ikonce/vreme/32.png
)
)
)
[region_info] => Array
(
[rgc] => 133
[rgn] => Mallorca
[rgg] => Balearic Islands
[desc] => region description
[pics] => Array
(
[0] => Array
(
[name] => sklop hotelov
[url] => http://www.ors.si/ibe/opisi/pics/4539.jpg
)
[1] => Array
(
[name] => katedrala Palma de Mallorca
[url] => http://www.ors.si/ibe/opisi/pics/4540.jpg
)
[2] => Array
(
[name] => katedrala ponoci
[url] => http://www.ors.si/ibe/opisi/pics/4541.jpg
)
[3] => Array
(
[name] => tradicionalna vprega
[url] => http://www.ors.si/ibe/opisi/pics/4542.jpg
)
)
)
[votes_info] => Array
(
)
[votes_hc_info] => Array
(
[info] => Array
(
[gid] => 3264
[hcid] => 81363
[cnt] => 33
[emf] => 85.7
)
[overall] => Array
(
[ovr] => 77
[htl] => 76
[loc] => 89
[svc] => 77
[fod] => 67
[rom] => 75
[spt] => 81
[emf] => 85.71429
)
[single] => Array
(
[ovr] => 70
[htl] => 72
[loc] => 83
[svc] => 68
[fod] => 60
[rom] => 67
[spt] => 67
[emf] => 66.666664
)
[couple] => Array
(
[ovr] => 79
[htl] => 79
[loc] => 90
[svc] => 81
[fod] => 67
[rom] => 77
[spt] => 92
[emf] => 85.71429
)
[family] => Array
(
[ovr] => 74
[htl] => 78
[loc] => 86
[svc] => 78
[fod] => 75
[rom] => 73
[spt] => 50
[emf] => 100.0
)
[friends] => Array
(
[ovr] => 79
[htl] => 69
[loc] => 95
[svc] => 76
[fod] => 73
[rom] => 82
[spt] => 83
[emf] => 100.0
)
)
[climate_info] => Array
(
[dtemp] => 14,15,17,19,23,27,29,30,27,23,18,15
[wtemp] => 14,13,14,15,17,21,24,25,24,21,18,15
)
[geo_info] => Array
(
[lat] => 39.5368537593604900
[lon] => 2.7167263627052307
)
[characteristics_info] => Array
(
[0] => Array
(
[group] => Array
(
[code] => beach
[text] => Beach
)
[items] => Array
(
[0] => Array
(
[code] => beach_directly
[value] => true
[type] => bool
[text] => Directly at the beach
)
)
)
[1] => Array
(
[group] => Array
(
[code] => facilities
[text] => Hotel equipment
)
[items] => Array
(
[0] => Array
(
[code] => facility_aircon
[value] => true
[type] => bool
[text] => Air conditioning
)
[1] => Array
(
[code] => facility_reception24
[value] => true
[type] => bool
[text] => Reception open 24 hours
)
[2] => Array
(
[code] => facility_hairdresser
[value] => 1
[type] => int
[text] => Hairdresser
)
[3] => Array
(
[code] => facility_bars
[value] => 1
[type] => int
[text] => Bar(s)
)
[4] => Array
(
[code] => facility_restaurants
[value] => 1
[type] => int
[text] => Restaurant(s)
)
[5] => Array
(
[code] => facility_carpark
[value] => true
[type] => bool
[text] => Parking
)
[6] => Array
(
[code] => facility_playground
[value] => true
[type] => bool
[text] => Playground
)
)
)
[2] => Array
(
[group] => Array
(
[code] => room_facilities
[text] => Rook equipment
)
[items] => Array
(
[0] => Array
(
[code] => room_shower
[value] => true
[type] => bool
[text] => Shower
)
[1] => Array
(
[code] => room_hairdryer
[value] => true
[type] => bool
[text] => Hair dryer
)
[2] => Array
(
[code] => room_directdialtel
[value] => true
[type] => bool
[text] => Telephone with direct selection
)
[3] => Array
(
[code] => room_minibar
[value] => true
[type] => bool
[text] => Mini-bar
)
[4] => Array
(
[code] => room_aircon
[value] => true
[type] => bool
[text] => Air conditioning (central regulator)
)
[5] => Array
(
[code] => room_safe
[value] => true
[type] => bool
[text] => Safe
)
[6] => Array
(
[code] => room_balcony
[value] => true
[type] => bool
[text] => Balcony/Terrace
)
[7] => Array
(
[code] => room_tv
[value] => true
[type] => bool
[text] => TV
)
)
)
[3] => Array
(
[group] => Array
(
[code] => meals
[text] => Supplies
)
[items] => Array
(
[0] => Array
(
[code] => meals_halfboard
[value] => true
[type] => bool
[text] => Half board
)
[1] => Array
(
[code] => meals_breakfastbuffet
[value] => false
[type] => bool
[text] => Breakfast buffet
)
)
)
[4] => Array
(
[group] => Array
(
[code] => sports_entertainment
[text] => Entertainment program
)
[items] => Array
(
[0] => Array
(
[code] => sports_sunloungers
[value] => 1
[type] => int
[text] => Sunlougers
)
[1] => Array
(
[code] => sports_sauna
[value] => 1
[type] => int
[text] => Sauna
)
[2] => Array
(
[code] => sports_massage
[value] => 1
[type] => int
[text] => Massage
)
[3] => Array
(
[code] => sports_scuba
[value] => 1
[type] => int
[text] => Diving
)
[4] => Array
(
[code] => sports_tabletennis
[value] => 1
[type] => int
[text] => Table tennis
)
[5] => Array
(
[code] => sports_gym
[value] => 1
[type] => int
[text] => Fitness Studio
)
[6] => Array
(
[code] => sports_boccia
[value] => 1
[type] => int
[text] => Curling
)
[7] => Array
(
[code] => sports_minigolf
[value] => 1
[type] => int
[text] => Mini-Golf
)
[8] => Array
(
[code] => sports_tennis
[value] => 1
[type] => int
[text] => Tennis
)
[9] => Array
(
[code] => sports_tanning_studio
[value] => 1
[type] => int
[text] => Solarium
)
)
)
)
===== Return parameters =====
* ''xmlReq'' : for internal use only
* ''hotel_info (array)'' : product information
* ''toc'' : touroperator code
* ''ton'' : touroperator name
* ''pic'' : touroperator logo
* ''htn'' : product name
* ''hon'' : city
* ''gid'' : GIATA ID
* ''stc'' : hotel category
* ''htcs array()'' : a list of possible product codes (this is not always present)
* ''kid'' : catalogue ID (touroperators have their descriptions in catalogues)
* ''kn'' : catalogue name
* ''ks'' : page in catalogue
* ''kw'' : product keywords (comma separated list of keywords)
* ''desc'' : product description
* ''maps'' : url from google maps (or similar) describing a roundtrip tour (only available from some touroperators in trips content type)
* ''included'' : text about what is included in price
* ''add_sur'' : text about additional surcharges
* ''pics (array)'' : pictures
* ''code'' : picture code (list of [[picture codes]])
* ''name'' : name of a picture
* ''url'' : url location
* ''url_big'' : sometimes touroperator offers 800px wide pictures. You can use this for gallery.
* ''fcts (array)'' : hotel facts (list of [[hotel_facts|hotel facts]])
* ''code'' : hotel fact code
* ''value'' : (1) a fact is set for this hotel, (0) a fact is not set
* ''name'' : a fact name
* ''toc_desc'' : (1) this is touroperator desctiption, (0) this is a general description
* ''htc_desc'' : (1) this is a description for exact offer, (0) this is a general product description
* ''lang'' : language ISO code
* ''weather_info (array)'' : weather information for selected region
* ''cw (array)'' : current weather
* ''temp'': temperature (in degrees Celsius)
* ''pic'' : weather icon
* ''fw (array)'' : forecast (today + the next 5 days)
* ''day'' : formated day (format: 'M j')
* ''d'' : day
* ''m'' : month (1 - January, 12 - December)
* ''hi'' : high temperature
* ''low'' : low temperature
* ''pic'' : weather incon
* ''region_info (array)'' : region information (**this is not used anymore!**)
* ''rgc'' : region code
* ''rgn'' : region name
* ''rgg'' : region group name
* ''desc'' region description
* ''pics (array)'' : pictures
* ''name'' : picture name
* ''url'' : url location
* ''votes_info (array)'' : old ratings (**this is not used anymore!**)
* ''votes_hc_info (array)'' : Holiday Ceck hotel ratings ( you must have a Holiday Check contract in order to get this ratings )
* ''info (array)'' : basic ratings info
* ''gid'' : GIATA ID
* ''hcid'' : holiday check ID
* ''cnt'' : number of evaluators
* ''emf'' : recommendation (in percents)
* ''overall (array)'' : overall ratings
* ''ovr'' : overall rating
* ''htl'' : hotel rating
* ''loc'' : location rating
* ''svc'' : service rating
* ''fod'' : food rating
* ''rom'' : room rating
* ''spt'' : sports rating
* ''emf'' : recommendation (in percents)
* ''single (array)'' : ratings of singles (same attributes as for ''overall'')
* ''couple (array)'' : ratings of couples (same attributes as for ''overall'')
* ''family (array)'' : ratings of families (same attributes as for ''overall'')
* ''friends (array)'' : ratings of friends (same attributes as for ''overall'')
* ''climate_info'' : climate info (temperatures for entire year)
* ''dtemp'' : air temperature for entire year (twelve values separated by comma, first value is January)
* ''wtemp'' : water temperature for entire year (twelve values separated by comma, first value is January)
* ''geo_info (array)'' : geo location of hotel (GPS coordinates)
* ''lat'' : latitude
* ''lan'' : longitude
* ''characteristics_info'' (array) : property characteristics
* ''group'' (array) : group
* ''code'' : code for group
* ''text'' : group name
* ''items'' (array) : characteristics
* ''code'' : code for characteristic
* ''type'' : type of value (**bool**, **int**, **float**, **string**)
* ''value'' : the value of this characteristics (__true__ or __false__ if type is bool or a number if type is int)
===== Examples =====
* Example for getting a product information. When sending GIATA ID, a hotel description, geo location and ratings will be returned.
// general hotel description
$searchParams = array(
'toc' => 'GIATA', // touroperator code ('GIATA' is a general touroperator!)
'gid' => '3264',
'vnd' => '2016-01-17',
);
$info = $soapClient->orsxml_api_call( 'info', $searchParams, $header );
// touroperator description
$searchParams = array(
'toc' => 'PALM', // touroperator code
'gid' => '3264',
'vnd' => '2016-01-17',
);
$info = $soapClient->orsxml_api_call( 'info', $searchParams, $header );
// description for a specific offer using product code
$searchParams = array(
'toc' => 'PALM', // touroperator code
'gid' => '3264',
'htc' => 'LEMAL0011433', // product code
);
$info = $soapClient->orsxml_api_call( 'info', $searchParams, $header );
* Example for getting a product information and weather info. When sending region code, a weather info, region info and climate info will be returned.
$searchParams = array(
'toc' => 'PALM', // touroperator code
'gid' => '3264',
'rgc' => '133', // region code (if region code is set then a weather info is also returned)
);
$info = $soapClient->orsxml_api_call( 'info', $searchParams, $header );
===== JSON Examples =====
@see [[ors-soap-api:public:json_api]] how to post request.
{
"requestType" : "info",
"action": "info",
"search": {
"vnd": "2018-01-10",
"toc": "PALM",
"gid": "15257"
},
"header": {
"lang": "[lang]",
"usr" : "[usr]",
"pass": "[pass]",
"agid": "[agid]"
}
}