User Tools

Site Tools


ors-soap-api:public:getpricecheckhash

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

ors-soap-api:public:getpricecheckhash [2015/02/21 20:08]
admin created
ors-soap-api:public:getpricecheckhash [2015/02/21 20:10] (current)
admin
Line 1: Line 1:
-====== ​getObjects ​method ======+====== ​getPriceCheckHash ​method ======
  
-Get a list of touroperator objects.+Get hash code for price check method. Because price check method requires unique hash code to perform availability check, you must execute this method first to get correct hash code
  
-===== Valid content types =====+Depending on different connections,​ a different input parameters are needed. Usually unitId, rateId, dateFrom and dateTo are all that is needed. In some cases also serviceType parameter is needed. Please contact us if you have any problems with this API method.
  
 +===== Valid content types =====
  
   * ''​hotel''​ (at the moment only this content type is supported)   * ''​hotel''​ (at the moment only this content type is supported)
Line 11: Line 12:
  
 <code php> <code php>
-public string ​getObjects( array $searchData,​ array $headerData)+public string ​getPriceCheckHash( array $searchData,​ array $headerData)
 </​code>​ </​code>​
  
 ===== Parameters ===== ===== Parameters =====
  
-  * ''​searchData (array)''​ : search parameters. Required serach parameters: ''​toc''​. Non mandatory parameters: ''​objectId''​+  * ''​searchData (array)''​ : search parameters. Required serach parameters: ''​toc'',​ ''​unitId'',​ ''​rateId'',​ ''​dateFrom'',​ ''​dateTo''​. Non mandatory parameters: ''​serviceType''​
   * ''​headerData (array)''​ : in addition to [[soap_header|SOAP Header Information]] , you'll need an export account credentials (''​xuser'',​ ''​xpass''​)   * ''​headerData (array)''​ : in addition to [[soap_header|SOAP Header Information]] , you'll need an export account credentials (''​xuser'',​ ''​xpass''​)
  
 ===== Return Values ===== ===== Return Values =====
  
-Returns a list of available objects. Here is an example of output ​(string is always returned):+Returns a hash code for availability check method. Here is an example of output:
  
 <​code>​ <​code>​
 4081:​17281:​2SI408126481:​26481:​OV:​2015-08-01:​2015-07-08 4081:​17281:​2SI408126481:​26481:​OV:​2015-08-01:​2015-07-08
 </​code>​ </​code>​
- +   
 ===== Examples ===== ===== Examples =====
  
   * Example 1   * Example 1
 +
 <code php> <code php>
 $searchParams = array( $searchParams = array(
Line 44: Line 45:
  
   * Example 2 : with serviceType   * Example 2 : with serviceType
 +
 <code php> <code php>
 $searchParams = array( $searchParams = array(
Line 56: Line 58:
 $hash = $soapClient->​orsxml_hotel_api_call( '​getPriceCheckHash',​ $searchParams,​ $header ); $hash = $soapClient->​orsxml_hotel_api_call( '​getPriceCheckHash',​ $searchParams,​ $header );
 </​code>​ </​code>​
 +
  
   ​   ​
ors-soap-api/public/getpricecheckhash.txt · Last modified: 2015/02/21 20:10 by admin