Guest Reviews API

Invoking the Guest Reviews API for a Single Property

https://www.bookerville.com/API-GuestReviews?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.

 

Invoking the Guest Reviews API for All Properties in a Bookerville Account

https://www.bookerville.com/API-GuestReviews?s3cr3tK3y=1234567890ABCDEFGHIJKLMNOPQRS&bkvAccountId=1

The bkvAccountId parameter must be an integer and is the unique identifier for the account within Bookerville. This value must be obtained by asking Bookerville staff for it Contact Us.

Guest Reviews API Results

The results of a successful Guest Reviews API call will appear as the following example XML:
<BKV-API-GuestReviews-Response> <status>success</status> <guestReview> <propId>19</propId> <propName>Soledad Mansion</propName> <score>4.9</score> <title>Fantastic!</title> <guestComments>We loved it, highly recommend to anyone wanting a beautiful view of LaJolla Shores beach and ocean!</guestComments> <managerResponse>Thank you, we are so glad you enjoyed your stay!</managerResponse> <datePosted>yyyy-mm-dd</datePosted> <bookingStartDate>yyyy-mm-dd</bookingStartDate> <bookingEndDate>yyyy-mm-dd</bookingEndDate> <guestFirstName>Joe</guestFirstName> <guestLastName>Smith</guestLastName> </guestReview> </BKV-API-GuestReviews-Response>

<status>: This field will either contain "success" or "failure". If "failure", look for <error> stanzas for help in resolving the issue.

Guest Reviews API Exceptions

The results of the Guest Reviews API may contain <error> stanzas or <warning> stanzas which are designed to help you debug issues. <error> stanzas are fatal, and a "failure" will be returned. <warning> stanzas are not fatal.

Examples:
<error>API access token not found</error> <error>Property 12345 'Sand Castle' is not participating in the API with <your organization name>. Cannot continue</error> <error>Account 12345 is not participating in the API with <your organization name>. Cannot continue</error>

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