Availability API

Invoking the Availability API

The Availability API provides current and future blocked calendar dates for a Bookerville property, enabling your organization to see what dates are available. It also provides some useful data about each booking.

The URL to use for invoking the Availability API is:
https://www.bookerville.com/API-PropertyAvailability?s3cr3tK3y=1234567890ABCDEFGHIJKLMNOPQRS&bkvPropertyId=19

You will of course replace the "s3cr3tK3y" parameter with your own Bookerville API access token. If you don't have one, you may apply for one here: Request API Token

Note: for testing purposes it is fine to pass your API access token using simple query string parameters in the URL as in the sample above. Once you have completed testing, it is far better to pass it as an HTTP POST (form) parameter instead, because that is more secure.

The bkvPropertyId parameter must be an integer and is the unique identifier for the property within Bookerville. This value is obtained from the Summary API.

Availability API Results

The results of a successful Availability API call will appear as the following example XML:
<Property property_id="19" last_update="2015-04-27 03:41:27"> <Availability> <BookedStays property_id="19"> <BookedStay> <ArrivalDate>2015-10-09</ArrivalDate> <DepartureDate>2015-10-13</DepartureDate> <bkvBookingURL>http://www.bookerville.com/BookingDetails?confirmCode=19-627617-20151009</bkvBookingURL> </BookedStay> <BookedStay> <ArrivalDate>2015-10-15</ArrivalDate> <DepartureDate>2015-10-19</DepartureDate> <bkvBookingURL>http://www.bookerville.com/BookingDetails?confirmCode=19-627603-20151015</bkvBookingURL> </BookedStay> </BookedStays> </Availability>

Note: a missing XML field, or a field which has nothing in it, should not be interpretted as "deleting" the existing value in your system, nor overwriting it with blank, null, or zero. If we want to communicate a delete, or overwrite with blank, etc. then it will be positively expressed as such in the XML feed. Best practice for missing or empty XML fields is to simply ignore them - take no action updating your data for it.

<bkvBookingURL>: This field contains the URL to the unique Bookerville Dashboard page for the booking. Your customers will find it very helpful if you render this as a link inside your organization's Dashboard for them, so that they can simply click to view the details in their Bookerville account.

Availability API Errors

The results of the Availability API may contain one or more error stanzas, which are designed to help you debug issues.

Example:
<error>API access token not found</error>

Note that <error> and <warning> stanzas may appear in-line with other XML content. Explanations will be given inside each stanza.