Request methods
All webservice requests are simple Http post requests with parameters. Below articles about request commands describe the post request parameters.
Please may refer to request structure article and download Download Sample-Curl-Class.zip for more clear understanding before you start with this chapter.
In general most commands has new parameter named “updatedafter” which provides checkpoint, and let command return only the records had been modified after given time. “updatedafter” parameter has to be provides in “d/m/Y H:i:s” format. For ex. “31/05/2017 15:02:01”.
We tried to choose field names in data results specially to be easily understandable as much as possible. By the time there can be changes about these fields and methods.However most important parameters are explaned in this documentation.
hotelextralist
Retrieves other services and charges for the given hotel by serviceid.
Search parameters
| serviceid | Unique hotel ID |
Returns on success: Array of Objects
| “extraid” | ID of extra |
| “ownerid” | ID of owner (In this query the hotel) |
| “appliesto” | 0 – ALL / 1 – Package / 2 – Ticket Only / 3 – Hotel only |
| “incadult” | Adults (Bed and extrabeds) are applies |
| “incchild” | Children 2. years and bigger applies |
| “incinfant” | Children smaller then 2 years applies (up to 1.99 years) |
| “calculatebyduration” | 0 – Oncee / 1 – Amount * duration of nights |
| “validfrom” | if null ignore, if exists valid from |
| “validuntil” | if null ignore, if defined valid until |
| “optional” | 0 – Obligatory / 1 – By request |
| “asales” | Amount for adults |
| “csales” | Amount for children |
| “isales” | Amount for infants |
| “minage” | if applies to children the minimum age |
| “maxage” | if applies to children the maximum age |
| “smoneyid” | Currency |
| “marketname” | Marketname |
| “method” | 0 – Cash / 1 – Applies by the percentage to accomodation price of passenger (acc. price/Amount%) |
| “chbegin” | Pair with “chend”. if null ignore // if defined checkin date between |
| “chend” | |
| “accbegin” | Pair with “accend”. if null ignore // if defined any of the accomodation date between |
| “accend” | |
| “updated” | Datetime record has been updated |
tour_servicetextpricelist
Retrieves the Text/HTML pricelist related to a tour program for accommodation facility.
Request parameters
| serviceid | Unique system ID (obligatory) |
| packageid | Unique system ID |
servicetourprogramsweb
Returns the list of available uploaded tour programs with download url for the hotel.
| serviceid | Unique system ID |
leisureupdatelistwithdeparture
Provides list of the actual status leisure packages and departures.
| updatedafter | format such as “30/09/2024 14 | 35” |
updated after parameter provides a checkpoint for the changes, so you may not have to download all prices and status each time.
packagepricelist
Bulk json datalist of hotel package prices from all programs.
| serviceid | Hotel system ID |
Returns on success
Array of Objects
| id | 153 characters long string seperated by “|” character. 1stpriceID – 2nd extrabedpriceID – 3rd childpriceID |
| packagename | Name of package |
| packageid | ID of tour package |
| bed | number of beds |
| ext | number of extra beds |
| chd | number of children |
| inf | number of of infants |
| minpayment | minimum prepayment required (%) |
| expires | expire date |
| bedpricesfinal | Price for adults paying bed |
| extpricesfinal | Price for adult paying extra bed |
| prices[x]final | “X” can be 1-4. Price for children if exists |
| min[x]-max[x] | Range for the age of children by order |
| roomid | Unique ID for room type |
| roomname | Room name |
| mealid | Unique ID for meal type |
| mealname | Meal name |
| updated | last updated date |
| packagegroupid | Unique ID of package group definition |
| packagegroupname | Package group name |
| departureid | Unique id of departure |
| departuradate | Tour start date |
| checkin | Date of entering hotel |
| checkout | Date of leaving hotel |
| returndate | Start of the return travel |
| hotelduration | Number of nights in program |
| tourduration | Basic definition for number of nights between departure date and return date |
| roompriority | Order priority of room |
exchangelist
Returns the current exchange rates in system.
Currency and sales rate are the returning values.
hoteldefinitionlist
Returns hotel additional definitions.
Search parameters
| serviceid | Unique hotel ID |
| definitiontypeid | Main categoryid (HFA,RAC,SFA,ENT,CFA,BAC,MEL,OPE,CAT) |
Returns on success: Array of Objects
| id | Unique ID of definition |
| name | Name of definition |
| varitem | This definition is part of hotel |
| definitiontypeid | Main category of definition |
hoteldiscountlist
Retrieves the periodic discounts as early booking and special offers. This query returns only currently valid discounts.
Search parameters
| serviceid | Unique hotel ID |
Returns on success: Array of Objects
| id | Unique ID of the record |
| marketname | Marketname which discount belongs to |
| resbegin | Begin date of reservation filter (default null) |
| resend | End date of reservation filter (default null) |
| accbegin | Accommodation filter begin (default null) |
| accend | Accommodation filter end date (default null) |
| chbegin | Check filter start date (default null) |
| chend | Check/In filter end date (default null) |
| preventcumulative | If it is 1 or true than this discount available only alone. |
| Actiontype | By contract or it is a special offer. (SPO has priority) |
| Salestype | 0 – Percent / 1 – Cash |
| Salesamount | Amount of discount by given type |
| salesminpayment | Percentage of the minimum payment |
| mindate | Duration filter minimum date (default 0) |
| maxdate | Duration filter maximum date (default 365) |
| servicename | Name of the hotel |
| roomname | Roomname filter (default empty means all) |
servicepricelistdata
Retrieves the accommodation contract prices currently valid for a hotel.
Request parameters
| serviceid | Unique system ID (id from “servicelist” query – obligatory) |
Returns on success
Array of Objects
| servicename | Hotel/Facility name |
| cityname | Name of city hotel located |
| countryname | Name of country hotel located |
| regionname | Name of region hotel located |
| servicetypename | Category of hotel |
| generaltypename | Classification of hotel |
| serviceid | Unique system ID for hotel |
| marketid | Unique market ID for prices |
| roomid | Unique room type ID |
| roomname | Type of room |
| mealid | Unique meal type ID |
| mealname | Name of meal service |
| periodid | Unique ID for period |
| bdate | Period start date |
| edate | Period end date |
| checkin | 0 / 1 if period if C/IN based |
| mindate | Minimum duration of accommodation |
| maxdate | Maximum duration of accommodation |
| type | 0 / 1 If period is an SPO |
| validuntil | Prices valid until – null if not applied |
| validafter | Prices valid after – null if not applied |
| releasebefore | Duration before release – null if not applied |
| moneyid | Currecy of prices |
| header | Constructed label description for the price (such as 2 PAX + 1 EXT and similar) |
| childsign | Constructed label for included children |
| roomprice | Total room price by the capacity except infants |
| bed | Number of beds |
| ext | Number of extra beds |
| chd | Number of children (max 4) |
| inf | Number of infants allowed |
| chd1age | 1st children age min-max |
| chd2age | 2nd children age min-max |
| chd3age | 3rd children age min-max |
| chd4age | 4th children age min-max |
| bedprice | Price for each bed |
| extprice | Price for each extra bed |
| chd1price | Price for 1st child |
| chd2price | Price for 2nd child |
| chd3price | Price for 3rd child |
| chd4price | Price for 4th child |
| infprice | Price for each infant (Generally allowed only 1) |
textlist
Retrieves the text information about an item in system.
Request parameters
| id | Unique system ID |
| ownerid | ID of the text collection owner. (obligatory) |
Returns on success:
Array of Objects
| id | Unique system ID |
| grouppriority | Group priority order |
| groupname | Main group label |
| subheader | Text sub header |
| html | Html content |
filelist
Retrieves the list of files/documents with URL addresses for given ownerid parameter. This function documents such as factsheets.
Request parameters
| id | Unique system ID |
| ownerid | ID of the file collection owner. (obligatory) |
Returns on success:
Array of Objects
| id | Unique system ID |
| size | Size of file in bytes |
| name | Visual label name |
| name original | Original name of file uploaded |
| url | Url of file for download |
imagelist
Retrieves the list of images with URL address for given ownerid (required) parameter.
Request parameters
| id | Unique system ID |
| ownerid | ID of the image collection owner. (obligatory) |
Returns on success:
Array of Objects
| id | Unique system ID |
| url | URL of image for download |
| priority | Priority order of image ascending. |
servicelist
Retrieves the list of hotels in system with all information. If you are using this query as a checklist for prices you may consider to send a request with packageupdatelog or hotelupdatelog parameter which add fields with DateTime marker when last time prices have been updated to avoid unnecessary imports.
Request parameters
| id | Unique system ID |
| cityid | City system ID |
| cityname | Country system ID |
| countryid | Country system ID |
| name | Hotel name |
| namelike | Hotel name like |
| packagepricelastupdated | Adds a datetime field named as “packageupdated” which shows the last time when package prices are updated. |
| priceupdatedafter | Adds a datetime field named as “hotelupdated” which shows the last time when accommodation prices are updated. |
Returns on success:
Array of Objects
| id | Unique system ID |
| name | Name of Hotel |
| servicetypeid | Unique system ID of hotel category definition |
| servicetypename | Hotel category name such as 3*,4*,5* etc. |
| generaltypeid | Unique system ID of hotel classification |
| generaltypename | Hotel classification such as Hotel, Resort, Resort & Spa etc. |
| cityid | City system ID |
| cityname | Name of city |
| countryid | Country system ID |
| countryname | Name of country |
| regionid | Unique system ID for disrict |
| regionname | District name |
| mapx | Google map latitude |
| mapy | Google map attitude |
| youtube | Link for Youtube video |
| talocationid | Trip advisor object ID |
| wpstatus | Shows hotel is currency active or not. (integer 0/1) |
regionlist
Retrieves the list of districts in cities
Request parameters
| id | Unique system ID |
| cityid | Country system ID |
| cityname | Country system ID |
| countryid | Country system ID |
| name | City name |
| namelike | City name like |
Returns on success
Array of Objects
| id | Unique system ID |
| name | Name of city |
| cityid | City system ID |
| cityname | Name of the city |
| countryid | Country system ID |
| countryname | Name of the country |
| mapx | Google map latitude |
| mapy | Google map attitude |
| talocationid | Trip advisor location ID |
citylist
Retrieves the list of cities in system.
Request parameters
| id | Unique system ID |
| countryid | Country system ID |
| name | City name |
| namelike | City name like |
Returns on success
Array of Objects
| id | Unique system ID |
| name | Name of city |
| countryid | Country system ID |
| countryname | Name of the country |
| mapx | Google map latitude |
| mapy | Google map attitude |
| talocationid | Trip advisor location ID |
countrylist
Retrieves the list of countries in system.
Returns on success: Array of Objects
| id | Unique system ID |
| name | Name of country |
| mapx | Google map latitude |
| mapy | Google map attitude |
| talocationid | Tripadvisor location ID |
Request parameters
| id | Unique system ID |
| name | Country name |
| namelike | Country name like |
userdata
This command retrieves the current user information unless the credentials are correctly supplied. Generally, user may use this command as a login at startup and retrieve session information to use in further requests. “userdata” is a special command which uses only constant system parameters.
Returns on success:
Object
| id | Unique userid |
| clientid | Unique clientid (Sub-agentID) |
| name | Name |
| surname | Surname |
| Users notification email address. | |
| accounttype | Type of account E – Employee / F – Firma / C – Client |
| debitcredit | 0 – Debtor / 1 – Creditor |
| marketid | User’s specified marketid. |
| remoteip | Request IP address. |
| sessionid | Unique sessionID for the connection |