v1

latestOpenAPI 3.0.1Apache 2.02026-07-2473111182.6 KB
Review

Retrieve a review

Get a review for the specified business id, branch id and review id

get/api/business/{businessId}/branch/{branchId}/review/{reviewId}

Path parameters

businessIdstring required
branchIdstring required
reviewIdstring required

Response

Specified review retrieved

reviewIdstring
clientIdstring
clientFirstNamestring
clientLastNamestring
reviewDatestring
visitDatestring
staffIdstring
staffFirstNamestring
staffLastNamestring
textstring
ratinginteger
facebookReviewboolean
twitterReviewboolean

Example response

{
  "reviewId": "r12434",
  "clientId": "ab123",
  "clientFirstName": "John",
  "clientLastName": "Doe",
  "reviewDate": "2017-01-19",
  "visitDate": "2020-10-23",
  "staffId": "xyz321",
  "staffFirstName": "Joe",
  "staffLastName": "Bloggs",
  "text": "Great Service",
  "rating": 5,
  "facebookReview": true
}