Units method [ORS Documentation]

ors-soap-api:public:units

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

====== Units method ======

Get a list of units (rooms)

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

  * ''dhotel''

===== Description =====

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

===== Parameters =====

  * ''searchData (array)'' : search parameters. Required serach parameters: ''vnd'', ''bsd'', ''epc'', ''gid''
  * ''headerData (array)'' : [[soap_header|SOAP Header Information]]


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

Returns a list of available trips. Here is an example of output:

<code>
Array
(
    [header] => Array
        (
            [typ] => dhotel
            [offers] => 32
            [ver] => 2.0
            [tocp] => FTI
            [sid] => ftuomshq2as3vrk62ie3uerhc5
        )

    [offer] => Array
        (
            [pic] => http://www.ors.si/giata-pics/2224352079381/full.jpg
            [gid] => 2224352079381
            [htn] => Bretanide Wellness & Sport Resort
            [stc] => 4.0
            [oid] => 18703
            [hon] => Bol / Brac
            [rgc] => 659
            [rgn] => Dalmatia
            [rgg] => 100023
            [rggn] => Croatia
            [geo] => 0
        )
        
    [top_units] => Array
        (
            [info] => Array
                (
                    [toc] => FTI
                    [pic] => http://www.ors.si/ibe/ikonce/toc/fti.gif
                    [name] => FTI
                )

            [rooms] => Array
                (
                    [0] => Array
                        (
                            [info] => Array
                                (
                                    [gid] => 202371
                                    [code] => X17H002EA00013:000000020000001B000A988F6
                                    [name] => 
                                    [zac] => DZ
                                    [zac] => double room
                                    [vpc] => OV
                                    [vpn] => room only
                                    [ppc] => 30
                                    [cppc] => 35.00
                                    [cppc_perc] => -15
                                    [htc] => ES9730.885.4
                                    [ltx] => 
                                    [atx] =>
                                    [price_type] => 0
                                    [pax] => 2
                                    [bedrooms] => 1
                                    [m2size] => 25
                                )

                            [attributes] => Array
                                (
                                    [0] => Array
                                        (
                                            [type] => float
                                            [name] => category_recommended
                                            [value] => 3
                                            [desc] => PriporoÄena kategorija
                                        )

                                    [1] => Array
                                        (
                                            [type] => bool
                                            [name] => hoteltype_cityhotel
                                            [value] => true
                                            [desc] => Mestni hotel
                                        )

                                    [2] => Array
                                        (
                                            [type] => bool
                                            [name] => hoteltype_apartmenthotel
                                            [value] => true
                                            [desc] => Aparthotel
                                        )
                                        ......
                            )
                            [pictures] => Array
                                (
                                    [0] => http://i9.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=fti&cid=14507&file=11262451_20828347.jpg
                                    [1] => http://i9.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=fti&cid=14507&file=008257_9173677.jpg
                                    [2] => http://i9.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=fti&cid=14507&file=008257_9173678.jpg
                                    [3] => http://i9.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=fti&cid=14507&file=008257_9173675.jpg
                                    [4] => http://i9.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=fti&cid=14507&file=11262452_20828351.jpg
                                    [5] => http://i9.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=fti&cid=14507&file=008257_9173676.jpg
                                    [6] => http://i9.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=fti&cid=14507&file=008257_9173674.jpg
                                    [7] => http://i9.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=fti&cid=14507&file=11262453_20828354.jpg
                                    [8] => http://i9.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=fti&cid=14507&file=11262454_20828355.jpg
                                )

                        )
                        ...
                        
[tocs] => Array
        (
            [0] => Array
                (
                    [info] => Array
                        (
                            [toc] => 5VF
                            [pic] => http://www.ors.si/ibe/ikonce/toc/5vf.gif
                            [name] => 5 Vor Flug
                        )

                    [rooms] => Array
                        (
                            [0] => Array
                                (
                                    [info] => Array
                                        (
                                            [gid] => 202371
                                            [code] => X44H000170000F:0000000300000011400A988EF
                                            [name] => 
                                            [zac] => DZ
                                            [vpc] => OV
                                            [ppc] => 21
                                            [cppc_perc] => -15
                                        )
                                        
                                [attributes] => Array
                                (
                                    [0] => Array
                                        (
                                            [type] => float
                                            [name] => category_recommended
                                            [value] => 3
                                            [desc] => PriporoÄena kategorija
                                        )

                                    [1] => Array
                                        (
                                            [type] => bool
                                            [name] => hoteltype_cityhotel
                                            [value] => true
                                            [desc] => Mestni hotel
                                        )
                                        ....
                                    )

                                    [pictures] => Array
                                        (
                                            [0] => http://i6.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=11262451_20828347.jpg
                                            [1] => http://i6.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=008257_9173677.jpg
                                            [2] => http://i6.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=008257_9173678.jpg
                                            [3] => http://i6.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=008257_9173675.jpg
                                            [4] => http://i6.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=11262452_20828351.jpg
                                            [5] => http://i6.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=008257_9173676.jpg
                                            [6] => http://i6.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=008257_9173674.jpg
                                            [7] => http://i6.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=11262453_20828354.jpg
                                            [8] => http://i6.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=11262454_20828355.jpg
                                        )

                                )

                            [1] => Array
                                (
                                    [info] => Array
                                        (
                                            [gid] => 202371
                                            [code] => X44H0001700007:0000000300000011400A988EF
                                            [name] => 
                                            [zac] => DZ
                                            [vpc] => OV
                                            [ppc] => 28
                                        )

                                [attributes] => Array
                                (
                                    [0] => Array
                                        (
                                            [type] => float
                                            [name] => category_recommended
                                            [value] => 3
                                            [desc] => PriporoÄena kategorija
                                        )

                                    [1] => Array
                                        (
                                            [type] => bool
                                            [name] => hoteltype_cityhotel
                                            [value] => true
                                            [desc] => Mestni hotel
                                        )
                                        ....
                                    )

                                    [pictures] => Array
                                        (
                                            [0] => http://i6.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=11262451_20828347.jpg
                                            [1] => http://i6.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=008257_9173677.jpg
                                            [2] => http://i6.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=008257_9173678.jpg
                                            [3] => http://i6.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=008257_9173675.jpg
                                            [4] => http://i6.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=11262452_20828351.jpg
                                            [5] => http://i6.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=008257_9173676.jpg
                                            [6] => http://i6.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=008257_9173674.jpg
                                            [7] => http://i6.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=11262453_20828354.jpg
                                            [8] => http://i6.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=11262454_20828355.jpg
                                        )

                                )

                            [2] => Array
                                (
                                    [info] => Array
                                        (
                                            [gid] => 202371
                                            [code] => X44H0001700009:0000000300000012400A988F0
                                            [name] => 
                                            [zac] => DZ
                                            [vpc] => UF
                                            [ppc] => 31
                                        )
                                [attributes] => Array
                                (
                                    [0] => Array
                                        (
                                            [type] => float
                                            [name] => category_recommended
                                            [value] => 3
                                            [desc] => PriporoÄena kategorija
                                        )

                                    [1] => Array
                                        (
                                            [type] => bool
                                            [name] => hoteltype_cityhotel
                                            [value] => true
                                            [desc] => Mestni hotel
                                        )
                                        ....
                                    )

                                    [pictures] => Array
                                        (
                                            [0] => http://i6.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=11262451_20828347.jpg
                                            [1] => http://i6.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=008257_9173677.jpg
                                            [2] => http://i6.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=008257_9173678.jpg
                                            [3] => http://i6.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=008257_9173675.jpg
                                            [4] => http://i6.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=11262452_20828351.jpg
                                            [5] => http://i6.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=008257_9173676.jpg
                                            [6] => http://i6.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=008257_9173674.jpg
                                            [7] => http://i6.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=11262453_20828354.jpg
                                            [8] => http://i6.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=11262454_20828355.jpg
                                        )

                                )

                            [3] => Array
                                (
                                    [info] => Array
                                        (
                                            [gid] => 202371
                                            [code] => X44H0001700001:0000000300000012400A988F0
                                            [name] => 
                                            [zac] => DZ
                                            [vpc] => UF
                                            [ppc] => 37
                                        )

                                [attributes] => Array
                                (
                                    [0] => Array
                                        (
                                            [type] => float
                                            [name] => category_recommended
                                            [value] => 3
                                            [desc] => PriporoÄena kategorija
                                        )

                                    [1] => Array
                                        (
                                            [type] => bool
                                            [name] => hoteltype_cityhotel
                                            [value] => true
                                            [desc] => Mestni hotel
                                        )
                                        ....
                                    )
                                    
                                    [pictures] => Array
                                        (
                                            [0] => http://i9.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=11262451_20828347.jpg
                                            [1] => http://i9.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=008257_9173677.jpg
                                            [2] => http://i9.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=008257_9173678.jpg
                                            [3] => http://i9.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=008257_9173675.jpg
                                            [4] => http://i9.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=11262452_20828351.jpg
                                            [5] => http://i9.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=008257_9173676.jpg
                                            [6] => http://i9.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=008257_9173674.jpg
                                            [7] => http://i9.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=11262453_20828354.jpg
                                            [8] => http://i9.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=11262454_20828355.jpg
                                        )

                                )

                            [4] => Array
                                (
                                    [info] => Array
                                        (
                                            [gid] => 202371
                                            [code] => X44H000170000B:0000000300000013400A988F1
                                            [name] => 
                                            [zac] => DZ
                                            [vpc] => HP
                                            [ppc] => 41
                                        )

                                [attributes] => Array
                                (
                                    [0] => Array
                                        (
                                            [type] => float
                                            [name] => category_recommended
                                            [value] => 3
                                            [desc] => PriporoÄena kategorija
                                        )

                                    [1] => Array
                                        (
                                            [type] => bool
                                            [name] => hoteltype_cityhotel
                                            [value] => true
                                            [desc] => Mestni hotel
                                        )
                                        ....
                                    )

                                    [pictures] => Array
                                        (
                                            [0] => http://i7.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=11262451_20828347.jpg
                                            [1] => http://i7.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=008257_9173677.jpg
                                            [2] => http://i7.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=008257_9173678.jpg
                                            [3] => http://i7.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=008257_9173675.jpg
                                            [4] => http://i7.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=11262452_20828351.jpg
                                            [5] => http://i7.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=008257_9173676.jpg
                                            [6] => http://i7.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=008257_9173674.jpg
                                            [7] => http://i7.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=11262453_20828354.jpg
                                            [8] => http://i7.giatamedia.de/s.php?uid=157097&source=xml&size=320&vea=5vf&cid=2492&file=11262454_20828355.jpg
                                        )

                                )
</code>



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

  * ''header'' (array) : information about a selected region and paging information
    * ''typ'' : content type
    * ''offers'' : number of offers found
    * ''sid'' : session id used
  * ''offer (array)'' : an offer information 
    * ''pic'' : full picture
    * ''gid'' : GIATA ID
    * ''htn'' : accommodation name
    * ''stc'' : hotel category
    * ''hon'' : city name
    * ''oid'' : city ID
    * ''rgc'' : region code (ID)
    * ''rgn'' : region name
    * ''rgg'' : region group ID
    * ''rggn'' : region group name
    * ''geo'' : does this property has a geo location coordinates (1) or not (0)
    * ''lat'' : latitude
    * ''lon'' : longitude
  * ''top_units (array)'' : top units array (when using filter or tocp parameter)
    * ''info'' (array): touroperator info
      * ''toc'' : touroperator code
      * ''pic'' : touroperator logo
      * ''name'' : touroperator name
    * ''rooms'' (array) : a list of rooms
    * ''info'' (array) : room info
      * ''gid'' : GIATA ID
      * ''code'' : room code
      * ''name'' : room name
      * ''zac'' : room type
      * ''vpc'' : service type
      * ''vpn'' : service type name
      * ''zan'' : room type name
      * ''ppc'' : price
      * ''cppc'' : catalog price
      * ''cppc_perc'' : amount of discount used (in percents)
      * ''ltx'' : view
      * ''atx'' : facilities
      * ''htc'' : product code
      * ''price_type'' : 0 - price per person , 1 - price per unit
      * ''pax'' : number of persons
      * ''bedrooms'' : number of bedrooms
      * ''m2size'' : square meter 
    * ''attributes'' (array) : room attributes
      * ''type'' : attribute type (bool, int, float, string)
      * ''name'' : attribute name (code)
      * ''value'' : value
      * ''desc'' : description
    * ''pictures'' (array) : a list of room pictures

  * ''tocs (array)'' : a list of rooms per touroperator
    * ''info'' (array): touroperator info
      * ''toc'' : touroperator code
      * ''pic'' : touroperator logo
      * ''name'' : touroperator name
    * ''rooms'' (array) : a list of rooms
    * ''info'' (array) : room info
      * ''gid'' : GIATA ID
      * ''code'' : room code
      * ''name'' : room name
      * ''zac'' : room type
      * ''zan'' : room type name
      * ''vpc'' : service type
      * ''vpn'' : service type name
      * ''ppc'' : price
      * ''cppc'' : catalog price
      * ''cppc_perc'' : amount of discount used (in percents)
      * ''ltx'' : view
      * ''atx'' : facilities
      * ''htc'' : product code
      * ''price_type'' : 0 - price per person , 1 - price per unit
      * ''pax'' : number of persons
      * ''bedrooms'' : number of bedrooms
      * ''m2size'' : square meter 
    * ''attributes'' (array) : room attributes
      * ''type'' : attribute type (bool, int, float, string)
      * ''name'' : attribute name (code)
      * ''value'' : value
      * ''desc'' : description
    * ''pictures'' (array) : a list of room pictures

===== Examples =====

 * Example using units method

<code php>
// filter offers using single filter
$searchParams = array(
  'vnd' => '30.10.2014',       // start date
  'bsd' => '15.11.2014',       // end date
  'epc' => '2',                // number of adults
  'gid' => '71088',            // selected by GIATA ID
);

$units = $soapClient->orsxml_dhotel_api_call( 'units', $searchParams, $header );
</code>

ors-soap-api/public/units.txt · Last modified: 2015/02/27 15:09 by admin