Property calendar (availability)

Introduction

This page describes the information in the calendar endpoint. For availability searching see Performing a property search page.

The calendar endpoint

The calendar resource of a property reveals its availability status for each day. This can be found at http://APIROOT/property/PROPREF_BC/calendar.

This endpoint has date objects which can have three fields:

• available
• availabilityCode
• changeoverDay
• fromTo

available and changeoverDay are self explanatory, however the availabilityCode and fromTo are not. See next section for more information.

Availability codes

• B = Booked by a customer - fully paid
• O = Owner Booking
• F = Booked by customer - Long term Booking
• S = Short break booked by customer - fully paid
• P = Provisional booking by customer - no payment
• Q = Provisional short break by customer - no payment
• D = Customer Booking - deposit paid
• H = Period has been temporarily held
• W = Customer web booking
• K = Cancelled booking. Period is available.
• _ = Period is available
• A = Cancelled provisional booking
• AC = Cancelled confirmed booking

fromTo

Indicates whether the a holiday may start or end on the date. Only used where changeoverDay is True. Options are:

• NONE = A booking may not START or END on this date
• FROM = A booking may START, but not END on this date
• TO = A booking may END but not START on this date
• BOTH = A booking may START or END on this date