Get all unit data (= holiday homes) except availabilities (including names, addresses, descriptions, images, prices and booking-restrictions).

 

Action name: getUnits

 

Optional parameters:

 

parameterdescriptionvalue
pricesinclude pricestrue
offersinclude offerstrue
restrictionsinclude booking-restrictionstrue
facilitiesinclude facilities or list only facilitiestrue = include OR exclusive
ratingsaverage ratings (1-5)true
feedbackslist of text feedbackstrue
updatedSinceshow only entries, that have been updated since this datee.g. 2015-06-05T09:53:43Z

 

NOTE: The maximum number of results is currently 128 (may vary). If there are more units, the result will contain a field called "lastid". You will need to include it as parameter for subsequent calls to get the next chunk of results.

 

NOTE: There is another representation of the booking-restrictions: changeOver and minStay for action 'getAvailabilities'. Please request either this one OR the other.

 

Sample result:

{units: [ {
    _id: 23423,      info: {...},     prices: {...},     offers: {...},     restrictions: {...},     currency: 'EUR' }, {
   _id: 23424,    ....,   }
]}

 

Info

 

fielddescriptiontype
facilityfacility id (Facilities combine units located in one house or at one site.
For example a holiday apartment house is one facility.)
 
isfacilitywhether this entry is a facility or a unit 
codeinternal name of the unit 
type

one of HOUSE, FLAT, ROOM, PRIVAT, MOBILEHOME, YACHT in case of a unit
or HOUSE_FAC, FLAT_FAC, HOTEL, HOSTEL, FARM, CAMPGROUND in case of a facility

 
deposit C
depositLocationone of ON_INVOICE, ON_SITE 
bookableone of DIRECTLY, REVERSED, REVERSED_OPT, INQUIRY_CAL, INQUIRY_NO_CAL 
regionthe id of the region and the indexSET
regionName ML
locLocation (longitude latitude)GeoJSON
fullNamename including facility name (in the language of the customer)S
name ML
facilityName ML
address SET
urldirect link to unit on vOffice HomepageML
picsOrderone of FAC_PICS_FIRST, FAC_PICS_LAST, NO_FAC_PICS 
imagessee below 
roomDetailslist of rooms including list of beds 

NOTE: In addition to these fields, all descriptions and properties can be exported (need to be activated in the api-key). You can get a list of all possible properties:

https://api.v-office.com/export/properties
This will show a list of all properties that are valid for all customers.

https://api.v-office.com/export/properties?key=[key]
This will show a list of all properties (global and user-defined), that are actually beeing exported for the given api-key. If you want to see the complete list of possible properties add &all=true

Images

You can find the images under the following url:

Medium size (600x400): https://dyn.v-office.com/image/m/[imageId].jpg
XL (1440): https://dyn.v-office.com/image/xl/[imageId].jpg
XXL (2048): https://dyn.v-office.com/image/xxl/[imageId].jpg

 

Prices

Field

Description

service

service id

value

price in cents

ask

used to sort the price table

type

one of RENT, FINALCLEANING, LINEN, HANDTOWELS, PET, CRIB, HIGHCHAIR, BABYBED, TRANSFER, VTAX, HEATING, GAS, WATER, ELECTRICITY, INSURANCE, CANCELLATION

season

name of the season

condition

price is only valid if condition is met

fromdate

 

tilldate

 

 

Offers

Field

Description

name

 

validfrom

the arrival may not be before this day

validtill

the departure may not be after this day

minStay

special offer is only valid if the customer stays at least this long

type

'EARLYBIRD','LASTMINUTE'

timeSpan

if type=’EARLYBIRD’: the arrival has to be at least this far ahead

if type=’LASTMINUTE’: the arrival may not be more than this ahead

discountType

'XY','PERCENT'

value

if discountType=’XY’: the number of days that have to be paid for. So minStay-value days are free.

if discountType=’Percent’:discount in percent

servicesids of the services this discount is applied to


Restrictions

Field

Description

fromdate

 

tilldate

 

minimumStay

during the specified period, a booking has to be at least this long

minimumGap

in order to prevent gaps that are too small to be booked, it is possible to specify a minimum gap between the arrival and the departure of the preceding guest. Applies only if the arrival is not on the same day as the preceding departure.

fillGaps

if specified, these restrictions are ignored if an existing gap can be closed.

days

if specified the arrival and departure has to be on these days

Exception: The arrival is on an existing departure or the departure is on an existing arrival respectively (may occur if there is a manually entered booking)