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.
====== Quick Search City method ======

<WRAP center round important 90%>
This method is **deprecated**. We will not include this method in the next API version.
</WRAP>

Returns a list of cities by sending ''query'' string. 

Query string is a string that user enters in quick search field.

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

  * ''hotel''
  * ''pauschal''

===== Description =====

<code php>
public array quickSearchCity( string $searchString, array $filter )
</code>

===== Parameters =====

  * ''searchString'' : search string (keywords)
  * ''filter (array)'' : some additional filters to be used in query.
    * ''[typ] (array)'' , a list of content types to search in. I.e. ''array('hotel', 'pauschal')''
    * ''[toc] (array)'' , a list of tour operators
    * ''[lang] (String)'' , return language code

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

Gets a list of cities that matches query string.

<code>
Array
(
    [Novalja / otok Pag] => Array
        (
            [oid] => 12225
            [rgc] => 946
            [hon] => Novalja / otok Pag
            [rgn] => HrvaĹĄka - Otok Pag
            [rggn] => HrvaĹĄka
            [rgcg] => 100023
        )

    [otok Pag] => Array
        (
            [oid] => 2091252342
            [rgc] => 946
            [hon] => otok Pag
            [rgn] => HrvaĹĄka - Otok Pag
            [rggn] => HrvaĹĄka
            [rgcg] => 100023
        )

    [Pag / otok Pag] => Array
        (
            [oid] => 12227
            [rgc] => 946
            [hon] => Pag / otok Pag
            [rgn] => HrvaĹĄka - Otok Pag
            [rggn] => HrvaĹĄka
            [rgcg] => 100023
        )

)
</code>

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


  * ''oid'' : city ID
  * ''hon'' : city name
  * ''rgn'' : region name
  * ''rgcg'' : region group id
  * ''rggn'' : region name

===== Examples =====

  * Example of ''quickSearchCity'' request

<code php>
$key = 'otok pag';
$filter = array(
  'lang' => 'si',
  'toc' => array('PALM','PHPL'),
  'typ'  => array('hotel', 'pauschal')
);

$results = $soapClient->orsxml_quick_search_api_call( 'quickSearchCity', $key, $filter );
</code>
ORS Documentation

User Tools

Site Tools

Page Tools
