ORS Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== getObjects method ======

Get a list of touroperator objects.

===== Valid content types =====


  * ''hotel'' (at the moment only this content type is supported)

===== Description =====

<code php>
public string getObjects( array $searchData, array $headerData)
</code>

===== Parameters =====

  * ''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'')

===== Return Values =====

Returns a list of available objects. Here is an example of output (string is always returned):

<code>
array
(
    [objects] => Array
        (
            [0] => Array
                (
                    [id] => 4081
                    [objectName] => Apartmaji Vila Maia
                    [objectPlace] => Strunjan
                    [objectCountryIso] => SI
                )

            [1] => Array
                (
                    [id] => 5471
                    [objectName] => Vile Terme Zreče
                    [objectPlace] => Zreče
                    [objectCountryIso] => SI
                )

            [2] => Array
                (
                    [id] => 7871
                    [objectName] => Villa Piranesi
                    [objectPlace] => Piran
                    [objectCountryIso] => SI
                )
...
</code>

===== Return parameters =====

  * ''objects'' (array) : list of objects
    * ''id'' : object ID
    * ''objectName'' : object name
    * ''objectPlace'' : object place
    * ''objectCountryIso'' : object country ISO code


===== Examples =====

   * Example with basic search parameters with selected region group ID

<code php>
$searchParams = array(
  'toc' => 'APP',       // touroperator code
);

$objects = $soapClient->orsxml_hotel_api_call( 'getObjects', $searchParams, $header );
</code>

  * Example : search object by id

<code php>
$searchParams = array(
  'toc' => 'APP',       // touroperator code
  'objectId' => '4081', // object id
);

$objects = $soapClient->orsxml_hotel_api_call( 'getObjects', $searchParams, $header );
</code>
ORS Documentation

User Tools

Site Tools

Page Tools
