This is an old revision of the document!

Trips method

Get a list of trips (periods)

Valid content types

pauschal
hotel
trips
charter
oneway
(extras is not supported!)

Description

public array trips( array $searchData, array $headerData, $topOffersFilter = array(), boolean $cleanUrl = true)

Parameters

searchData (array) : search parameters. Required serach parameters: vnd, bsd, epc, tdc, gid
headerData (array) : SOAP Header Information
cleanUrl (bool) : TRUE returns clean friendly URLs.
topOffersFilter (array) : top offers filter. Results that match this filter will be listed at the beginning of trips list

Example $topOffersFilter:

array(
    'toc' => 'PALM',    // touroperator PALM      
)

Return Values

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

Return parameters

header (array) : information about a selected region and paging information
- typ : content type
- offers : number of offers found
- pages : number of pages
- perpage : records per page
- offset : current page (first page have offset 0, second page have offset 1, …)
- sid : session id used
- rgc : selected region code (ID)
- rgn : selected region name
- rgg : selected region group code (ID)
- rggn : selected region group name
offer (array) : an offer information
- pic : full picture
- gid : GIATA ID
- htn : accommodation name
- stc : hotel category
- ovr : overall rating
- hon : city name
- oid : city ID
- fcts : all available facts
- dtemp : air temparature
- wtemp : water temperature
- 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
trips (array) : a list of trips
- 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
- toc : touroperator code
- ton : touroperator name
- tocpic : touroperator logo
- zac : room type code
- zan : room type name
- vpc : service type code
- vpn : service type name
- htc : hotel code (or product code)
- svc : service code
- vnd : checkin date
- bsd : checkout date
- tdc : duration
- md5p : unique hash for this offer (for internal use only)
- md5t : unique hash for this trip (for internal use only)
- hsc : unique hash for this trip
- alt : alternative 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)
- atx : room facilities text
- ltx : room location text
- ztx : room detail description
- itx : included services in room price
- ppc : price per person
- 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)
- sin : entry point name (only for trips content type)
- status : trip status (only for trips content type)
  - 1 : trip is guaranteed
  - 0 : trip is cancelled
  - 3 : trip is almost guaranteed
  - 4 : trip is finished
  - else : trip has no status
- url : a suggested URL with search parameters for check method
filters (array) : all possible filters
- toc (array) : filters by touroperators
  - selected : (0) if this filter is not selected, (1) if this filter is selected
  - val (array) : a list of values you can use for this filter
- vnd : filters by checkin date
- tdc : filters by duration period
- zac : filters by room types
- vpc : filters by service types
- ahc : filters by departure airport (only for pauschall, charter, and oneway content types
- alt : filters alternative trips
- ppc : filters by price per person
sorts (array) : possible sorting
- toc : sort by touroperator name
- vnd : sort by checkin date
- tdc : sort by duration
- zac : sort by room type
- vpc : sort by service type
- ppc : sort by price (default sorting)

Examples

Example with basic search parameters with selected hotel (GIATA ID)

$searchParams = array(
  'vnd' => '30.10.2014',       // start date
  'bsd' => '15.11.2014',       // end date
  'tdc' => '1-4',              // duration [min-max] days
  'epc' => '2',                // number of adults
  'gid' => '71088',            // selected hotel by GIATA ID
);
 
$trips = $soapClient->orsxml_hotel_api_call( 'trips', $searchParams, $header );

Example using filters

// filter offers using single filter
$searchParams = array(
  'vnd' => '30.10.2014',       // start date
  'bsd' => '15.11.2014',       // end date
  'tdc' => '1-4',              // duration [min-max] days
  'epc' => '2',                // number of adults
  'gid' => '71088',            // selected hotel by GIATA ID
  'filter' => array(
      'tdc' => '2'             // filter by duration (display only trips with duration 2 nigths)
   )
);
 
$trips = $soapClient->orsxml_hotel_api_call( 'trips', $searchParams, $header );
 
// filter offers using more then one filters
$searchParams = array(
  'vnd' => '30.10.2014',       // start date
  'bsd' => '15.11.2014',       // end date
  'tdc' => '1-4',              // duration [min-max] days
  'epc' => '2',                // number of adults
  'gid' => '71088',            // selected hotel by GIATA ID
  'filter' => array(
      'tdc' => '2',            // filter by duration (display only trips with duration 2 nigths)
      'vnd' => '20140903'      // filter by checkin date (display only trips that starts on 3rd Sep. 2014)
   )
);
 
$trips = $soapClient->orsxml_hotel_api_call( 'trips', $searchParams, $header );

Example using sorting

// filter offers using single filter
$searchParams = array(
  'vnd' => '30.10.2014',       // start date
  'bsd' => '15.11.2014',       // end date
  'tdc' => '1-4',              // duration [min-max] days
  'epc' => '2',                // number of adults
  'gid' => '71088',            // selected hotel by GIATA ID
  'sort' => 'vnd|asc'          // sort by checkin date in ascending order
);
 
$trips = $soapClient->orsxml_hotel_api_call( 'trips', $searchParams, $header );
 
// filter offers using more then one filters
$searchParams = array(
  'vnd' => '30.10.2014',       // start date
  'bsd' => '15.11.2014',       // end date
  'tdc' => '1-4',              // duration [min-max] days
  'epc' => '2',                // number of adults
  'gid' => '71088',            // selected hotel by GIATA ID
  'sort' => 'ppc|desc'         // sort by price in descending order
);
 
$trips = $soapClient->orsxml_hotel_api_call( 'trips', $searchParams, $header );

Example using paging

// filter offers using single filter
$searchParams = array(
  'vnd' => '30.10.2014',       // start date
  'bsd' => '15.11.2014',       // end date
  'tdc' => '1-4',              // duration [min-max] days
  'epc' => '2',                // number of adults
  'gid' => '71088',            // selected hotel by GIATA ID
  'toffset' => '3'             // display 4th page (toffset 0 returns 1st page)
);
 
$trips = $soapClient->orsxml_hotel_api_call( 'trips', $searchParams, $header );

JSON Examples

@see ORS JSON API how to post request.

{
  "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]"
  }
}

ORS Documentation

Sidebar

Table of Contents

Trips method

Valid content types

Description

Parameters

Return Values

Return parameters

Examples

JSON Examples

ORS Documentation

User Tools

Site Tools

Sidebar

Table of Contents

Trips method

Valid content types

Description

Parameters

Return Values

Return parameters

Examples

JSON Examples

Page Tools