Reviews

  1. List reviews
  2. Get a single review
  3. Create a new review

Parameters

Name Type Read/Write Description
id Integer Read Review’s id.
comment Text Read Review’s comment.
country_code String Read Reviewer’s country code.
name String Read Reviewer’s name, cropped to show only the initial of the last name.
rating Integer Read Review’s rating.
title String Read Review’s title.
created_at Time Read Review’s create time.
updated_at Time Read Review’s update time.
Name Type Read/Write Description
id Integer Read Review’s id.
comment Text Read/Write Required. Review’s comment. (10 min, 2000 max characters)
country_code String Read Reviewer’s country code. e.g: FR
name String Read Reviewer’s name, cropped to show only the initial of the last name.
rating Integer Read/Write Required. Review’s rating. (between 1 and 6)
title String Read/Write Review’s title. (3 min, 100 max characters)
created_at Time Read Review’s create time.
updated_at Time Read Review’s update time.

List reviews

List all reviews for a given account(s).

GET /reviews

Response

{
  "links": {
    "reviews.booking": "https://www.bookingsync.com/api/v3/bookings/{reviews.booking}",
    "reviews.rental": "https://www.bookingsync.com/api/v3/rentals/{reviews.rental}"
  },
  "reviews": [
    {
      "id": 1,
      "comment": "It was awesome!",
      "country_code": "FR",
      "name": "John S.",
      "rating": 5,
      "title": "Awesome",
      "created_at": "2017-11-09T09:08:18Z",
      "updated_at": "2017-11-09T09:08:18Z",
      "links": {
        "booking": 4,
        "rental": 87
      }
    }
  ]
}

Get a single review

Returns a single review identified by ID.

GET /reviews/:review_id

Response

{
  "links": {
    "reviews.booking": "https://www.bookingsync.com/api/v3/bookings/{reviews.booking}",
    "reviews.rental": "https://www.bookingsync.com/api/v3/rentals/{reviews.rental}"
  },
  "reviews": [
    {
      "id": 1,
      "comment": "It was awesome!",
      "country_code": "FR",
      "name": "John S.",
      "rating": 5,
      "title": "Awesome",
      "created_at": "2017-11-09T09:08:18Z",
      "updated_at": "2017-11-09T09:08:18Z",
      "links": {
        "booking": 4,
        "rental": 87
      }
    }
  ]
}

Create a new review

Creates a review for given booking.

POST /bookings/:booking_id/reviews

Example JSON request

{
  "reviews": [
    {
      "comment": "It was awesome!",
      "rating": 5,
      "title": "Awesome"
    }
  ]
}

Response

{
  "links": {
    "reviews.booking": "https://www.bookingsync.com/api/v3/bookings/{reviews.booking}",
    "reviews.rental": "https://www.bookingsync.com/api/v3/rentals/{reviews.rental}"
  },
  "reviews": [
    {
      "id": 1,
      "comment": "It was awesome!",
      "country_code": "FR",
      "name": "John S.",
      "rating": 5,
      "title": "Awesome",
      "created_at": "2017-11-09T09:08:18Z",
      "updated_at": "2017-11-09T09:08:18Z",
      "links": {
        "booking": 4,
        "rental": 87
      }
    }
  ]
}