This shows you the differences between two versions of the page.
Next revision | Previous revision Last revision Both sides next revision | ||
ors-soap-api:public:trips [2015/01/24 16:40] 127.0.0.1 external edit |
ors-soap-api:public:trips [2019/07/15 10:00] admin [Return parameters] |
||
---|---|---|---|
Line 15: | Line 15: | ||
<code php> | <code php> | ||
- | public array trips( array $searchData, array $headerData, boolean $cleanUrl = true, $topOffersFilter = array()) | + | public array trips( array $searchData, array $headerData, $topOffersFilter = array(), boolean $cleanUrl = true) |
</code> | </code> | ||
Line 97: | Line 97: | ||
[hsc] => 000f98a576b35158c09a10aaadec4fa0 | [hsc] => 000f98a576b35158c09a10aaadec4fa0 | ||
[ppc] => 192 | [ppc] => 192 | ||
+ | [cppc] => 202 | ||
[alt] => 0 | [alt] => 0 | ||
[top] => 0 | [top] => 0 | ||
Line 182: | Line 183: | ||
( | ( | ||
[AI] => all inclusive | [AI] => all inclusive | ||
- | ) | ||
- | |||
- | ) | ||
- | |||
- | [ppc] => Array | ||
- | ( | ||
- | [selected] => 0 | ||
- | [val] => Array | ||
- | ( | ||
- | [192] => 192 | ||
- | [1015] => 1015 | ||
) | ) | ||
Line 209: | Line 199: | ||
) | ) | ||
+ | [rfilters] => Array | ||
+ | ( | ||
+ | [ppc] => "192-1015" | ||
+ | ) | ||
+ | | ||
[sorts] => Array | [sorts] => Array | ||
( | ( | ||
Line 253: | Line 248: | ||
* ''lon'' : longitude | * ''lon'' : longitude | ||
* ''trips (array)'' : a list of trips | * ''trips (array)'' : a list of trips | ||
- | * ''sub'' : sub category (catalog, earlybird, lastmin, ...) | + | * ''sub'' : sub category (catalog, earlybird, lastmin, ski-pack). For content type ''trips'' you have this special sub values: |
+ | * **trip** : regular bus trip | ||
+ | * **busplane** : combined trip with bus & plane | ||
+ | * **busplaneship** : combined trip with bus, plane and ship | ||
+ | * **cruise** : cruise | trip with ship | ||
+ | * **plane** : trip with plane | ||
+ | * **train** : transport with train | ||
* ''gid'' : accommodation GIATA ID | * ''gid'' : accommodation GIATA ID | ||
* ''toc'' : touroperator code | * ''toc'' : touroperator code | ||
Line 273: | Line 274: | ||
* ''top'' : top trip (1) or a normal trip (0) | * ''top'' : top trip (1) or a normal trip (0) | ||
* ''aid'' , ''iid'' , ''lid'' , ''vid'' , ''zid'' : (for internal use only) | * ''aid'' , ''iid'' , ''lid'' , ''vid'' , ''zid'' : (for internal use only) | ||
- | * ''atx'' : a list of room facilities | + | * ''atx'' : room facilities text |
- | * ''lty'' : location | + | * ''ltx'' : room location text |
- | * ''ztx'' : short room description | + | * ''ztx'' : room detail description |
- | * ''ltx'' : offer description or sometimes what this offer includes bersides a basic service | + | * ''itx'' : included services in room price |
- | * ''ppc'' : lowest price per person for this region | + | * ''ppc'' : price per person |
- | * ''ahc'' : arrival airport (IATA code) | + | * ''cppc'' : catalog price (if cppc is grater then zero, then this is information about catalog price -- without discounts) |
+ | * ''ahc'' : departure airport (IATA code) | ||
+ | * ''zhc'' : arrival airport (IATA code) | ||
* ''sid'' : entry point ID (only for ''trips'' content type) | * ''sid'' : entry point ID (only for ''trips'' content type) | ||
* ''sin'' : entry point name (only for ''trips'' content type) | * ''sin'' : entry point name (only for ''trips'' content type) | ||
Line 285: | Line 288: | ||
* **0** : trip is cancelled | * **0** : trip is cancelled | ||
* **3** : trip is almost guaranteed | * **3** : trip is almost guaranteed | ||
+ | * **4** : trip is finished | ||
* else : trip has no status | * else : trip has no status | ||
* ''url'' : a suggested URL with search parameters for [[check|check method]] | * ''url'' : a suggested URL with search parameters for [[check|check method]] | ||
Line 297: | Line 301: | ||
* ''ahc'' : filters by departure airport (only for ''pauschall'', ''charter'', and ''oneway'' content types | * ''ahc'' : filters by departure airport (only for ''pauschall'', ''charter'', and ''oneway'' content types | ||
* ''alt'' : filters alternative trips | * ''alt'' : filters alternative trips | ||
+ | * ''rfilters (array)'' : range filters | ||
* ''ppc'' : filters by price per person | * ''ppc'' : filters by price per person | ||
* ''sorts (array)'' : possible sorting | * ''sorts (array)'' : possible sorting | ||
Line 393: | Line 398: | ||
$trips = $soapClient->orsxml_hotel_api_call( 'trips', $searchParams, $header ); | $trips = $soapClient->orsxml_hotel_api_call( 'trips', $searchParams, $header ); | ||
+ | </code> | ||
+ | |||
+ | ===== JSON Examples ===== | ||
+ | |||
+ | @see [[ors-soap-api:public:json_api]] how to post request. | ||
+ | |||
+ | <code php> | ||
+ | { | ||
+ | "requestType" : "search", | ||
+ | "action": "trips", | ||
+ | "search": { | ||
+ | "typ": "hotel", | ||
+ | "vnd": "2018-01-10", | ||
+ | "bsd": "2018-03-10", | ||
+ | "tdc": "1-5", | ||
+ | "gid": "15257", | ||
+ | "epc": "2" | ||
+ | }, | ||
+ | "top" : { | ||
+ | "toc" : "FTI" | ||
+ | }, | ||
+ | "header": { | ||
+ | "lang": "[lang]", | ||
+ | "usr" : "[usr]", | ||
+ | "pass": "[pass]", | ||
+ | "agid": "[agid]" | ||
+ | } | ||
+ | } | ||
</code> | </code> |