Submit Review

POST

/api/booking/{bookingIdentifier}/review

const url = 'https://api.wink.travel/api/booking/example/review';
const options = {
  method: 'POST',
  headers: {'Wink-Version': '2.0', 'Content-Type': 'application/json'},
  body: '{"answers":[""],"messageFromGuest":"","imageIdentifier":"","text":"","roomNumber":"","roomRating":""}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.wink.travel/api/booking/example/review \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data '{ "answers": [ "" ], "messageFromGuest": "", "imageIdentifier": "", "text": "", "roomNumber": "", "roomRating": "" }'

Submit review for booking

Parameters

Path Parameters

bookingIdentifier

required

string

Header Parameters

Wink-Version

string

default: 2.0.0

Allowed values: 2.0

Request Body^required

application/json

object

answers

required

List of user review answers.

Array<object>

>= 1 items <= 2147483647 items

object

questionIdentifier

required

Question identifier

string format: uuid

"" >= 1 characters

category

required

Question category

string

Allowed values: COMFORT CONDITION SERVICE ENVIRONMENT FACILITIES LOCATION LIFESTYLE VALUE FOOD ROOM

sort

required

Sort key

integer format: int32

value

required

Value

integer format: int32

messageFromGuest

Private message from guest to the hotel. Is not displayed on property profile.

string

Example

Dear GM, I would like to say thank you so much for taking the time to show my husband and I around the premises and the secret cave behind the property.

imageIdentifier

Reviewer can upload her best picture from the property. Cloudinary image identifier.

string

Example

cloudinary-image-1

text

Free text record created by traveler

string

Example

Our stay was amazing! Can recommend highly to all. Felt like home.

roomNumber

Guest’s room number during their stay.

string

Example

roomRating

Guest’s room rating

integer format: int32

Example

Responses

201

Created

application/json

object

Document UUID

string

createdDate

Datetime this record was first created

string format: date-time

lastUpdate

Datetime this record was last updated

string format: date-time

version

Version property that shows how many times this document has been persisted. Document will not persist if the version property is less than current version property in the system. Result in an optimistic locking exception.

integer format: int64

bookingIdentifier

Booking identifier identifier booking this review is associated with.

string format: uuid

hotelIdentifier

Hotel identifier this booking is associated with.

string format: uuid

user

User details of creator of booking.

object

userIdentifier

User identifier

string format: uuid

firstName

First name

string

lastName

Last name

string

email

string format: email

telephone

Telephone

string

fullName

Full name

string

reviewDate

Date of review.

string format: date-time

averageScore

Total points divided by number of questions.

number format: double

answers

List of user review answers.

Array<object>

object

questionIdentifier

required

Question identifier

string format: uuid

"" >= 1 characters

category

required

Question category

string

Allowed values: COMFORT CONDITION SERVICE ENVIRONMENT FACILITIES LOCATION LIFESTYLE VALUE FOOD ROOM

sort

required

Sort key

integer format: int32

value

required

Value

integer format: int32

messageFromGuest

Private message from guest to the hotel. Is not displayed on property profile.

string

responseFromHotel

Property can response to traveler review. Response goes on public review profile and can be seen by others.

string

imageIdentifier

Reviewer can upload her best picture from the property. Cloudinary image identifier.

string

text

Free text record created by traveler

string

approvedText

Hotel allows the review text to be displayed as part of their profile.

boolean

approvedImage

Hotel allows the user-generated image to be displayed as part of their profile.

boolean

likes

List of member identifiers who liked the textual review

Array<string>

roomNumber

Guest’s room number during their stay.

string

roomRating

Guest’s room rating

integer format: int32

responded

Returns true if property has responded to the review given by the guest.

boolean

Example

{
  "id": "",
  "createdDate": "",
  "lastUpdate": "",
  "version": "",
  "bookingIdentifier": "",
  "hotelIdentifier": "",
  "user": "",
  "reviewDate": "",
  "averageScore": "",
  "answers": [
    ""
  ],
  "messageFromGuest": "",
  "responseFromHotel": "",
  "imageIdentifier": "",
  "text": "",
  "approvedText": false,
  "approvedImage": false,
  "likes": [
    ""
  ],
  "roomNumber": "",
  "roomRating": "",
  "responded": false
}

400

Bad Request

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

Example ^generated

{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  }
}

401

Unauthorized

*/*

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

403

Forbidden

*/*

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

500

Internal Server Error

object

Example ^generated

{}

Submit Review

Parameters

Path Parameters

Header Parameters

Request Body required

Example

Example

Example

Example

Example

Responses

201

Example

400

Example generated

401

403

500

Example generated

Request Body^required

Example ^generated

Example ^generated