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:getobjects [2015/02/18 20:28] admin [Parameters] |
ors-soap-api:public:getobjects [2015/02/21 20:10] (current) admin |
||
|---|---|---|---|
| Line 11: | Line 11: | ||
| <code php> | <code php> | ||
| - | public array getObjects( array $searchData, array $headerData) | + | public string getObjects( array $searchData, array $headerData) |
| </code> | </code> | ||
| Line 17: | Line 17: | ||
| * ''searchData (array)'' : search parameters. Required serach parameters: ''toc''. Non mandatory parameters: ''objectId'' | * ''searchData (array)'' : search parameters. Required serach parameters: ''toc''. Non mandatory parameters: ''objectId'' | ||
| - | * ''headerData (array)'' : in addition to [[soap_header|SOAP Header Information]] , you'll need an export account credentials (''xuser'', ''xpass' | + | * ''headerData (array)'' : in addition to [[soap_header|SOAP Header Information]] , you'll need an export account credentials (''xuser'', ''xpass'') |
| - | ') | + | |
| ===== Return Values ===== | ===== Return Values ===== | ||
| - | Returns a list of available objects. Here is an example of output: | + | Returns a list of available objects. Here is an example of output (string is always returned): |
| <code> | <code> | ||
| Line 40: | Line 39: | ||
| ( | ( | ||
| [id] => 5471 | [id] => 5471 | ||
| - | [objectName] => Vile Terme ZreÄe | + | [objectName] => Vile Terme Zreče |
| - | [objectPlace] => ZreÄe | + | [objectPlace] => Zreče |
| [objectCountryIso] => SI | [objectCountryIso] => SI | ||
| ) | ) | ||
| Line 54: | Line 53: | ||
| ... | ... | ||
| </code> | </code> | ||
| - | |||
| ===== Return parameters ===== | ===== Return parameters ===== | ||
| Line 63: | Line 61: | ||
| * ''objectPlace'' : object place | * ''objectPlace'' : object place | ||
| * ''objectCountryIso'' : object country ISO code | * ''objectCountryIso'' : object country ISO code | ||
| - | + | ||
| ===== Examples ===== | ===== Examples ===== | ||
| - | * Example with basic search parameters with selected region group ID | + | * Example with basic search parameters with selected region group ID |
| <code php> | <code php> | ||
| $searchParams = array( | $searchParams = array( | ||
| Line 76: | Line 76: | ||
| * Example : search object by id | * Example : search object by id | ||
| + | |||
| <code php> | <code php> | ||
| $searchParams = array( | $searchParams = array( | ||
| Line 84: | Line 85: | ||
| $objects = $soapClient->orsxml_hotel_api_call( 'getObjects', $searchParams, $header ); | $objects = $soapClient->orsxml_hotel_api_call( 'getObjects', $searchParams, $header ); | ||
| </code> | </code> | ||
| - | |||
| | | ||