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.
====== SOAP Header Information ======

Almost all SOAP calls require ''$header array''. Here you enter your licence information, default language code and session id.

**Parameters:**

  * ''lang'' : a return language that API returns. If you leave blank than a default language set on your ORS account is used.
  * ''usr'' : ORS account username
  * ''pass'' : ORS account password
  * ''agid'' : ORS account ID
  * ''ibeid'' : partner ID (affiliate)
  * ''sid'' : session ID. This __ID must be unique__ for each user on your page because it is used for filtering and sorting of returned results
  * ''limits'' : to set maximum number of search results per page. Use 'p' for limit offers and 't' to limit trips (see example to understand the usage)
    * **Maximum limit** for offers ... there is no limit (default: 1000 per page) ... 0=all found objects
    * **Maximum limit** for trips is 10000 results per page (default: 1000)   ... 0=100000
  * ''xuser'' : user id for data export credentials
  * ''xpass'' : user password for data export credentials

===== Usage: =====

Here is an example for setting ''$header'' array with [[demo_licence|demo licence]] information.
<code php>
// ORSXML header information
$header = array(
    'lang'  => 'en',            // a return language
    'usr'   => 'xmldemo102',    // ORSXML user
    'pass'  => 'orsdemogh1',    // ORSXML password
    'agid'  => '5780',          // agency ID (or account id)
    'sid'   => session_id(),    // this is required so that filtering and sorting works correctly!
    'limits' => 'p:6,t:50',     // set limits (6 offers per page and 50 trips per page)
);
</code>

===== Using API-KEY: =====

If you have received apikey for your API licence, then you need to put api-key attribute in header array:

<code php>
// ORSXML header information (using api-key
$header = array(
    'lang'  => 'en',            // a return language
    'api-key'=> 'your-apikey-here' 
    'usr'   => '',              // no longer needed
    'pass'  => '',              // no longer needed
    'agid'  => '',              // no longer needed
    'sid'   => session_id(),    // this is required so that filtering and sorting works correctly!
    'limits' => 'p:6,t:50',     // set limits (6 offers per page and 50 trips per page)
);
</code>
ORS Documentation

User Tools

Site Tools

Page Tools
