Version 1.2
About
Adriatic.hr XML Service is a web service [
?] based on XML format [
?], which allows communication between yours and Adriatic.hr web site. Thanks to it, visitors of your web site can search, preview and place order for any service in our offering, without leaving your web site.
It can be used by calling the access URL -
https://api.adriatic.hr/xml-service/server. Actually, this URL is only an endpoint and you need to provide some additional information in the form of GET/POST parameters. Every call to the specified URL should be accompanied with at least two special parameters - method name and application ID - but actual number of parameters depends of method. Here is the list of all special parameters:
- method - web service (method) name (required)
- aid - application ID (AID); this is your unique ID information which will be generated for you after opting for our web services (required)
- lang - two-letter language code (according to ISO 639-1 standard) in lowercase, used to localize results (if needed, only some of data is language dependent). (not required, defaults to "en" - english)
-
sig - request signature, composed of the called method name, application ID and private key hash. (required)
- signature generation (pseudo code):
md5(<method>;<your AID>;md5(<your private key>))
- signature generation in PHP:
md5($method.';'.$aid.';'.md5($privateKey))
-
example:
https://api.adriatic.hr/xml-service/server
?method=Private_getHouse&id=1005&lang=en
&aid=af151&sig=6f0dcac4960e0eab40c4bdc1d42b6c03
Methods of our web service are divided into the following groups (namespaces):
- Private accommodation - namespace Private
- Geography locations - namespace Geo
- Ordering process - namespace Order
- System/helper/common - namespace System
Examples are using testing AID, you should change it to your own before calling XML Service from your application.
Usage
The following example retrieves data of private accommodation house with ID 1005. Click on preview link to see the service result.
https://api.adriatic.hr/xml-service/server
?method=Private_getHouse
&id=1005
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Each parameter is specified inside URL as name=value pair.
The method parameter specifies service method to be invoked. All subsequent
parameters are parameters passed to specified method. Some method parameters are optional
while others are required to be set - faling to specifiy the required parameter will
result in error.
Methods
Here is the list of supported service methods. Request parameters written in bold are required.
Many response elements contain special boolean attribute na.
It stands for "not available" and means that element value is unknown (null).
This attribute exist only for elements which value can be unknown.
Possible response statuses are success
and failure
.
Search private accommodation. Method is pagination aware (results are split across multiple pages).
Request parameters
i_from | date | Beginning of interval. Allowed format is YYYY-MM-DD. |
---|
i_to | date | End of interval. Allowed format is YYYY-MM-DD. |
---|
i_dev | bool | Allow slight shifting of given date interval to find more accommodation units. Default value is TRUE . |
---|
t | type | Comma delimited list of accommodation unit types. Example: "apartment,room". Supported types are:house apartment studio-apartment room
|
---|
id | int | Comma delimited list of house IDs. Example: "1005,1006". Use case example - if you want to get a price range of desired house(s). |
---|
id_ref | int | Referent house ID, used for distance sort type. |
---|
coord_lat | float | Referent latitude coordinate, used for distance sort type. |
---|
coord_lng | float | Referent longitude coordinate, used for distance sort type. |
---|
kit_room | bool | Use of kitchen for units of type room. |
---|
p | int | Number of persons. |
---|
p_dist | bool | Allow to split persons in more than one accommodation unit inside the house. Default value is FALSE . |
---|
cat | type | House category. Supported types are:luxury pool house pension family_owned_hotel family_friendly beach quiet robinson Supports multiple values separated by ',' (AND operator) or '|' (OR operator). |
---|
prc_min | float | Minimal price in EUR (per day). Default value is 0 . |
---|
prc_max | float | Maximal price in EUR (per day). |
---|
prc_low | bool | Low-price accommodation. |
---|
b_b | bool | Best buy accommodation. |
---|
dc_t | type | Discount type. Supported types are:all_discounts special special_term last_minute
|
---|
q | string | Keywords for textual search (geography location names only). |
---|
l | string | Geography location ID. |
---|
ri_t | type | Riviera type. Supported types are:mainland_not_sea_coast mainland_sea_coast island islands island_bridge Supports multiple values separated by '|' (OR operator). |
---|
land | type | Land type. Supported types are:mainland island_bridge island Supports multiple values separated by '|' (OR operator). |
---|
pl_t | type | Place type. Supported types are:large_city tourist_city small_city cove Supports multiple values separated by '|' (OR operator). |
---|
be_t | type | Beach type. Supported types are: Supports multiple values separated by '|' (OR operator). |
---|
be_d | int | Maximal house to beach distance. |
---|
isolation | bool | House is located in isolation. |
---|
pool | bool | House with pool. |
---|
ac | bool | Accommodation unit with air conditioner. |
---|
stv | bool | Accommodation unit with satellite TV. |
---|
food | bool | House with food service. |
---|
pet | bool | House with pet approval. |
---|
boat | bool | House with boat rent service. |
---|
moor | bool | House with boat moor. |
---|
outer_view_sea | bool | House with sea view. |
---|
outer_grill | bool | House with outer grill. |
---|
inet | bool | House with internet. |
---|
bedrooms | int | Number of bedrooms. It can be used in combination with p_dist param. |
---|
parking | bool | House with parking. |
---|
ob | bool | Online booking - Book the apartment right away! Adriatic.hr guarantees the availability of facilities in this program. |
---|
sort | type | Sort criterion. Supported types are:standard price beach - Distance from the beach.grade - Guest grade average.distance - Houses that have straight line distance from the referent house (defined by the id_ref parameter) shorter than 1000m. If the referent house does not have GPS coordinates defined, result set is empty. Default value is standard . |
---|
sort_dir | type | Sort direction. Supported types are:asc - Ascendingdesc - Descending Default value is asc . |
---|
page | int | Page number. Default value is 1 . |
---|
limit | int | Number of results per page (max. 25). Default value is 10 . |
---|
Response
<list> - List data |
---|
items | array | Items on current page. Array of <item> elements. See <item> (List item data) for details. |
---|
pager | set | Set of pager elements. See <pager> (List pager data) for details. |
---|
<item> - List item data |
---|
house | set | Found house. See <house> (House data) for details. Element has the following attributes:
|
---|
units | array | Accommodation units which belongs to house from the same <item> element. Only units that match search criteria are enlisted here. Array of <unit> elements. See <unit> (Accommodation unit data) for details. |
---|
<pager> - List pager data |
---|
totalItems | int | Total items that match search criteria. |
---|
totalPages | int | Total pages. |
---|
currentPage | int | Current page. |
---|
pageLimit | int | Maximum number of items per page. |
---|
<house> - House data |
---|
self | n/a | Element has no value. Element has the following attributes:
|
---|
name | string | House name. |
---|
capacity | int | Number of beds. |
---|
food | bool | Food service available? |
---|
lastIntervalCheck | datetime | Time when availability intervals are last updated. Date-time string in YYYY-MM-DD hh:mm:ss format (ISO 8601). Time zone is Croatian - GMT+1 (+DST). |
---|
onlineBooking | bool | Book the apartment right away! Adriatic.hr guarantees the availability of facilities in this program. |
---|
bestBuy | bool | Best buy guarantee (best ratio quality and price). |
---|
units | array | References to all accommodation units which belongs to this house (not necessary match search criteria). Array of <unit> elements. See <unit> (Accommodation unit reference data) for details. |
---|
geo | set | Geography location. See <geo> (Geography location data) for details. |
---|
distance | set | Distances. See <distance> (Distance data) for details. |
---|
categories | array | Categories which house belongs to. Array of <category> elements. See <category> (House category data) for details. |
---|
discounts | array | Discounts and additional payments. Some types of discounts are related to accommodation unit (see Private_getUnit response), whilst others are related to the whole house. Discounts related to the whole house are applicable on every associated accommodation unit. Array of <discount> elements. See <discount> (Discount/additional payment data) for details. |
---|
relate | set | Related houses. See <relate> (Related objects) for details. |
---|
rating | set | Ratings. See <rating> (Ratings (1-5)) for details. |
---|
image | array | Image of house. Array of <variant> elements. See <variant> (Image variant data) for details. |
---|
<unit> - Accommodation unit data |
---|
self | n/a | Element has no value. Element has the following attributes:
- id [
int ]: Accommodation unit ID.
|
---|
name | string | Name. |
---|
lastIntervalCheck | datetime | Time when availability intervals are last updated. Date-time string in YYYY-MM-DD hh:mm:ss format (ISO 8601). Time zone is Croatian - GMT+1 (+DST). |
---|
type | type | Type. Supported types are:house apartment studio-apartment room
|
---|
label | string | Accommodation unit character label. Used to distinguish multiple accommodation units with a same type, within the same house. |
---|
capacity | set | Capacity data. See <capacity> (Capacity data) for details. |
---|
class | set | Classification data. See <class> (Accommodation unit classification data) for details. |
---|
priceRange | array | Accommodation unit price range (discounts are applied if available). Contains two amounts (range), single amount (exact price is known) or no amounts (price is unknown). Value depends on search parameters used (date interval and number of persons). Array of <amount> elements. See <amount> (Price amount (per day).) for details. |
---|
regularPriceRange | array | Accommodation unit price range without discounts. Contains two amounts (range), single amount (exact price is known) or no amounts (price is unknown). Value depends on search parameters used (date interval and number of persons). Array of <amount> elements. See <amount> (Price amount (per day).) for details. |
---|
discounts | array | Discounts and additional payments. Some types of discounts are related to accommodation unit, whilst others are related to the whole house. Discounts related to the whole house are applicable on every associated accommodation unit. Array of <discount> elements. See <discount> (Discount/additional payment data) for details. |
---|
lowPrice | bool | Accommodation unit has a low price? |
---|
image | array | Image of house. Array of <variant> elements. See <variant> (Image variant data) for details. |
---|
<unit> - Accommodation unit reference data |
---|
self | string | Accommodation unit name. Element has the following attributes:
- id [
int ]: Accommodation unit ID. - type [
type ]: Accommodation unit type. - label [
string ]: Accommodation unit character label. Used to distinguish multiple accommodation units with a same type, within the same house. - capacityBasic [
int ]: Basic capacity of the accommodation unit. - capacityAdditional [
int ]: Additional capacity of the accommodation unit.
|
---|
<geo> - Geography location data |
---|
region | string | Region name. Element has the following attributes:
|
---|
riviera | string | Riviera name. Element has the following attributes:
|
---|
place | string | Place name. Element has the following attributes:
- id [
string ]: Place ID. - isletName [
string ]: Islet name, if set, the place is located on a islet.
|
---|
beach | null | Beach placeholder - beaches does not have names, only IDs. Element has the following attributes:
|
---|
<distance> - Distance data |
---|
beach | int | Distance from beach (meters). |
---|
house | int | Distance from the referent house (meters) - available if sort type is "distance" and id_ref parameter is provided. |
---|
currentLocation | int | Distance from the referent coordinates (meters) - available if coord_lat, coord_lng parameters are provided. Default sort type is "distance". If object is closer than 1000 m method returns 1000 m |
---|
<category> - House category data |
---|
self | type | House category. Supported types are:luxury pool house pension family_owned_hotel family_friendly beach quiet robinson
|
---|
<discount> - Discount/additional payment data |
---|
type | type | Discount type. Supported types are:special extra_day first_minute valentine special_term easter last_minute highlighted
|
---|
name | string | Name. |
---|
validity | set | Booking date time limitation in which a discount is valid. See <validity> (Discount booking time limitation) for details. |
---|
termValidity | set | Order stay term date time limitation in which a discount is valid. See <termValidity> (Discount order stay term time limitation) for details. |
---|
value | set | Percent, money or freeDays value. See <value> (Discount/additional payment value) for details. |
---|
<validity> - Discount booking time limitation Booking date time limitations in which a discount is valid. |
---|
from | datetime | Booking date from which a discount is valid. Date-time string in YYYY-MM-DD hh:mm:ss format (ISO 8601). Time zone is Croatian - GMT+1 (+DST). |
---|
to | datetime | Booking date from which a discount is invalid. Date-time string in YYYY-MM-DD hh:mm:ss format (ISO 8601). Time zone is Croatian - GMT+1 (+DST). |
---|
<termValidity> - Discount order stay term time limitation Order stay term date time limitations in which a discount is valid. |
---|
from | datetime | Order stay date from which a discount is valid. Date-time string in YYYY-MM-DD hh:mm:ss format (ISO 8601). Time zone is Croatian - GMT+1 (+DST). |
---|
to | datetime | Order stay date from which a discount is invalid. Date-time string in YYYY-MM-DD hh:mm:ss format (ISO 8601). Time zone is Croatian - GMT+1 (+DST). |
---|
<relate> - Related objects |
---|
exist | bool | Is object related with any other object? |
---|
houses | array | Other houses that are related to this house. Array of <house> elements. See <house> (Related House element) for details. |
---|
<variant> - Image variant data Image variants are versions of the same image, differentiated by size, listed if exist. |
---|
self | n/a | Element has no value. Element has the following attributes:
- type [
type ]: Image variant type (size class). Supported types are:l - large (max. 365px, horizontal or vertical)s - small (115x86px)m - medium (200x133px)max4000x2667 - jumbo (max. height 4000px)
|
---|
url | string | Image variant URL. |
---|
<rating> - Ratings (1-5) |
---|
place | int | Average place rating. Element has the following attributes:
- ratings [
int ]: Number of ratings.
|
---|
beach | int | Average beach rating. Element has the following attributes:
- ratings [
int ]: Number of ratings.
|
---|
accomodation | int | Average accomodation rating. Element has the following attributes:
- ratings [
int ]: Number of ratings.
|
---|
host | int | Average host rating. Element has the following attributes:
- ratings [
int ]: Number of ratings.
|
---|
total | int | Total average rating. Element has the following attributes:
- ratings [
int ]: Number of ratings.
|
---|
<capacity> - Capacity data |
---|
total | int | Total number of beds. |
---|
basic | int | Number of basic (main) beds. |
---|
additional | int | Number of additional beds. |
---|
<class> - Accommodation unit classification data |
---|
official | int | Official classification mark (by Croatian authority). |
---|
<amount> - Price amount (per day). |
---|
self | float | Price amount. Element has the following attributes:
- currency [
string ]: Three-letter currency code (according to ISO 4217 standard) in lowercase.
|
---|
<value> - Discount/additional payment value Percent, money or freeDays amount. Negative values are discounts, positive values are additional payments. |
---|
self | n/a | Element has no value. Element has the following attributes:
- type [
type ]: Value type. Supported types are:
|
---|
percent | float | Percent value. |
---|
amount | float | Money amount value. Element has the following attributes:
- currency [
string ]: Three-letter currency code (according to ISO 4217 standard) in lowercase.
|
---|
freeDays | int | Number of free days. Element has the following attributes:
- total [
int ]: Total number of days.
|
---|
<house> - Related House element |
---|
name | string | House name |
---|
capacity | int | Number of beds |
---|
sameBuilding | bool | This house belong to the same building. |
---|
Example usage
Find apartments available in date interval 2024-08-09 to 2024-08-15.
https://api.adriatic.hr/xml-service/server
?method=Private_find
&i_from=2024-08-09
&i_to=2024-08-15
&t=apartment
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Search guest comments for objects. Method is pagination aware (results are split across multiple pages).
Request parameters
id | int | Object ID. This parameter is required. |
---|
page | int | Page number. Default value is 1 . |
---|
limit | int | Number of results per page (max. 25). Default value is 10 . |
---|
Response
<list> - List data |
---|
items | array | Items on current page. Array of <item> elements. See <item> (List item data) for details. |
---|
pager | set | Set of pager elements. See <pager> (List pager data) for details. |
---|
<item> - List item data |
---|
unit | string | Accommodation unit name. Element has the following attributes:
- id [
int ]: Accommodation unit ID. - type [
type ]: Accommodation unit type. - label [
string ]: Accommodation unit character label. Used to distinguish multiple accommodation units with a same type, within the same house.
|
---|
id | int | Review id. |
---|
author | string | Review author name. |
---|
created | datetime | Review creation time. Date-time string in YYYY-MM-DD hh:mm:ss format (ISO 8601). Time zone is Croatian - GMT+1 (+DST). |
---|
customer | bool | Adriatic.hr customer. |
---|
review | string | Review text. Element has the following attributes:
- deleted [
bool ]: Has the review been deleted due to inappropriate contents?
|
---|
rating | set | Ratings. See <rating> (Ratings (1-5)) for details. |
---|
<pager> - List pager data |
---|
totalItems | int | Total items that match search criteria. |
---|
totalPages | int | Total pages. |
---|
currentPage | int | Current page. |
---|
pageLimit | int | Maximum number of items per page. |
---|
<rating> - Ratings (1-5) |
---|
place | int | Place rating. |
---|
beach | int | Beach rating. |
---|
accomodation | int | Accomodation rating. |
---|
host | int | Host rating. |
---|
Example usage
Find reviews for object with ID 1005.
https://api.adriatic.hr/xml-service/server
?method=Private_findReviews
&id=1005
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Retrieve house data.
Request parameters
id | int | House ID. This parameter is required. |
---|
Response
<house> - House data |
---|
self | n/a | Element has no value. Element has the following attributes:
|
---|
name | string | House name. |
---|
capacity | int | Number of beds. |
---|
publishDate | date | House publish date. Date string in YYYY-MM-DD format (ISO 8601). Time zone is Croatian - GMT+1 (+DST). |
---|
postalCode | string | Postal code. |
---|
lastIntervalCheck | datetime | Time when availability intervals are last updated. Date-time string in YYYY-MM-DD hh:mm:ss format (ISO 8601). Time zone is Croatian - GMT+1 (+DST). |
---|
onlineBooking | bool | Book the apartment right away! Adriatic.hr guarantees the availability of facilities in this program. |
---|
bestBuy | bool | Best buy guarantee (best ratio quality and price). |
---|
preferredReservations | array | All prefered reservations by the lessor. Array of <period> elements. See <period> (Period of prefered reservation.) for details. |
---|
units | array | References to all accommodation units which belongs to this house (not necessary match search criteria). Array of <unit> elements. See <unit> (Accommodation unit reference data) for details. |
---|
geo | set | Geography location. See <geo> (Geography location data) for details. |
---|
coordinates | set | Geography coordinates See <coordinates> (Geography coordinates) for details. |
---|
exterior | set | House exterior. See <exterior> (Exterior data) for details. |
---|
service | set | Availability and details of services. See <service> (Service data) for details. |
---|
distance | set | Distances. See <distance> (Distance data) for details. |
---|
location | set | Location data. See <location> (Location data) for details. |
---|
communication | set | Possibilities of communication inside house. See <communication> (Communication data) for details. |
---|
categories | array | Categories which house belongs to. Array of <category> elements. See <category> (House category data) for details. |
---|
robinson | set | List of items related to "Robinson Crusoe style" type of tourism. See <robinson> (Robinson tourism data) for details. |
---|
discounts | array | Discounts and additional payments. Some types of discounts are related to accommodation unit (see Private_getUnit response), whilst others are related to the whole house. Discounts related to the whole house are applicable on every associated accommodation unit. Array of <discount> elements. See <discount> (Discount/additional payment data) for details. |
---|
lowPrice | bool | House contains at least one unit that has a low price? |
---|
relate | set | Related houses. See <relate> (Related objects) for details. |
---|
notes | array | Additional house characteristics. Array of <note> elements. See <note> (Additional house characteristic) for details. |
---|
rating | set | Ratings. See <rating> (Ratings (1-5)) for details. |
---|
images | array | House images. Array of <image> elements. See <image> (House image) for details. |
---|
description | set | Object description. See <description> (Object description) for details. |
---|
guide | set | Object tourist guide. See <guide> (Object location tourist guide) for details. |
---|
<period> - Period of prefered reservation. |
---|
self | n/a | Element has no value. Element has the following attributes:
- arrivalDay [
type ]: Prefered reservation arrival day Supported types are:monday tuesday wednesday thursday friday saturday sunday
- departureDay [
type ]: Prefered reservation departure day Supported types are:monday tuesday wednesday thursday friday saturday sunday
|
---|
<unit> - Accommodation unit reference data |
---|
self | string | Accommodation unit name. Element has the following attributes:
- id [
int ]: Accommodation unit ID. - type [
type ]: Accommodation unit type. - label [
string ]: Accommodation unit character label. Used to distinguish multiple accommodation units with a same type, within the same house. - capacityBasic [
int ]: Basic capacity of the accommodation unit. - capacityAdditional [
int ]: Additional capacity of the accommodation unit.
|
---|
<geo> - Geography location data |
---|
region | string | Region name. Element has the following attributes:
|
---|
riviera | string | Riviera name. Element has the following attributes:
|
---|
place | string | Place name. Element has the following attributes:
|
---|
beach | null | Beach placeholder - beaches does not have names, only IDs. Element has the following attributes:
|
---|
<coordinates> - Geography coordinates |
---|
longitude | decimal | Geographical longitude. |
---|
latitude | decimal | Geographical latitude. |
---|
altitude | decimal | Geographical altitude. |
---|
<exterior> - Exterior data |
---|
disabledPersons | bool | Is suitable for disabled persons? |
---|
courtyard | set | Existence and description of courtyard. See <courtyard> (Courtyard data) for details. |
---|
infield | type | Infield description. Supported types are: |
---|
pool | set | Availability and terms of pool usage. See <pool> (Pool data) for details. |
---|
parkings | array | Array of parking units. Array of <parking> elements. See <parking> (Multiple parking data.) for details. |
---|
fixedGrill | set | Fixed grills. See <fixedGrill> (Fixed grill data) for details. |
---|
shower | bool | Has shower in the courtyard? |
---|
<service> - Service data |
---|
wifiInternet | set | WiFi internet access usage data. See <wifiInternet> (WiFi Internet access service data) for details. |
---|
food | set | Food service data. See <food> (Food service data) for details. |
---|
laundry | set | Laundry service outside of the accommodation unit data. See <laundry> (Laundry service outside of the accommodation unit data) for details. |
---|
boat | set | Boat usage data. See <boat> (Boat service data. Service available on request) for details. |
---|
moor | set | Moor usage data. See <moor> (Moor service data. Service available on request) for details. |
---|
pet | set | Unit with pet approval. See <pet> (Pet service data) for details. |
---|
iron | set | Iron. See <iron> (Equipment data: Iron) for details. |
---|
ironingBoard | set | Ironing board. See <ironingBoard> (Equipment data: Ironing board) for details. |
---|
hairDryer | set | Hair dryer. See <hairDryer> (Equipment data: Hair dryer) for details. |
---|
portableGrill | set | Portable grill. See <portableGrill> (Portable grill data) for details. |
---|
bicycle | set | bicycle. See <bicycle> (Equipment data: Bicycle) for details. |
---|
beachUmbrella | set | Sun umbrellas. See <beachUmbrella> (Equipment data: Sun umbrellas) for details. |
---|
deckChair | set | Deckchairs. See <deckChair> (Equipment data: Deckchairs) for details. |
---|
infantBed | set | Infant bed. See <infantBed> (Infant bed data) for details. |
---|
extraBed | set | Extra bed. See <extraBed> (Extra bed data) for details. |
---|
extraBaby | set | One baby up to 4 years (with no extra bed) is allowed. See <extraBaby> (One baby up to 4 years (with no extra bed) is allowed data) for details. |
---|
smoking | set | Smoking allowed. See <smoking> (Smoking data) for details. |
---|
luxury | set | Luxury services. See <luxury> (Luxury services.) for details. |
---|
<distance> - Distance data |
---|
sea | int | Distance from sea (meters). |
---|
beach | int | Distance from beach (meters). |
---|
shop | int | Distance from shop (meters). Element has the following attributes:
- inHouse [
bool ]: Shop is located in the facility?
|
---|
market | int | Distance from market (meters). Element has the following attributes:
- inHouse [
bool ]: Market is located in the facility?
|
---|
restaurant | int | Distance from restaurant (meters). Element has the following attributes:
- inHouse [
bool ]: Restaurant is located in the facility?
|
---|
ambulance | int | Distance from ambulance (meters). Element has the following attributes:
- inHouse [
bool ]: Ambulance is located in the facility?
|
---|
postOffice | int | Distance from post office (meters). Element has the following attributes:
- inHouse [
bool ]: Post office is located in the facility?
|
---|
nightClub | int | Distance from night club (meters). Element has the following attributes:
- inHouse [
bool ]: Night club is located in the facility?
|
---|
diving | int | Distance from diving center (meters). Element has the following attributes:
- inHouse [
bool ]: Diving center is located in the facility?
|
---|
pharmacy | int | Distance from pharmacy (meters). Element has the following attributes:
- inHouse [
bool ]: Pharmacy is located in the facility?
|
---|
atm | int | Distance from atm (meters). Element has the following attributes:
- inHouse [
bool ]: Atm is located in the facility?
|
---|
exchangeOffice | int | Distance from exchange office (meters). Element has the following attributes:
- inHouse [
bool ]: Exchange office is located in the facility?
|
---|
touristInfo | int | Distance from tourist info (meters). Element has the following attributes:
- inHouse [
bool ]: Tourist info is located in the facility?
|
---|
infirmary | int | Distance from infirmary (meters). Element has the following attributes:
- inHouse [
bool ]: Infirmary is located in the facility?
|
---|
airport | int | Distance from airport (meters). Element has the following attributes:
- inHouse [
bool ]: Airport is located in the facility?
|
---|
ferryPort | int | Distance from ferry port (meters). Element has the following attributes:
- inHouse [
bool ]: Ferry port is located in the facility?
|
---|
busStation | int | Distance from bus station (meters). Element has the following attributes:
- inHouse [
bool ]: Bus station is located in the facility?
|
---|
trainStation | int | Distance from train station (meters). Element has the following attributes:
- inHouse [
bool ]: Train station is located in the facility?
|
---|
rentaCar | int | Distance from rent-a-car (meters). Element has the following attributes:
- inHouse [
bool ]: Rent-a-car is located in the facility?
|
---|
gasStation | int | Distance from airport (meters). Element has the following attributes:
- inHouse [
bool ]: Gas station is located in the facility?
|
---|
autocamp | int | Distance from autocamp (meters). Element has the following attributes:
- inHouse [
bool ]: Autocamp is located in the facility?
|
---|
nationalPark | int | Distance from entrance of the national park (meters). Element has the following attributes:
- inHouse [
bool ]: Facility is located in the national park?
|
---|
otherParking | int | Distance of public parking or parking that is charged extra from facility. Element has the following attributes:
- inHouse [
bool ]: Parking is located within the facility?
|
---|
centre | int | Distance from place center (meters). |
---|
<location> - Location data |
---|
notByTheRoad | bool | Is not by the road? |
---|
byD8Road | bool | Is near Adriatic Highway? |
---|
byMainRoad | bool | Is near main road? |
---|
byLocalRoad | bool | Is near local road? |
---|
noRoadBeforeBeach | bool | Is there no road between house and beach? |
---|
roadD8BeforeBeach | bool | Is there a Adriatic Highway between house and beach? |
---|
mainRoadBeforeBeach | bool | Is there a main road between house and beach? |
---|
localRoadBeforeBeach | bool | Is there a local road between house and beach? |
---|
overpassOrUnderpassBeforeBeach | bool | Is there an overpass or underpass between house and beach? |
---|
nearBeach | bool | Is near beach? |
---|
stairsToBeach | int | Number of stairs between house and beach. |
---|
reachableByCar | bool | Is object reachable by car? Element has the following attributes:
- carApproachDistance [
int ]: Nearest car approach distance.
|
---|
slope | bool | Access by slope road? Element has the following attributes:
- length [
int ]: Length (m).
|
---|
macadam | bool | Access by macadam road? Element has the following attributes:
- length [
int ]: Length (m).
|
---|
narrowStreet | bool | Access by narrow street? Element has the following attributes:
- length [
int ]: Length (m).
|
---|
highUndercarriage | bool | Road is not suitable for cars with low undercarriage? |
---|
accessByBoat | bool | Object accessible only by boat? |
---|
boatTransferUnavailable | bool | Boat transfer offer is unavailable? |
---|
boatLineNoCars | bool | Boat line transfer is available but not for cars? |
---|
boatTransferOffer | set | Boat transfer offer by lessor. See <boatTransferOffer> (Boat transfer offer data) for details. |
---|
noisePollution | type | Noise pollution. Supported types are: |
---|
isolation | bool | House is isolated? |
---|
greenery | type | Green vegetation. Supported types are: |
---|
<communication> - Communication data |
---|
hostPresent | bool | Is host presence possible? |
---|
otherGuests | bool | Is other guests presence possible (in accommodation units outside of our offering)? |
---|
hostLanguages | array | Foreign languages which the host is familiar with. Array of <language> elements. See <language> (Host foreign language data) for details. |
---|
<category> - House category data |
---|
self | type | House category. Supported types are:luxury pool house pension family_owned_hotel family_friendly beach quiet robinson
|
---|
<robinson> - Robinson tourism data |
---|
water | set | Water availability data. See <water> (Water availability data) for details. |
---|
waterHeating | set | Water heating data. See <waterHeating> (Water heating data) for details. |
---|
power | set | Power data. See <power> (Power data) for details. |
---|
other | set | Other data. See <other> (Other robinson tourism related data) for details. |
---|
<discount> - Discount/additional payment data |
---|
type | type | Discount type. Supported types are:special extra_day first_minute valentine special_term easter last_minute highlighted
|
---|
name | string | Name. |
---|
validity | set | Booking date time limitation in which a discount is valid. See <validity> (Discount booking time limitation) for details. |
---|
termValidity | set | Order stay term date time limitation in which a discount is valid. See <termValidity> (Discount order stay term time limitation) for details. |
---|
value | set | Percent, money or freeDays value. See <value> (Discount/additional payment value) for details. |
---|
<validity> - Discount booking time limitation Booking date time limitations in which a discount is valid. |
---|
from | datetime | Booking date from which a discount is valid. Date-time string in YYYY-MM-DD hh:mm:ss format (ISO 8601). Time zone is Croatian - GMT+1 (+DST). |
---|
to | datetime | Booking date from which a discount is invalid. Date-time string in YYYY-MM-DD hh:mm:ss format (ISO 8601). Time zone is Croatian - GMT+1 (+DST). |
---|
<termValidity> - Discount order stay term time limitation Order stay term date time limitations in which a discount is valid. |
---|
from | datetime | Order stay date from which a discount is valid. Date-time string in YYYY-MM-DD hh:mm:ss format (ISO 8601). Time zone is Croatian - GMT+1 (+DST). |
---|
to | datetime | Order stay date from which a discount is invalid. Date-time string in YYYY-MM-DD hh:mm:ss format (ISO 8601). Time zone is Croatian - GMT+1 (+DST). |
---|
<relate> - Related objects |
---|
exist | bool | Is object related with any other object? |
---|
houses | array | Other houses that are related to this house. Array of <house> elements. See <house> (Related House element) for details. |
---|
<note> - Additional house characteristic |
---|
self | string | Description. |
---|
<rating> - Ratings (1-5) |
---|
place | int | Average place rating. Element has the following attributes:
- ratings [
int ]: Number of ratings.
|
---|
beach | int | Average beach rating. Element has the following attributes:
- ratings [
int ]: Number of ratings.
|
---|
accomodation | int | Average accomodation rating. Element has the following attributes:
- ratings [
int ]: Number of ratings.
|
---|
host | int | Average host rating. Element has the following attributes:
- ratings [
int ]: Number of ratings.
|
---|
total | int | Total average rating. Element has the following attributes:
- ratings [
int ]: Number of ratings.
|
---|
<image> - House image |
---|
self | array | Image variants. Array of <variant> elements. See <variant> (Image variant data) for details. Element has the following attributes:
- type [
type ]: Image type (based on subject). Supported types are:exterior courtyard parking host
|
---|
<courtyard> - Courtyard data |
---|
exist | bool | Courtyard exists? |
---|
size | int | Courtyard size (in square meters). |
---|
share | bool | Is shared with other objects? |
---|
playground | bool | Has children playground? |
---|
seats | bool | Has seating place? |
---|
<pool> - Pool data |
---|
exist | bool | Common or private pool exists? |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
length | float | Pool length in meters. |
---|
width | float | Pool width in meters, |
---|
depth | float | Pool depth in meters. |
---|
waterType | string | Pool water type. |
---|
heating | bool | Pool has heating? |
---|
private | set | Private pool data. See <private> (Private pool data.) for details. |
---|
<private> - Private pool data. |
---|
exist | bool | Private pool exists in units? |
---|
units | array | References to all accommodation units which belong to this house (not necessarily matching search criteria) and have access to private pool. Array of <unit> elements. See <unit> (Accommodation unit reference data) for details. |
---|
<parking> - Multiple parking data. |
---|
isGarage | bool | Is designated parking actually a garage? |
---|
stackParking | bool | Cars are parked one behind the other? |
---|
reservedPlaces | int | Number of reserved parking places. |
---|
distance | int | Distance in meters. |
---|
stairsToParking | int | Number of stairs from house to parking. |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
positionYard | bool | Is parking in the yard? |
---|
<fixedGrill> - Fixed grill data |
---|
shared | set | Shared fixed grill. See <shared> (Shared fixed grill data.) for details. |
---|
private | set | Private fixed grills. See <private> (Private fixed grills data.) for details. |
---|
<shared> - Shared fixed grill data. |
---|
exist | bool | Shared fixed grill exists? |
---|
<private> - Private fixed grills data. |
---|
exist | bool | Private fixed grill exists? |
---|
units | array | References to all accommodation units which belongs to this house (not necessary match search criteria) and have access to private fixed grill. Array of <unit> elements. See <unit> (Accommodation unit reference data) for details. |
---|
<wifiInternet> - WiFi Internet access service data |
---|
exist | bool | WiFi Internet access service exists? |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
<food> - Food service data |
---|
breakfast | set | Breakfast service data. See <breakfast> (Breakfast service data) for details. |
---|
halfboard | set | Half-board service data. See <halfboard> (Half-board service data) for details. |
---|
fullboard | set | Full-board service data. See <fullboard> (Full-board service data) for details. |
---|
freeAgeLt4 | bool | Is food service free for children with age under 4 years? |
---|
halfAge4To12 | bool | Is food service on 50% discount for children with age of 4 to 12 years? |
---|
<laundry> - Laundry service outside of the accommodation unit data |
---|
exist | bool | Laundry service exists? |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
<boat> - Boat service data. Service available on request |
---|
exist | bool | Boat service exists? |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
<moor> - Moor service data. Service available on request |
---|
exist | bool | Moor service exists? |
---|
type | type | Moor type. Supported types are: |
---|
distance | int | Distance from object in meters. |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
<pet> - Pet service data |
---|
exist | bool | Pet service exists? |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
units | array | References to all accommodation units which belong to this house where pets are allowed. Array of <unit> elements. See <unit> (Accommodation unit reference data) for details. |
---|
<iron> - Equipment data: Iron |
---|
exist | bool | Device available? |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
<ironingBoard> - Equipment data: Ironing board |
---|
exist | bool | Device available? |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
<hairDryer> - Equipment data: Hair dryer |
---|
exist | bool | Device available? |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
<portableGrill> - Portable grill data |
---|
exist | bool | Device available? |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
<bicycle> - Equipment data: Bicycle |
---|
exist | bool | Device available? |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
quantity | int | Quantity in numbers. |
---|
<beachUmbrella> - Equipment data: Sun umbrellas |
---|
exist | bool | Device available? |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
<deckChair> - Equipment data: Deckchairs |
---|
exist | bool | Device available? |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
<infantBed> - Infant bed data |
---|
exist | bool | Infant bed available? |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
<extraBed> - Extra bed data |
---|
exist | bool | Extra bed available? |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
quantity | int | Quantity in numbers. |
---|
units | array | References to all accommodation units which belongs to this house (not necessary match search criteria) where extra bed is available. Array of <unit> elements. See <unit> (Accommodation unit reference data) for details. |
---|
<extraBaby> - One baby up to 4 years (with no extra bed) is allowed data |
---|
exist | bool | Extra baby available? |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
<smoking> - Smoking data |
---|
exist | bool | Smoking allowed? |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
units | array | References to all accommodation units which belongs to this house (not necessary match search criteria) where smoking is allowed. Array of <unit> elements. See <unit> (Accommodation unit reference data) for details. |
---|
<luxury> - Luxury services. |
---|
jacuzzi | bool | Is jacuzzi available? |
---|
sauna | bool | Is sauna available? |
---|
wellness | bool | Is wellness available? |
---|
massage | bool | Is massage available? |
---|
fitness | bool | Is fitness available? |
---|
wineCellar | bool | Is wine cellar available? |
---|
minibar | bool | Is minibar available? |
---|
additionalCleaning | bool | Is additional cleaning available? |
---|
attendants | bool | Is additional staff available? |
---|
<water> - Water availability data |
---|
waterTank | bool | Has water tank filled by rainwater or by a cistern. |
---|
waterPlumbing | bool | Has regular water supply. |
---|
waterNonDrinkable | bool | Water is not drinkable? |
---|
<waterHeating> - Water heating data |
---|
onlyColdWater | bool | Only cold water is available. |
---|
oil | bool | Is water heated by an oil generator. |
---|
solar | bool | Is water heated by solar collectors. |
---|
gasBoiler | bool | Is water heated by a gas boiler. |
---|
sun | bool | Water is heated by direct sunlight. |
---|
showerSun | bool | Water for the outside showers is heated by direct sunlight. |
---|
<power> - Power data |
---|
noPower | bool | The house has no power supply. |
---|
solar12 | bool | 12V solar energy power supply. |
---|
solar220 | bool | 220V solar energy power supply. |
---|
oil12 | bool | 12V power supply through oil generator. |
---|
oil220 | bool | 220V power supply through oil generator. |
---|
electricGrid | bool | Power supply from electric grid. |
---|
<other> - Other robinson tourism related data |
---|
mobileMarket | bool | Mobile market is available. |
---|
gasRefrigerator | bool | Gas refrigerator. |
---|
gasStove | bool | Gas stove. |
---|
outsideToilet | bool | Has an outside toilet. Element has the following attributes:
- distance [
int ]: Distance of outside toilet from the object (in meters).
|
---|
<variant> - Image variant data Image variants are versions of the same image, differentiated by size, listed if exist. |
---|
self | n/a | Element has no value. Element has the following attributes:
- type [
type ]: Image variant type (size class). Supported types are:l - large (max. 365px, horizontal or vertical)s - small (115x86px)m - medium (200x133px)max4000x2667 - jumbo (max. height 4000px)
|
---|
url | string | Image variant URL. |
---|
<boatTransferOffer> - Boat transfer offer data |
---|
exist | bool | Boat transfer offer available? |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
<price> - Pricing data |
---|
type | type | Price type. Supported types are:extra - service is charged additionalyextra_adult - service is charged additionaly only for adultsincluded - service is not charged additionalyagreement - service price is subject of agreement with house ownerextra_by_device - service is charged additionaly for each deviceconsumption - service is charged additionaly based on consumption
|
---|
amount | float | Price amount. Element has the following attributes:
- currency [
string ]: Three-letter currency code (according to ISO 4217 standard) in lowercase.
|
---|
unit | type | Price unit type. Supported types are:onetime day person person_day hour minute second page kb mb gb wash call kwh agreement transport week day_piece
|
---|
<value> - Discount/additional payment value Percent, money or freeDays amount. Negative values are discounts, positive values are additional payments. |
---|
self | n/a | Element has no value. Element has the following attributes:
- type [
type ]: Value type. Supported types are:
|
---|
percent | float | Percent value. |
---|
amount | float | Money amount value. Element has the following attributes:
- currency [
string ]: Three-letter currency code (according to ISO 4217 standard) in lowercase.
|
---|
freeDays | int | Number of free days. Element has the following attributes:
- total [
int ]: Total number of days.
|
---|
<language> - Host foreign language data |
---|
code | string | Two-letter language code (according to ISO 639-1 standard) in lowercase. |
---|
knowledge | int | Knowledge mark. Range is from 1 (poor) to 5 (excellent). |
---|
<breakfast> - Breakfast service data |
---|
exist | bool | Breakfast service exists? |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
<halfboard> - Half-board service data |
---|
exist | bool | Half-board service exists? |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
<fullboard> - Full-board service data |
---|
exist | bool | Full-board service exists? |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
<house> - Related House element |
---|
name | string | House name |
---|
capacity | int | Number of beds |
---|
sameBuilding | bool | This house belong to the same building. |
---|
<description> - Object description |
---|
summary | string | Object description summary |
---|
body | string | Object description body |
---|
<guide> - Object location tourist guide |
---|
items | array | Tourist guide information of the place, riviera and region where the object is located. Array of <item> elements. See <item> (Geo location data) for details. |
---|
<item> - Geo location data |
---|
self | n/a | Element has no value. Element has the following attributes:
- type [
type ]: Geo location type of the item. Supported types are:
|
---|
name | string | Geo location name. |
---|
description | string | Description of the geo location. |
---|
image | array | Geo location image. References to all geo location image variants which belong to this tourist guide item. Array of <variant> elements. See <variant> (Image variant data) for details. |
---|
Example usage
Retrieve data of private accommodation house with ID 1005.
https://api.adriatic.hr/xml-service/server
?method=Private_getHouse
&id=1005
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Retrieve accommodation unit data.
Request parameters
id | int | Accommodation unit ID. This parameter is required. |
---|
prc_wod | bool | Prices without discounts (applies only to an accommodation service price list). Use this if you want to show original price list (without discount, if any exist) and print (advert) discount information elsewhere, instead of just including discounts into price list. Default value is FALSE . |
---|
Response
<unit> - Accommodation unit data |
---|
self | n/a | Element has no value. Element has the following attributes:
- id [
int ]: Accommodation unit ID.
|
---|
name | string | Name (eg. A-1000-c, K-1000, etc.). Name is consisted of type code (K, A, AS or K), house name and character label (not used for house type). This description is for your information only (you don't have to deal with it). |
---|
lastIntervalCheck | datetime | Time when availability intervals are last updated. Date-time string in YYYY-MM-DD hh:mm:ss format (ISO 8601). Time zone is Croatian - GMT+1 (+DST). |
---|
type | type | Type. Supported types are:house apartment studio-apartment room
|
---|
label | string | Character label. Used to distinguish multiple accommodation units with a same type, within the same house. |
---|
house | string | Name of the house which accommodation unit belongs to. Element has the following attributes:
|
---|
capacity | set | Capacity data. See <capacity> (Capacity data) for details. |
---|
class | set | Classification data. See <class> (Accommodation unit classification data) for details. |
---|
position | set | Position inside house data. See <position> (Position data) for details. |
---|
entrance | set | Entrance data. See <entrance> (Entrance data) for details. |
---|
disabledPersons | bool | Is suitable for disabled persons? |
---|
parts | array | Available parts. Part is an inner or outer area of accommodation unit (eg. room, terrace, balcony, etc.). Array of <part> elements. See <part> (Part data) for details. |
---|
service | set | Availability and details of services. See <service> (Service data) for details. |
---|
priceList | set | Price list data. Accommodation unit daily price depends of date and number of persons. Thus, prices are groupped by date intervals and number of persons. See <priceList> (Price list data) for details. |
---|
rating | set | Ratings. See <rating> (Ratings (1-5)) for details. |
---|
notes | array | Additional accommodation unit characteristics. Array of <note> elements. See <note> (Additional accommodation unit characteristic) for details. |
---|
images | array | Images. Array of <image> elements. See <image> (Image) for details. |
---|
description | set | Accommodation unit description. See <description> (Accommodation unit description) for details. |
---|
<capacity> - Capacity data |
---|
total | int | Total number of beds. |
---|
basic | int | Number of basic (main) beds. |
---|
additional | int | Number of additional beds. |
---|
<class> - Accommodation unit classification data |
---|
official | int | Official classification mark (by Croatian authority). |
---|
<position> - Position data |
---|
floor | int | Floor. Value of zero represent ground floor, negative values represent basement floors. |
---|
floorSpan | int | Number of floors through which this accommodation unit spans. |
---|
raisedFloor | bool | Is the unit floor raised? Special examples: if floor is 0 (ground floor) and the floor is raised, it's upper ground floor; if floor is -1 (basement) and the floor is raised, it's half basement. |
---|
mezzanine | bool | Is this a mezzanine floor? |
---|
attic | bool | Is this unit in the attic? |
---|
flat | bool | Is this unit flat in building? |
---|
detachedUnit | bool | Is this detached unit? |
---|
<entrance> - Entrance data |
---|
share | set | Entrance sharing data. See <share> (Resource sharing data) for details. |
---|
shared | bool | Does the unit have a shared entrance (with the host or other units)? |
---|
doorSeparated | bool | Is the unit separated by door from other units in the object. |
---|
entranceType | type | Type of unit entrance. Supported types are:common host unit_hallway out_offer_unit_hallway
|
---|
entranceFromUnit | text | Contains accommodation unit name if the entrance to the unit is from the stated unit. Element has the following attributes:
- id [
int ]: Accommodation unit ID.
|
---|
somePartsNotConnected | bool | Some parts of this accommodation unit are not connected with the rest of the unit. |
---|
<part> - Part data |
---|
self | n/a | Element has no value. Element has the following attributes:
|
---|
type | type | Type. Supported types are:living dining kitchen bathroom toilet bedroom hall terrace balcony
|
---|
size | int | Size (in square meters). |
---|
house | bool | Belongs to the entire house? |
---|
airConditioning | bool | Has an opening to the air-conditioning unit. |
---|
beds | array | Available beds. Array of <bed> elements. See <bed> (Bed data) for details. |
---|
standard | bool | Has standard equipment? Used for kitchens only. Standard equipment includes: refrigerator, stove (without oven), sink and dishes |
---|
smallKitchen | bool | Kitchen is small (kitchenette)? Used for kitchens only. Standard equipment includes: small refrigerator and sink |
---|
fridge | bool | Has fridge? Used for kitchens only. |
---|
iceChest | bool | Has ice-chest? Used for kitchens only. |
---|
fridgeIceChest | bool | Has combine fridge/ice-chest? Used for kitchens only. |
---|
dishWasher | bool | Has dish-washer? Used for kitchens only. |
---|
oven | bool | Has oven? Used for kitchens only. |
---|
stove | bool | Has stove? Used for kitchens only. |
---|
hotPlate | bool | Has hot plate (table cooker)? Used for kitchens only. |
---|
microwave | bool | Has microwave? Used for kitchens only. Element has the following attributes:
- onRequest [
bool ]: Service available on request?
|
---|
price | set | Pricing data. Used for kitchens only. See <price> (Pricing data) for details. |
---|
bathTub | bool | Has bathtub? Used for bathrooms only. |
---|
showerBath | bool | Has shower-bath? Used for bathrooms only. |
---|
shade | set | Sun shade data. Used for outer parts (terraces and balconies) only. See <shade> (Sun shade data) for details. |
---|
seaView | bool | Has sea view? Used for outer parts (terraces and balconies) only. |
---|
relate | set | Related data. See <relate> (Related data) for details. |
---|
share | set | Sharing data. See <share> (Resource sharing data) for details. |
---|
passage | set | Information about who has to cross the this part. See <passage> (Part passage data) for details. |
---|
separation | set | Information about whether this part is separated from its accommodation unit. Also contains
information on entrance into the room. See <separation> (Part separation data) for details. |
---|
windowWalled | bool | Information about whether the windows shown in the room are walled up. |
---|
windowShuttersOnly | bool | Do the windows shown in the room have shutters but no window panes? |
---|
windowWallView | bool | Information about whether the windows shown in the room face the nearby wall. |
---|
<service> - Service data |
---|
terrTv | bool | Is terrestrial TV program available? |
---|
satTv | bool | Is satellite TV program available? |
---|
pc | bool | Is personal comuter available? |
---|
safe | bool | Is safe deposit box available? |
---|
fixedGrill | bool | Is private fixed grill available? |
---|
fridge | bool | Is fridge available? This is used only when accommodation unit type is defined as a room. |
---|
ac | set | Air conditioner usage data. See <ac> (Air conditioner data) for details. |
---|
heating | set | Heating usage data. See <heating> (Heating data) for details. |
---|
kitchen | set | Kitchen usage data. Kitchen service can exist only if accommodation unit type is room. See <kitchen> (Kitchen data) for details. |
---|
finalCleaning | set | Final cleaning data. See <finalCleaning> (Final cleaning service data) for details. |
---|
deposit | set | Deposit data. See <deposit> (Deposit data) for details. |
---|
childBed | set | Additional accommodation for children in bed for children. See <childBed> (Additional accommodation for children in bed for children data) for details. |
---|
pet | bool | Pet accommodation data. |
---|
extraBedOnRequest | bool | Extra bed on request. |
---|
smoking | bool | Is smoking allowed in the unit? |
---|
laundryMachine | bool | Does unit have a laundry machine? |
---|
<priceList> - Price list data |
---|
intervals | array | Prices by intervals. Array of <interval> elements. See <interval> (Interval data) for details. |
---|
year | int | Price list year. |
---|
nextYearIntervals | array | Prices by intervals for the next year. Array of <interval> elements. See <interval> (Interval data) for details. |
---|
lowPrice | bool | Accommodation unit has a low price? |
---|
touristTaxIncluded | bool | Accommodation unit has tourist tax included in price? |
---|
shortOrderExtraCharge | bool | Accommodation unit has short stay charged extra? |
---|
<note> - Additional accommodation unit characteristic |
---|
self | string | Description. |
---|
<rating> - Ratings (1-5) |
---|
place | int | Average place rating. Element has the following attributes:
- ratings [
int ]: Number of ratings.
|
---|
beach | int | Average beach rating. Element has the following attributes:
- ratings [
int ]: Number of ratings.
|
---|
accomodation | int | Average accomodation rating. Element has the following attributes:
- ratings [
int ]: Number of ratings.
|
---|
host | int | Average host rating. Element has the following attributes:
- ratings [
int ]: Number of ratings.
|
---|
total | int | Total average rating. Element has the following attributes:
- ratings [
int ]: Number of ratings.
|
---|
<image> - Image |
---|
self | array | Image variants. Array of <variant> elements. See <variant> (Image variant data) for details. Element has the following attributes:
- type [
type ]: Image type (based on subject). Supported types are: - partId [
int ]: Part ID. This value makes sense only if type has value of part. - view [
bool ]: Does image represent a view from part? This value makes sense only if type has value of part.
|
---|
<description> - Accommodation unit description |
---|
summary | string | Accommodation unit description summary. |
---|
<bed> - Bed data |
---|
capacity | int | Person capacity. |
---|
type | type | Type. Supported types are:single double foldaway armchair sofa
|
---|
children | bool | Is it intended for children only? |
---|
small | bool | Dimensions of the bed aren't standard size (80x190 or 160x190)? |
---|
<shade> - Sun shade data |
---|
exist | bool | Sun shade exists? |
---|
types | array | All available sun shade types. Array of <type> elements. See <type> (Sun shade data.) for details. |
---|
<type> - Sun shade data. |
---|
self | type | Sun shade type. Supported types are:natural awning canopy chervil sunshade object_shade
|
---|
<relate> - Related data |
---|
exist | bool | Is part related with any other part? |
---|
parts | array | Parts in our accommodation units (in our offering) which relate with this part. Array of <part> elements. See <part> (Related part data) for details. |
---|
host | bool | Is part related with part used by the host? |
---|
otherUnits | set | Other accommodation units (outside of our offering) which relate with this part. See <otherUnits> (Other accommodation units data) for details. |
---|
<share> - Resource sharing data |
---|
exist | bool | Is resource shared with anyone? |
---|
host | bool | Is resource shared with the host? |
---|
agencyUnits | array | Our accommodation units (in our offering) which share the resource. Array of <unit> elements. See <unit> (Accommodation unit reference data) for details. |
---|
otherUnits | set | Other accommodation units (outside of our offering) which share the resource. See <otherUnits> (Other accommodation units data) for details. |
---|
<passage> - Part passage data |
---|
exist | bool | Does anyone have to cross this room? |
---|
host | bool | Does the host have to cross this room? |
---|
guestsAgency | bool | Do guests from other accommodation units in our offer have to cross this room? |
---|
guestsAgencyUnits | array | List of accommodation units in our offer whose guests have to cross this room. Array of <unit> elements. See <unit> (Accommodation unit data) for details. |
---|
guestsOtherUnits | set | Other accommodation units (outside of our offering) whose guests have to cross the room. See <otherUnits> (Other accommodation units data) for details. |
---|
entranceIntoUnit | bool | Is entrance into the accommodation unit through this room. Available only for 'bedroom' room type. |
---|
passageToParts | array | List of rooms accessed through this room. Only available for 'bedroom' room types. Array of <part> elements. See <part> (Passage to part data) for details. |
---|
<separation> - Part separation data |
---|
detachedFromUnit | bool | Is the part detached from its accommodation unit? Not available for parts that belong to an object. |
---|
entranceFrom | type | Specifies from where the part is entered from. Supported types are:from yard common_hallway common_parts host_residence from_part
|
---|
entranceFromPart | set | If part is accessed from another part in our offer, then the data for that part is listed here. See <entranceFromPart> (Entrance from part data) for details. |
---|
<capacity> - Capacity for child bed. |
---|
self | n/a | Element has no value. Element has the following attributes:
- num [
int ]: Number of children.
|
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
<ac> - Air conditioner data |
---|
exist | bool | Air conditioner exists? |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
<heating> - Heating data |
---|
exist | bool | Heating exists? |
---|
type | type | Type of heating. Sole supported type is: |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
<kitchen> - Kitchen data This is used only if accommodation unit type is room. |
---|
exist | bool | Kitchen exists? |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
<finalCleaning> - Final cleaning service data |
---|
exist | bool | Final cleaning service exists? |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
<deposit> - Deposit data |
---|
exist | bool | Deposit exists? |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
<childBed> - Additional accommodation for children in bed for children data |
---|
exist | bool | Additional child bed exists? |
---|
price | set | Pricing data. See <price> (Pricing data) for details. |
---|
<interval> - Interval data |
---|
from | date | Begin of interval (format is YYYY-MM-DD). Date string in YYYY-MM-DD format (ISO 8601). Time zone is Croatian - GMT+1 (+DST). |
---|
to | date | End of interval (format is YYYY-MM-DD). Date string in YYYY-MM-DD format (ISO 8601). Time zone is Croatian - GMT+1 (+DST). |
---|
prices | array | Prices by number of persons. First price is for maximum number of persons. Array of <price> elements. See <price> (Interval price data) for details. |
---|
<discount> - Discount/additional payment data |
---|
type | type | Discount type. Supported types are:special extra_day first_minute valentine special_term easter last_minute highlighted
|
---|
name | string | Name. |
---|
value | set | Percent, money or freeDays value. See <value> (Discount/additional payment value) for details. |
---|
<value> - Discount/additional payment value Percent, money or freeDays amount. Negative values are discounts, positive values are additional payments. |
---|
self | n/a | Element has no value. Element has the following attributes:
- type [
type ]: Value type. Supported types are:
|
---|
percent | float | Percent value. |
---|
amount | float | Money amount value. Element has the following attributes:
- currency [
string ]: Three-letter currency code (according to ISO 4217 standard) in lowercase.
|
---|
freeDays | int | Number of free days. Element has the following attributes:
- total [
int ]: Total number of days.
|
---|
<variant> - Image variant data Image variants are versions of the same image, differentiated by size, listed if exist. |
---|
self | n/a | Element has no value. Element has the following attributes:
- type [
type ]: Image variant type (size class). Supported types are:l - large (max. 365px, horizontal or vertical)s - small (115x86px)m - medium (200x133px)max4000x2667 - jumbo (max. height 4000px)
|
---|
url | string | Image variant URL. |
---|
<price> - Pricing data |
---|
type | type | Price type. Supported types are:extra - service is charged additionalyextra_adult - service is charged additionaly only for adultsincluded - service is not charged additionalyagreement - service price is subject of agreement with house ownerextra_by_device - service is charged additionaly for each deviceconsumption - service is charged additionaly based on consumption
|
---|
amount | float | Price amount. Element has the following attributes:
- currency [
string ]: Three-letter currency code (according to ISO 4217 standard) in lowercase.
|
---|
unit | type | Price unit type. Supported types are:onetime day person person_day hour minute second page kb mb gb wash call kwh agreement transport week day_piece
|
---|
<unit> - Accommodation unit reference data |
---|
self | string | Accommodation unit name. Element has the following attributes:
- id [
int ]: Accommodation unit ID. - type [
type ]: Accommodation unit type. - label [
string ]: Accommodation unit character label. Used to distinguish multiple accommodation units with a same type, within the same house. - capacityBasic [
int ]: Basic capacity of the accommodation unit. - capacityAdditional [
int ]: Additional capacity of the accommodation unit.
|
---|
<otherUnits> - Other accommodation units data |
---|
exist | bool | Other accommodation units exists? |
---|
count | int | Count of other accommodation units. |
---|
<part> - Related part data |
---|
self | n/a | Element has no value. Element has the following attributes:
- id [
int ]: Related part ID. - type [
string ]: Related part type.
|
---|
object | int | ID of the house that the room belongs to. Used for shared rooms. Set to 0 if room belongs to an accommodation unit. |
---|
thisUnit | bool | Part is used by this accommodation unit. |
---|
share | set | Sharing data. See <share> (Resource sharing data) for details. |
---|
<part> - Passage to part data |
---|
self | n/a | Element has no value. Element has the following attributes:
- id [
int ]: Related part ID. - type [
string ]: Related part type.
|
---|
object | int | ID of the house that the room belongs to. Used for shared rooms. Set to 0 if room belongs to an accommodation unit. |
---|
thisUnit | bool | Part is used by this accommodation unit. |
---|
share | set | Sharing data. See <share> (Resource sharing data) for details. |
---|
<entranceFromPart> - Entrance from part data |
---|
self | n/a | Element has no value. Element has the following attributes:
- id [
int ]: Related part ID. - type [
string ]: Related part type.
|
---|
object | int | ID of the house that the room belongs to. Used for shared rooms. Set to 0 if room belongs to an accommodation unit. |
---|
thisUnit | bool | Part is used by this accommodation unit. |
---|
share | set | Sharing data. See <share> (Resource sharing data) for details. |
---|
<price> - Interval price data |
---|
amount | float | Price amount (per day). Element has the following attributes:
- currency [
string ]: Three-letter currency code (according to ISO 4217 standard) in lowercase.
|
---|
persons | int | Number of persons. |
---|
Example usage
Retrieve data of private accommodation unit with ID 1868.
https://api.adriatic.hr/xml-service/server
?method=Private_getUnit
&id=1868
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Get accommodation unit(s)'s availability status.
Request parameters
id | list | Comma delimited list of accommodation unit IDs. Example: "1868,1869". This parameter is required. |
---|
i_from | date | Begin of interval. Allowed format is YYYY-MM-DD. This parameter is required. |
---|
i_to | date | End of interval. Allowed format is YYYY-MM-DD. This parameter is required. |
---|
Response
<status> - Availability data |
---|
avail | bool | All specified accommodation units are available? Element has the following attributes:
- type [
type ]: Availability status type. Supported types are:avail - availableunavail_temp - temporarily unavailableunavail - unavailable
|
---|
units | array | Availability by accommodation unit. Array of <unit> elements. See <unit> (Accommodation unit availability) for details. |
---|
<unit> - Accommodation unit availability |
---|
self | n/a | Element has no value. Element has the following attributes:
- id [
int ]: Accommodation unit ID.
|
---|
avail | bool | Accommodation unit is available? Element has the following attributes:
- type [
type ]: Availability status type. Supported types are:
|
---|
Example usage
Get availability status of accommodation units with IDs 1868 and 1869 in date interval 2024-08-09 to 2024-08-15.
https://api.adriatic.hr/xml-service/server
?method=Private_getAvailStatus
&id=1868%2C1869
&i_from=2024-08-09
&i_to=2024-08-15
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Get accommodation unit unavailable dates.
Request parameters
id | int | Accommodation unit ID. This parameter is required. |
---|
Response
<dates> - Unavailable dates data |
---|
self | array | Unavailable dates (if any). Array of <date> elements. See <date> (Unavailable date data) for details. |
---|
<date> - Unavailable date data |
---|
self | date | Date string in YYYY-MM-DD format (ISO 8601). Time zone is Croatian - GMT+1 (+DST). Element has the following attributes:
- type [
type ]: Availability status type. Supported types are:
|
---|
Example usage
Get unavailable dates of accommodation units with ID 2459.
https://api.adriatic.hr/xml-service/server
?method=Private_getUnavailDates
&id=2459
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Search geography locations (except beaches). Method is pagination aware (results are split across multiple pages).
Request parameters
id | int | Comma delimited list of region, riviera and place IDs. Example: "re-2,ri-17,pl-106". |
---|
q | string | Search string (case insensitive). |
---|
q_match | type | String matching mode. Hint: begin and begin_word modes can be used for implementation of location input field with autocomplete support. Supported types are:substring - Anywhere in the stringbegin - At the beginning of the stringbegin_word - At the beginning of any word in the stringexact - Exact match Default value is substring . |
---|
t | type | Location type. Supported types are: |
---|
sort | type | Sort criterion. Supported types are:name - Location nametype - Location type Default value is name . |
---|
sort_dir | type | Sort direction. Supported types are:asc - Ascendingdesc - Descending Default value is asc . |
---|
page | int | Page number. Default value is 1 . |
---|
limit | int | Number of results per page (max. 25). Default value is 10 . |
---|
Response
<list> - List data |
---|
items | array | Items on current page. Array of <item> elements. See <item> (List item data) for details. |
---|
pager | set | Set of pager elements. See <pager> (List pager data) for details. |
---|
<item> - List item data |
---|
id | string | Location ID. |
---|
name | string | Location name. |
---|
type | type | Location type. Supported types are: |
---|
riviera | string | Riviera name. Available only if location type is place . Element has the following attributes:
|
---|
region | string | Region name. Available only if location type is place or riviera . Element has the following attributes:
|
---|
image | array | Image of location. Array of <variant> elements. See <variant> (Image variant data) for details. |
---|
coordinates | set | Geography coordinates. Available only if location type is place . See <coordinates> (Geography coordinates) for details. |
---|
<pager> - List pager data |
---|
totalItems | int | Total items that match search criteria. |
---|
totalPages | int | Total pages. |
---|
currentPage | int | Current page. |
---|
pageLimit | int | Maximum number of items per page. |
---|
<variant> - Image variant data Image variants are versions of the same image, differentiated by size, listed if exist. |
---|
self | n/a | Element has no value. Element has the following attributes:
- type [
type ]: Image variant type (size class). Supported types are:l - large (max. 365px, horizontal or vertical)s - small (115x86px)m - medium (200x133px)max4000x2667 - jumbo (max. height 4000px)
|
---|
url | string | Image variant URL. |
---|
<region> - Region data |
---|
name | string | Region name. |
---|
rivieras | array | References to all rivieras which belong to this region. Array of <riviera_ref> elements. See <riviera_ref> for details. |
---|
images | array | Region images. Array of <image> elements. See <image> for details. |
---|
<coordinates> - Geography coordinates |
---|
longitude | decimal | Geographical longitude. |
---|
latitude | decimal | Geographical latitude. |
---|
altitude | decimal | Geographical altitude. |
---|
Example usage
Find geography locations with word 'hvar' in name.
https://api.adriatic.hr/xml-service/server
?method=Geo_find
&q=hvar
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Retrieve geography location data. Supported location types are place, beach, riviera and region.
Request parameters
id | string | Geography location data. This parameter is required. |
---|
Response
<location> - Location data |
---|
self | n/a | Element has no value. Element has the following attributes:
- id [
string ]: Location ID.
|
---|
type | type | Location type. Supported types are: |
---|
region | set | Region name. Available only if location type is region . See <region> (Region data) for details. Element has the following attributes:
|
---|
riviera | set | Riviera name. Available only if location type is riviera . See <riviera> (Riviera data) for details. Element has the following attributes:
|
---|
place | set | Place name. Available only if location type is place . See <place> (Place data) for details. Element has the following attributes:
|
---|
beach | set | Beach name. Available only if location type is beach . See <beach> (Beach data) for details. Element has the following attributes:
|
---|
<region> - Region data |
---|
name | string | Region name. |
---|
rivieras | array | References to all rivieras which belong to this region. Array of <riviera> elements. See <riviera> (Riviera reference) for details. |
---|
images | array | Region images. Array of <image> elements. See <image> (Image) for details. |
---|
<riviera> - Riviera data |
---|
name | string | Riviera name. |
---|
region | string | Region name. Element has the following attributes:
|
---|
type | type | Riviera type. Supported types are:mainland_not_sea_coast mainland_sea_coast island islands island_bridge
|
---|
places | array | References to all places which belong to this riviera. Array of <place> elements. See <place> (Place reference) for details. |
---|
images | array | Riviera images. Array of <image> elements. See <image> (Image) for details. |
---|
<place> - Place data |
---|
name | string | Place name. |
---|
riviera | string | Riviera name. Element has the following attributes:
|
---|
region | string | Region name. Element has the following attributes:
|
---|
nationalPark | string | National park name. Element has the following attributes:
- id [
string ]: National park ID. - inArea [
bool ]: Place is located within the boundaries of the National park.
|
---|
type | type | Place type. Supported types are:large_city tourist_city small_city cove
|
---|
largerPlace | set | Larger place data. See <largerPlace> (Larger place data) for details. |
---|
islet | set | Islet data. See <islet> (Islet data) for details. |
---|
beachesGeneral | set | General info on beaches which belong to this place. See <beachesGeneral> (Place beaches data) for details. |
---|
beaches | array | References to all beaches which belong to this place. Array of <beach> elements. See <beach> (Beach reference) for details. |
---|
images | array | Place images. Array of <image> elements. See <image> (Image) for details. |
---|
coordinates | set | Geography coordinates. See <coordinates> (Geography coordinates) for details. |
---|
<beach> - Beach data |
---|
name | string | Beach name. |
---|
place | string | Place name. Element has the following attributes:
|
---|
riviera | string | Riviera name. Element has the following attributes:
|
---|
region | string | Region name. Element has the following attributes:
|
---|
outsideAPlace | bool | Is beach outside a place? |
---|
coordinates | set | Geography coordinates. See <coordinates> (Geography coordinates) for details. |
---|
type | type | Main beach type. Supported types are:sand pebble stone concrete sharp_stone riva
|
---|
types | array | All available beach types. Array of <type> elements. See <type> (Beach type) for details. |
---|
access | type | Sea access type. Supported types are:long_shallow short_shallow no_shallow
|
---|
private | bool | Beach is 'private' (isolated)? |
---|
naturalShade | bool | Beach has a natural shade? |
---|
shower | bool | Beach has a shower? |
---|
entertainment | bool | Beach has an entertainment content? |
---|
nudeOfficial | bool | Beach is official nudist beach? |
---|
nudeSuitable | bool | Beach is suitable for nudism? |
---|
extra | array | All available extra beach content. Array of <extra> elements. See <extra> (Extra beach content) for details. |
---|
other | set | Data of other beaches in the same place. See <other> (Other beaches data) for details. |
---|
images | array | Beach images. Array of <image> elements. See <image> (Image) for details. |
---|
<region> - Region reference |
---|
self | string | Region name. Element has the following attributes:
|
---|
<riviera> - Riviera reference |
---|
self | string | Riviera name. Element has the following attributes:
|
---|
<place> - Place reference |
---|
self | string | Place name. Element has the following attributes:
|
---|
<beach> - Beach reference |
---|
self | n/a | Element has no value. Element has the following attributes:
|
---|
<largerPlace> - Larger place data |
---|
exist | bool | Larger place exists? |
---|
name | string | Larger place name (only if the larger place exists). |
---|
id | string | Larger place ID (only if the larger place exists). |
---|
boatTransport | bool | Boat transport is necessary to get to the larger place (only if the larger place exists)? |
---|
<islet> - Islet data |
---|
exist | bool | Place is on an islet? |
---|
name | string | Islet name (only if the islet exists). |
---|
transportCar | bool | Car can be transported onto the islet (only if the islet exists)? |
---|
<beachesGeneral> - Place beaches data |
---|
nudeOfficial | bool | Place has an official nudism beach? |
---|
nudeSuitable | bool | Place has a beach suitable for nudism? |
---|
entertainment | bool | Place has a beach with an entertainment content? |
---|
naturalShade | bool | Place has a beach with a natural shade? |
---|
shower | bool | Place has a beach with a shower? |
---|
private | bool | Place has a beach that is 'private' (isolated)? |
---|
extra | array | All available extra beach content. Array of <extra> elements. See <extra> (Extra beach content) for details. |
---|
types | array | All available beach types. Array of <type> elements. See <type> (Beach type) for details. |
---|
access | type | Place has a beach with this access type. Supported types are:long_shallow short_shallow no_shallow
|
---|
<other> - Other beaches data |
---|
types | array | All available beach types. Array of <type> elements. See <type> (Beach type) for details. |
---|
access | type | Sea access type. Supported types are:long_shallow short_shallow no_shallow
|
---|
nudeOfficial | bool | Official nudism beach? |
---|
nudeSuitable | bool | Suitable for nudism? |
---|
entertainment | bool | Entertainment content? |
---|
naturalShade | bool | Natural shade? |
---|
shower | bool | Has shower? |
---|
private | bool | 'Private' (isolated)? |
---|
extra | array | All available extra beach content. Array of <extra> elements. See <extra> (Extra beach content) for details. |
---|
images | array | Images of other beaches. Array of <image> elements. See <image> (Image) for details. |
---|
<extra> - Extra beach content |
---|
cateringFacility | bool | Catering facility? |
---|
waterPark | bool | Water park? |
---|
jetSki | bool | Jet ski? |
---|
pedalBoat | bool | Pedal boat? |
---|
sportFacilities | bool | Sport facilities? |
---|
playground | bool | Playground? |
---|
beachumbrellaDeckchair | bool | Beachumbrella or/and deckchair? |
---|
lifeguard | bool | Is guarded by lifeguard? |
---|
parkingNear | bool | Is parking near? |
---|
adaptedForDisabled | bool | Is adapted for disabled? |
---|
suitableForDisabled | bool | Is suitable for disabled? |
---|
<image> - Image |
---|
self | array | Image variants. Array of <variant> elements. See <variant> (Image variant data) for details. Element has the following attributes:
- type [
type ]: Image type (only for place). Supported types are:
|
---|
<variant> - Image variant data Image variants are versions of the same image, differentiated by size, listed if exist. |
---|
self | n/a | Element has no value. Element has the following attributes:
- type [
type ]: Image variant type (size class). Supported types are:l - large (max. 365px, horizontal or vertical)s - small (115x86px)m - medium (200x133px)max4000x2667 - jumbo (max. height 4000px)
|
---|
url | string | Image variant URL. |
---|
<coordinates> - Geography coordinates |
---|
longitude | decimal | Geographical longitude. |
---|
latitude | decimal | Geographical latitude. |
---|
altitude | decimal | Geographical altitude. |
---|
<type> - Beach type |
---|
self | type | Beach type. Supported types are:sand pebble stone concrete sharp_stone riva
|
---|
Example usage
Retrieve data of place with ID 'pl-220'.
https://api.adriatic.hr/xml-service/server
?method=Geo_get
&id=pl-220
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Retrieve data of beach with ID 'be-223'.
https://api.adriatic.hr/xml-service/server
?method=Geo_get
&id=be-223
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Retrieve data of riviera with ID 'ri-17'.
https://api.adriatic.hr/xml-service/server
?method=Geo_get
&id=ri-17
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Retrieve data of region with ID 're-1'.
https://api.adriatic.hr/xml-service/server
?method=Geo_get
&id=re-1
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Retrieve geography location names. Supported location types are place, riviera and region. Method can be used for implementation of location input field with autocomplete support.
Request parameters
None
Response
<names> - Location names |
---|
self | array | Names of all available locations (except beaches). Array of <name> elements. See <name> (Location name) for details. |
---|
<name> - Location name |
---|
self | string | Element has the following attributes:
- id [
string ]: Location ID. - type [
type ]: Location type. Supported types are: - parentId [
string ]: Parent location ID.
|
---|
Example usage
Get geography location names.
https://api.adriatic.hr/xml-service/server
?method=Geo_getNames
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Search created orders (except temporary). Method is pagination aware (results are split across multiple pages).
Request parameters
q | string | Search string (case insensitive). |
---|
c_from | date | Begin of creation interval. Allowed format is YYYY-MM-DD. |
---|
c_to | date | End of creation interval. Allowed format is YYYY-MM-DD. |
---|
m_from | date | Begin of modification interval. Allowed format is YYYY-MM-DD. |
---|
m_to | date | End of modification interval. Allowed format is YYYY-MM-DD. |
---|
checkout_from | date | Begin of check out interval. Allowed format is YYYY-MM-DD. |
---|
checkout_to | date | End of check out interval. Allowed format is YYYY-MM-DD. |
---|
s | type | Status. Supported types are:new - Reservation order is successfully submitted, waiting for Adriatic.hr to process it (method Order_confirm is called)allowed - Adriatic.hr has checked the availability, confirmed the service availability, authorized and sent a pre-invoice, reservation confirmation is expecteddenied - Adriatic.hr has checked the availability, the service is not available or the reservation processing has been stoppedfailed - You aborted the reservation confirmation, the payment has not been made or the parameters have been changed before the reservation confirmationaccepted - You confirmed the reservation and Adriatic.hr confirmed it to the facility ownerpaid_advance - Your advance payment has settled to our account, we are waiting for the payment of the remaining amountpaid - Payment of the remaining amount (or the whole total amount) has settled to our account, Adriatic.hr has to authorize the voucher, or the voucher has already been authorizedfailed_paid - One of the parties canceled the reservation after the confirmationpaid_modified - There has been a change of some of the reservation parameters after the confirmation
|
---|
sort | type | Sort criterion. Supported types are:created - Creation timemodified - Modification time Default value is created . |
---|
sort_dir | type | Sort direction. Supported types are:asc - Ascendingdesc - Descending Default value is asc . |
---|
page | int | Page number. Default value is 1 . |
---|
limit | int | Number of results per page (max. 25). Default value is 10 . |
---|
Response
<list> - List data |
---|
items | array | Items on current page. Array of <item> elements. See <item> (List item data) for details. |
---|
pager | set | Set of pager elements. See <pager> (List pager data) for details. |
---|
<item> - List item data |
---|
order | set | Order data. See Order_get - <order> (Order data) for details. |
---|
<pager> - List pager data |
---|
totalItems | int | Total items that match search criteria. |
---|
totalPages | int | Total pages. |
---|
currentPage | int | Current page. |
---|
pageLimit | int | Maximum number of items per page. |
---|
Example usage
Find orders.
https://api.adriatic.hr/xml-service/server
?method=Order_find
&q=john+smith
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Create new temporary order. It should be confirmed during the ordering process. New order is empty and should be populated with order items and guest data before confirmation (closing).
Request parameters
None
Response
Same as in
{$method["response"]}
.
Example usage
Create new empty order. This is a syntax example only, this method can not be used with the test application ID supplied (for security purposes).
https://api.adriatic.hr/xml-service/server
?method=Order_create
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Retrieve order data.
Request parameters
id | int | Order ID. This parameter is required. |
---|
Response
<order> - Order data |
---|
self | n/a | Element has no value. Element has the following attributes:
|
---|
items | array | Order items. Array of <item> elements. See Order_addItem - <item> (Order item data) for details. |
---|
calc | set | Costs calculation. See <calc> (Costs calculation data) for details. |
---|
cancellationCalc | array | Cancellation calculation data. Array of <cancellationCalc> elements. See <cancellationCalc> (Cancellation calculation data) for details. |
---|
inheritedOrder | int | The order ID that replaces this one. |
---|
user | array | User data. Array of <user> elements. See <user> (User data) for details. |
---|
notes | string | User notes. Special text field which allows user to enter custom notes during (preferably at the last step) the ordering process is highly recommended for better user experience. |
---|
status | type | Order's current status. Supported types are:temp - Order is temporary - it is not finished, i. e. it has not gone through all the steps of the reservation form (method Order_confirm is not called yet)new - Reservation order is successfully submitted, waiting for Adriatic.hr to process it (method Order_confirm is called)allowed - Adriatic.hr has checked the availability, confirmed the service availability, authorized and sent a pre-invoice, reservation confirmation is expecteddenied - Adriatic.hr has checked the availability, the service is not available or the reservation processing has been stoppedfailed - You aborted the reservation confirmation, the payment has not been made or the parameters have been changed before the reservation confirmationaccepted - You confirmed the reservation and Adriatic.hr confirmed it to the facility ownerpaid_advance - Your advance payment has settled to our account, we are waiting for the payment of the remaining amountpaid - Payment of the remaining amount (or the whole total amount) has settled to our account, Adriatic.hr has to authorize the voucher, or the voucher has already been authorizedfailed_paid - One of the parties canceled the reservation after the confirmationpaid_modified - There has been a change of some of the reservation parameters after the confirmation
|
---|
makingPaymentData | set | Data for making credit card payment. See <makingPaymentData> (Data for making payment) for details. |
---|
<calc> - Costs calculation data |
---|
items | array | Costs calculation item. Array of <item> elements. See <item> (Costs calculation item data) for details. |
---|
payments | array | Payments ordered by term. Array of <payment> elements. See <payment> (Payment data) for details. |
---|
totalPrice | array | Total price amounts. Multiple amount elements in case of multiple currencies. Array of <amount> elements. See <amount> (Total price amount data) for details. |
---|
commission | float | Partner (your) commission amount. Element has the following attributes:
- currency [
string ]: Three-letter currency code (according to ISO 4217 standard) in lowercase.
|
---|
<item> - Costs calculation item data |
---|
name | string | Item's name. |
---|
unit | type | Item's unit. Empty in some cases (e.g. if the item is a discount). Supported types are:night night_person night_pet person total
|
---|
unitPrice | float | Unit price. Element has the following attributes:
- currency [
string ]: Three-letter currency code (according to ISO 4217 standard) in lowercase.
|
---|
quantity | int | Quantity. |
---|
price | float | Item's price. Element has the following attributes:
- currency [
string ]: Three-letter currency code (according to ISO 4217 standard) in lowercase.
|
---|
group | int | Index of item's group. This is not intended for display, only as a helper if the similar items should be groupped together in the final (displayed to user) costs calculation table. |
---|
<payment> - Payment data |
---|
term | datetime | Term of payment. Date-time string in YYYY-MM-DD hh:mm:ss format (ISO 8601). Time zone is Croatian - GMT+1 (+DST). |
---|
amount | float | Value. Element has the following attributes:
- currency [
string ]: Three-letter currency code (according to ISO 4217 standard) in lowercase.
|
---|
<amount> - Total price amount data |
---|
self | float | Value. Element has the following attributes:
- currency [
string ]: Three-letter currency code (according to ISO 4217 standard) in lowercase.
|
---|
<cancellationCalc> - Cancellation calculation data |
---|
name | string | Description. |
---|
amount | float | Total price amount data. Element has the following attributes:
- currency [
string ]: Three-letter currency code (according to ISO 4217 standard) in lowercase.
|
---|
commission | float | Partner (your) commission amount. Element has the following attributes:
- currency [
string ]: Three-letter currency code (according to ISO 4217 standard) in lowercase.
|
---|
<inheritedOrder> - The order that replaces this one data |
---|
id | int | Order id of the order that replaces this one. |
---|
<user> - User data |
---|
firstName | string | First name. |
---|
lastName | string | Last name. |
---|
country | string | Country name. Element has the following attributes:
- code [
string ]: Two-letter country code (according to ISO 3166-1 alpha-2 standard) in lowercase.
|
---|
email | string | E-mail address. |
---|
phones | array | Phone numbers. Array of <phone> elements. See <phone> (Phone data) for details. |
---|
<phone> - Phone data |
---|
self | string | Phone number. |
---|
<makingPaymentData> - Data for making payment |
---|
amount | float | Value. Element has the following attributes:
- currency [
string ]: Three-letter currency code (according to ISO 4217 standard) in lowercase.
|
---|
requestCode | string | Our custom parameter which describes the payment. Needs to be forwarded to payment provider. |
---|
orderDescription | string | Description of service consumer is paying for. Must not contain any special characters or line breaks |
---|
confirmUrl | string | Url for server-to-server communication. Payment provider sends return values containing the result of the payment process to this link. |
---|
paymentUrl | string | Link for credit card payment. |
---|
Example usage
Retrieve data of order with ID 1234. This is a syntax example only, this method can not be used with the test application ID supplied (for security purposes).
https://api.adriatic.hr/xml-service/server
?method=Order_get
&id=1234
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Confirm existing order. Should be called at the end of the ordering process.
Request parameters
id | int | Order ID. This parameter is required. |
---|
Response
No data is returned.
Example usage
Confirm order with ID 1234. This is a syntax example only, this method can not be used with the test application ID supplied (for security purposes).
https://api.adriatic.hr/xml-service/server
?method=Order_confirm
&id=1234
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Cancel existing temporary order. Should be called if the order is not accepted (guest changes his mind during the ordering process).
Request parameters
id | int | Order ID. This parameter is required. |
---|
Response
No data is returned.
Example usage
Cancel order with ID 1234. This is a syntax example only, this method can not be used with the test application ID supplied (for security purposes).
https://api.adriatic.hr/xml-service/server
?method=Order_cancel
&id=1234
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Set guest data. Guest data are required to be set before order confirmation.
Request parameters
id | int | Order ID. This parameter is required. |
---|
fn | string | First name. This parameter is required. |
---|
ln | string | Last name. This parameter is required. |
---|
c | string | Two-letter country code (according to ISO 3166-1 alpha-2 standard) in lowercase. This parameter is required. |
---|
e | string | E-mail address. Required only if phone number is not given. |
---|
p | string | Phone number. Required only if e-mail address is not given. |
---|
Response
No data is returned.
Example usage
Set guest data for order with ID 1234. This is a syntax example only, this method can not be used with the test application ID supplied (for security purposes).
https://api.adriatic.hr/xml-service/server
?method=Order_setGuest
&id=1234
&fn=John
&ln=Smith
&c=fr
&e=john%40smith.xx
&p=%2B123+45+678-900
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Add new order item.
Request parameters
order_id | int | Order ID. This parameter is required. |
---|
t | type | Item type. Sole supported type is: This parameter is required. |
---|
u | list | Comma delimited list of accommodation unit IDs. One or more accommodation units of the same house are supported only. Example: "1868,1869". This parameter is required. |
---|
i_from | date | Begin of interval. Allowed format is YYYY-MM-DD. This parameter is required. |
---|
i_to | date | End of interval. Allowed format is YYYY-MM-DD. This parameter is required. |
---|
p | int | Number of persons. This parameter is required. |
---|
p_age | list | Comma delimited list of number of persons per age range. Four age ranges exist and number of persons must be given for all of them (even if it is zero), in the following order: above 18, 12 to 18, 4 to 12 and under 4. Example: "4,0,2,0". This parameter is required. |
---|
p_unit | list | Comma delimited list of number of persons per accommodation unit. List is 2-dimensional - list item is a semicolon delimited pair of accommodation unit ID and number of persons. This parameter in required only if more then one accommodation unit is chosen. Example: "1868;7,1869;6". |
---|
pet | int | Number of pets. This parameter is required. |
---|
pet_desc | string | Pets description. Special text field which allows user to enter pets description is highly recommended for more efficient ordering process. |
---|
food | type | Food service type. Supported types are:breakfast halfboard fullboard
|
---|
Response
<item> - Order item data |
---|
self | n/a | Element has no value. Element has the following attributes:
- id [
int ]: Order item ID. - type [
type ]: Item type. Sole supported type is:
|
---|
units | array | Accommodation units. Array of <unit> elements. See <unit> (Accommodation unit data) for details. |
---|
person | set | Number of persons data. See <person> (Number of persons data) for details. |
---|
interval | set | Date interval data. See <interval> (Date interval data) for details. |
---|
petCount | int | Number of pets. |
---|
petDesc | string | Pets description. |
---|
food | type | Food type. Supported types are:breakfast halfboard fullboard
|
---|
<unit> - Accommodation unit data |
---|
self | string | Accommodation unit name. Element has the following attributes:
- id [
int ]: Accommodation unit ID.
|
---|
<person> - Number of persons data |
---|
count | int | Total number of persons. |
---|
ages | array | Number of persons per age range. Array of <age> elements. See <age> (Number of person per age range data.) for details. |
---|
units | array | Number of persons per accommodation unit. Array of <unit> elements. See <unit> (Number of person per accommodation unit data.) for details. |
---|
<interval> - Date interval data |
---|
from | date | Begin of interval. Date string in YYYY-MM-DD format (ISO 8601). Time zone is Croatian - GMT+1 (+DST). |
---|
to | date | End of interval. Date string in YYYY-MM-DD format (ISO 8601). Time zone is Croatian - GMT+1 (+DST). |
---|
<age> - Number of person per age range data. |
---|
self | int | Number of persons. Element has the following attributes:
- type [
type ]: Age range type. Supported types are:18- - over 18 years12-18 - 12 to 18 years4-12 - 4 to 12 years-4 - under 4 years
|
---|
<unit> - Number of person per accommodation unit data. |
---|
self | int | Number of persons. Element has the following attributes:
- id [
int ]: Accommodation unit ID.
|
---|
Example usage
Add new private accommodation order item to order with ID 1234. Order item contains two accommodation units in interval from 2024-07-21 to 2024-07-28, 13 persons and no pets. This is a syntax example only, this method can not be used with the test application ID supplied (for security purposes).
https://api.adriatic.hr/xml-service/server
?method=Order_addItem
&order_id=1234
&t=private_units
&u=1868%2C1869
&i_from=2024-07-21
&i_to=2024-07-28
&p=13
&p_age=7%2C2%2C3%2C1
&p_unit=1868%3B7%2C1869%3B6
&pet=0
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Remove existing order item.
Request parameters
id | int | Order item ID. This parameter is required. |
---|
order_id | int | Order ID. This parameter is required. |
---|
Response
No data is returned.
Example usage
Remove order item with ID 1 from order with ID 1234. This is a syntax example only, this method can not be used with the test application ID supplied (for security purposes).
https://api.adriatic.hr/xml-service/server
?method=Order_removeItem
&id=1
&order_id=1234
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Set user's custom notes.
Request parameters
id | int | Order ID. This parameter is required. |
---|
notes | string | User's notes. This parameter is required. |
---|
Response
No data is returned.
Example usage
Set user's notes for order with ID 1234. This is a syntax example only, this method can not be used with the test application ID supplied (for security purposes).
https://api.adriatic.hr/xml-service/server
?method=Order_setNotes
&id=1234
¬es=Hello+world
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Retrieve method text.
Request parameters
m | type | Method name. Supported types are:Geo_find Geo_get Geo_getNames Private_find Private_findReviews Private_getHouse Private_getUnit Private_getAvailStatus Private_getUnavailDates Order_get Order_addItem Order_setNotes This parameter is required. |
---|
Response
<text> - Text data |
---|
self | n/a | Element has no value. Element has the following attributes:
- method [
string ]: Method name.
|
---|
params | array | Method parameters with associated text. Array of <param> elements. See <param> (Method parameter data) for details. |
---|
nodes | array | Method response XML nodes with associated text. Array of <node> elements. See <node> (Method response XML node data) for details. |
---|
types | array | Types with associated text. Array of <type> elements. See <type> (Type data) for details. |
---|
<param> - Method parameter data |
---|
self | string | Parameter text. Element has the following attributes:
- name [
string ]: Parameter name.
|
---|
<node> - Method response XML node data |
---|
self | string | Node text. Element has the following attributes:
- path [
string ]: XPath path.
|
---|
<type> - Type data |
---|
params | array | Method parameters which use this type. Array of <param> elements. See <param> (Method parameter name) for details. |
---|
nodes | array | Method response XML nodes which use this type. Array of <node> elements. See <node> (Method response XML node path) for details. |
---|
options | array | Type options. Array of <option> elements. See <option> (Type option data) for details. |
---|
<param> - Method parameter name |
---|
self | string | Parameter name. |
---|
<node> - Method response XML node path |
---|
self | string | XPath path. |
---|
<option> - Type option data |
---|
self | string | Option text. Element has the following attributes:
- name [
string ]: Option name.
|
---|
Example usage
Retrieve text of method Geo_find.
https://api.adriatic.hr/xml-service/server
?method=System_getText
&m=Geo_find
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Retrieve text of method Geo_get.
https://api.adriatic.hr/xml-service/server
?method=System_getText
&m=Geo_get
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Retrieve text of method Private_find.
https://api.adriatic.hr/xml-service/server
?method=System_getText
&m=Private_find
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Retrieve text of method Private_findReviews.
https://api.adriatic.hr/xml-service/server
?method=System_getText
&m=Private_findReviews
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Retrieve text of method Private_getHouse.
https://api.adriatic.hr/xml-service/server
?method=System_getText
&m=Private_getHouse
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Retrieve text of method Private_getUnit.
https://api.adriatic.hr/xml-service/server
?method=System_getText
&m=Private_getUnit
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Retrieve text of method Private_getAvailStatus.
https://api.adriatic.hr/xml-service/server
?method=System_getText
&m=Private_getAvailStatus
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Retrieve text of method Private_getUnavailDates.
https://api.adriatic.hr/xml-service/server
?method=System_getText
&m=Private_getUnavailDates
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Retrieve text of method Order_get.
https://api.adriatic.hr/xml-service/server
?method=System_getText
&m=Order_get
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Retrieve text of method Order_addItem.
https://api.adriatic.hr/xml-service/server
?method=System_getText
&m=Order_addItem
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Retrieve text of method Order_setNotes.
https://api.adriatic.hr/xml-service/server
?method=System_getText
&m=Order_setNotes
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Retrieve error text translation.
Request parameters
code | int | Error code. This parameter is required. |
---|
Response
<error> - Error data |
---|
message | text | Translated error message. Element has the following attributes:
|
---|
Example usage
Retrieve error message translation for error code 200.
https://api.adriatic.hr/xml-service/server
?method=System_getError
&code=200
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW
Retrieve error message translation for error code 217.
https://api.adriatic.hr/xml-service/server
?method=System_getError
&code=217
&lang=sl
&aid=YOUR_AID
&sig=SIGNATURE_GENERATED_BY_YOU
PREVIEW