This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
ors-soap-api:public:info [2015/05/05 10:34] admin [Return parameters] |
ors-soap-api:public:info [2017/12/13 16:02] (current) admin [Examples] |
||
---|---|---|---|
Line 19: | Line 19: | ||
* ''toc'' : touroperator code - use it to get touroperator description. If you don't set ''toc'' then a general description is returned | * ''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. | * ''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 | * ''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). | * ''zhc'' : destination code (IATA code) - use it to get weather info (for ''charter'' and ''onway'' content types). | ||
Line 24: | Line 25: | ||
* ''headerData (array)'' : [[soap_header|SOAP Header Information]] | * ''headerData (array)'' : [[soap_header|SOAP Header Information]] | ||
+ | <WRAP center round tip 90%> | ||
+ | Always use ''vnd'' attribute when searching for a description of specific offer! This will ensure, that customer will receive a correct catalog description. | ||
+ | </WRAP> | ||
===== Return Values ===== | ===== Return Values ===== | ||
Line 50: | Line 54: | ||
[kn] => MEDITERAN 2013 | [kn] => MEDITERAN 2013 | ||
[ks] => 0 | [ks] => 0 | ||
+ | [catalog_start] => 2016-06-01 | ||
+ | [catalog_end] => 2016-10-15 | ||
[kw] => keywords (comma separated) | [kw] => keywords (comma separated) | ||
[desc] => product description | [desc] => product description | ||
+ | [maps] => url from google maps | ||
[pics] => Array | [pics] => Array | ||
( | ( | ||
Line 680: | Line 686: | ||
* ''kw'' : product keywords (comma separated list of keywords) | * ''kw'' : product keywords (comma separated list of keywords) | ||
* ''desc'' : product description | * ''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 | * ''included'' : text about what is included in price | ||
* ''add_sur'' : text about additional surcharges | * ''add_sur'' : text about additional surcharges | ||
Line 757: | Line 764: | ||
'toc' => 'GIATA', // touroperator code ('GIATA' is a general touroperator!) | 'toc' => 'GIATA', // touroperator code ('GIATA' is a general touroperator!) | ||
'gid' => '3264', | 'gid' => '3264', | ||
+ | 'vnd' => '2016-01-17', | ||
); | ); | ||
Line 765: | Line 773: | ||
'toc' => 'PALM', // touroperator code | 'toc' => 'PALM', // touroperator code | ||
'gid' => '3264', | 'gid' => '3264', | ||
+ | 'vnd' => '2016-01-17', | ||
); | ); | ||
Line 790: | Line 799: | ||
$info = $soapClient->orsxml_api_call( 'info', $searchParams, $header ); | $info = $soapClient->orsxml_api_call( 'info', $searchParams, $header ); | ||
</code> | </code> | ||
+ | |||
+ | ===== JSON Examples ===== | ||
+ | |||
+ | @see [[ors-soap-api:public:json_api]] how to post request. | ||
+ | |||
+ | <code php> | ||
+ | { | ||
+ | "requestType" : "info", | ||
+ | "action": "info", | ||
+ | "search": { | ||
+ | "vnd": "2018-01-10", | ||
+ | "toc": "PALM", | ||
+ | "gid": "15257" | ||
+ | }, | ||
+ | "header": { | ||
+ | "lang": "[lang]", | ||
+ | "usr" : "[usr]", | ||
+ | "pass": "[pass]", | ||
+ | "agid": "[agid]" | ||
+ | } | ||
+ | } | ||
+ | </code> | ||
+ | |||