ORS Documentation

This is an old revision of the document!

---

====== getUnitPricesByParams method ====== Get unit prices. ===== Valid content types ===== * ''hotel'' (at the moment only this content type is supported) ===== Description ===== <code php> public array getUnitPricesByParams( array $searchData, array $headerData) </code> ===== Parameters ===== * ''searchData (array)'' : search parameters. Required serach parameters: ''toc'', (either ''objectId'' or ''unitId'' are also mandatory) * ''headerData (array)'' : in addition to [[soap_header|SOAP Header Information]] , you'll need an export account credentials (''xuser'', ''xpass'') ===== Return Values ===== Returns an availability in selected period <code> Array ( [units] => Array ( [17281] => Array ( [id] => 17281 [unitName] => A2+2 [unitType] => AP [unitView] => pool [ratePlans] => Array ( [0] => Array ( [id] => 26481 [name] => [basicService] => OV [productCode] => 2SI408126481 [priceType] => price_per_unit [prices] => Array ( [0] => Array ( [price] => 156 [additionalServiceTypes] => Array ( [0] => Array ( [serviceType] => HP [serviceDescription] => Half board [price] => 5 ) ) [periods] => Array ( [0] => Array ( [dateFrom] => 2015-07-25 [dateTo] => 2015-08-21 [arrivalDays] => Array ( [monday] => 1 [tuesday] => 1 [wednesday] => 1 [thursday] => 1 [friday] => 1 [saturday] => 1 [sunday] => 1 ) [departureDays] => Array ( [monday] => 1 [tuesday] => 1 [wednesday] => 1 [thursday] => 1 [friday] => 1 [saturday] => 1 [sunday] => 1 ) ) [1] => Array ( [dateFrom] => 2015-02-18 [dateTo] => 2015-02-19 [arrivalDays] => Array ( [monday] => 1 [tuesday] => 1 [wednesday] => 1 [thursday] => 1 [friday] => 0 [saturday] => 0 [sunday] => 1 ) [departureDays] => Array ( [monday] => 1 [tuesday] => 1 [wednesday] => 1 [thursday] => 0 [friday] => 0 [saturday] => 1 [sunday] => 1 ) ) ) ) [1] => Array ( [price] => 140 [periods] => Array ( [0] => Array ( [dateFrom] => 2015-07-11 [dateTo] => 2015-07-24 [arrivalDays] => Array ( [monday] => 1 [tuesday] => 1 [wednesday] => 1 [thursday] => 1 [friday] => 1 [saturday] => 1 [sunday] => 1 ) [departureDays] => Array ( [monday] => 1 [tuesday] => 1 [wednesday] => 1 [thursday] => 1 [friday] => 1 [saturday] => 1 [sunday] => 1 ) ) [1] => Array ( [dateFrom] => 2015-02-18 [dateTo] => 2015-02-19 [arrivalDays] => Array ( [monday] => 1 [tuesday] => 1 [wednesday] => 1 [thursday] => 1 [friday] => 0 [saturday] => 0 [sunday] => 1 ) [departureDays] => Array ( [monday] => 1 [tuesday] => 1 [wednesday] => 1 [thursday] => 0 [friday] => 0 [saturday] => 1 [sunday] => 1 ) ) ) ) [minimumStay] => Array ( [generalMinLength] => 0 [generalMaxLength] => 0 [dates] => Array ( [2015-04-06] => Array ( [minLength] => 3 [arrivalDays] => Array ( [monday] => 1 [tuesday] => 1 [wednesday] => 1 [thursday] => 1 [friday] => 1 [saturday] => 1 [sunday] => 1 ) ) [2015-04-07] => Array ( [minLength] => 3 [arrivalDays] => Array ( [monday] => 1 [tuesday] => 1 [wednesday] => 1 [thursday] => 1 [friday] => 1 [saturday] => 1 [sunday] => 1 ) ) [2015-04-08] => Array ( [minLength] => 3 [arrivalDays] => Array ( [monday] => 1 [tuesday] => 1 [wednesday] => 1 [thursday] => 1 [friday] => 1 [saturday] => 1 [sunday] => 1 ) ) ... [releases] => Array ( [generalReleaseDays] => 400 [dates] => Array ( [2015-02-18] => Array ( [release_days] => 3 [arrivalDays] => Array ( [monday] => 1 [tuesday] => 1 [wednesday] => 1 [thursday] => 1 [friday] => 1 [saturday] => 1 [sunday] => 1 ) ) [2015-02-19] => Array ( [release_days] => 3 [arrivalDays] => Array ( [monday] => 1 [tuesday] => 1 [wednesday] => 1 [thursday] => 1 [friday] => 1 [saturday] => 1 [sunday] => 1 ) ) [2015-02-20] => Array ( [release_days] => 3 [arrivalDays] => Array ( [monday] => 1 [tuesday] => 1 [wednesday] => 1 [thursday] => 1 [friday] => 1 [saturday] => 1 [sunday] => 1 ) ) [2015-02-21] => Array ( [release_days] => 3 [arrivalDays] => Array ( [monday] => 1 [tuesday] => 1 [wednesday] => 1 [thursday] => 1 [friday] => 1 [saturday] => 1 [sunday] => 1 ) ) [2015-02-22] => Array ( [release_days] => 3 [arrivalDays] => Array ( [monday] => 1 [tuesday] => 1 [wednesday] => 1 [thursday] => 1 [friday] => 1 [saturday] => 1 [sunday] => 1 ) ) ) ) ... </code> ===== Return parameters ===== * ''units'' (array) : list of units * ''id'' : unit ID * ''unitName'' : unit name * ''unitType'' : unit type * ''unitView'' : unit view * ''ratePlans'' (array) : rate plans (offers) * ''id'' : rate id * ''name'' : rate name * ''basicService'' : basic service type * ''productCode'' : product code * ''priceType'' : price type (price_per_unit or price_per_person) * ''prices'' (array) : price list * ''price'' : price per day * ''additionalServiceTypes'' (array) : a list of additional service types * ''serviceType'' : service type code * ''serviceDescription : service type description * ''price'' : price per day * ''periods'' : different periods for this price * ''dateFrom'' : date from * ''dateTo'' : date to * ''arrivalDays'' array() : possible arrival days for this period * ''departureDays'' array() : possible departure days for this period * ''minimumStay'' array() : minimum stay information * ''generalMinLength'' : general minimum length (''dates'' overwrite this value) * ''generalMaxLength'' : general maximum length * ''dates'' array() : minimum length for some of the dates * ''minLength'' : minimum length for this date * ''arrivalDays'' array() : minimum length is valid only for this arrival days * ''releases'' array() : release days information * ''generalReleaseDays'' : general release days (''dates'' overwrite this value) * ''dates'' array() : release days for some of the dates * ''release_days'' : release days for this date * ''arrivalDays'' array() : release days is valid only for this arrival days ===== Examples ===== * Example : prices for entire object <code php> $searchParams = array( 'toc' => 'APP', // touroperator code 'objectId' => '4081', // unit id ); $prices = $soapClient->orsxml_hotel_api_call( 'getUnitPricesByParams', $searchParams, $header ); </code> * Example : prices for selected unit <code php> $searchParams = array( 'toc' => 'APP', // touroperator code 'unitId' => '17281', // unit id ); $prices = $soapClient->orsxml_hotel_api_call( 'getUnitPricesByParams', $searchParams, $header ); </code>