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.
====== getUnits method ======

Get a list of touroperator units.

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


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

===== Description =====

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

===== Parameters =====

  * ''searchData (array)'' : search parameters. Required serach parameters: ''toc''. Non mandatory parameters: ''objectId'', ''unitId''
  * ''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 units. Here is an example of output:

<code>
Array
(
    [objects] => Array
        (
            [0] => Array
                (
                    [id] => 4081
                    [objectName] => Apartmaji Vila Maia
                    [objectPlace] => Strunjan
                    [objectCountryIso] => SI
                    [units] => Array
                        (
                            [17281] => Array
                                (
                                    [id] => 17281
                                    [unitName] => A2+2
                                    [unitType] => AP
                                    [unitView] => pool
                                )

                            [17291] => Array
                                (
                                    [id] => 17291
                                    [unitName] => B4+2
                                    [unitType] => AP
                                    [unitView] => pool
                                )

                        )

                )

        )

)
</code>


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

  * ''objects'' (array) : list of objects
    * ''id'' : object ID
    * ''objectName'' : object name
    * ''objectPlace'' : object place
    * ''objectCountryIso'' : object country ISO code
    * ''units'' (array) : list of units
      * ''id'' : unit ID
      * ''unitName'' : unit name
      * ''unitType'' : unit type
      * ''unitView'' : unit view
   
===== 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
