Summary API

Invoking the Summary API

The Summary API is where your data integration with Bookerville's API starts. It provides a list of all the Bookerville properties that are participating in the API with your organization.

The URL to use for invoking the Summary API is:
https://www.bookerville.com/API-PropertySummary?s3cr3tK3y=1234567890ABCDEFGHIJKLMNOPQRS

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.

Optional: you may also pass in optional sorting parameters:
 sortField - if passed, must be set to dateBooked (the only field supported for sorting at this point)
 sortOrder - if passed, must be set to ASC (for ascending) or DESC (for descending)

Example: https://www.bookerville.com/API-PropertySummary?s3cr3tK3y=1234567890ABCDEFGHIJKLMNOPQRS&sortField=dateBooked&sortOrder=ASC

This would cause the results to be sorted in order of last date booked.

Summary API Results

The results of a successful Summary API call will appear as the following example XML:
<PropertySummary> <Property property_id="19" bkvAccountId="1" last_update="2015-04-08 10:09:02" property_details_api_url="https://www.bookerville.com/API-PropertyDetails?bkvPropertyId=19" /> <Property property_id="488" bkvAccountId="1" last_update="2014-07-12 09:36:55" property_details_api_url="https://www.bookerville.com/API-PropertyDetails?bkvPropertyId=488" /> <Property property_id="261" bkvAccountId="1" last_update="2015-03-13 16:05:40" property_details_api_url="https://www.bookerville.com/API-PropertyDetails?bkvPropertyId=261" /> </PropertySummary>

Each stanza contains a property_id which is an integer that is the primary identifier for the property within Bookerville. Your software should record this somewhere and associate it with that property in your system, as it will be needed for other API calls for that property.

Each stanza also contains a bookerville account id, which may be useful for your other API calls. Each also includes a last-update, and a property_details_api_url, which is the base URL to use for making calls to the Property Details API.

Note that the property_details_api_url does not contain your "s3cr3tK3y" parameter; you must either append this to the URL or (preferrably) POST it as a (form) key-value pair when invoking the Property Details API.

Summary API Errors

The results of the Summary 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.