User Tools

Site Tools


ors-soap-api:public:getobjects

This is an old revision of the document!


getObjects method

Get a list of touroperator objects.

Valid content types

  • hotel (at the moment only this content type is supported)

Description

public array getObjects( array $searchData, array $headerData)

Parameters

  • searchData (array) : search parameters. Required serach parameters: toc. Non mandatory parameters: objectId
  • headerData (array) : in addition to SOAP Header Information , you'll need an export account credentials (xuser, xpass' ') ===== Return Values ===== Returns a list of available objects. Here is an example of output: <code> array ( [objects] ⇒ Array ( [0] ⇒ Array ( [id] ⇒ 4081 [objectName] ⇒ Apartmaji Vila Maia [objectPlace] ⇒ Strunjan [objectCountryIso] ⇒ SI ) [1] ⇒ Array ( [id] ⇒ 5471 [objectName] ⇒ Vile Terme Zreče [objectPlace] ⇒ Zreče [objectCountryIso] ⇒ SI ) [2] ⇒ Array ( [id] ⇒ 7871 [objectName] ⇒ Villa Piranesi [objectPlace] ⇒ Piran [objectCountryIso] ⇒ SI ) … </code> ===== Return parameters ===== * objects (array) : list of objects * id : object ID * objectName : object name * objectPlace : object place * objectCountryIso'' : object country ISO code

Examples

  • Example with basic search parameters with selected region group ID
$searchParams = array(
  'toc' => 'APP',       // touroperator code
);
 
$objects = $soapClient->orsxml_hotel_api_call( 'getObjects', $searchParams, $header );
  • Example : search object by id
$searchParams = array(
  'toc' => 'APP',       // touroperator code
  'objectId' => '4081', // object id
);
 
$objects = $soapClient->orsxml_hotel_api_call( 'getObjects', $searchParams, $header );
ors-soap-api/public/getobjects.1424287709.txt.gz · Last modified: 2015/02/18 20:28 by admin