Show Reviews

POST

/api/managing-entity/{managingEntityIdentifier}/extranet/review/grid

const url = 'https://api.wink.travel/api/managing-entity/hotel-1/extranet/review/grid';
const options = {
  method: 'POST',
  headers: {'Wink-Version': '2.0', 'Content-Type': 'application/json'},
  body: '{"skip":0,"take":30,"sort":"","filter":"","group":""}'
};

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/managing-entity/hotel-1/extranet/review/grid \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data '{ "skip": 0, "take": 30, "sort": "", "filter": "", "group": "" }'

Retrieve a paginated list of reviews for specified property

Parameters

Path Parameters

managingEntityIdentifier

required

string

Show reviews for hotel with this identifier

Example

hotel-1

Header Parameters

Wink-Version

string

default: 2.0.0

Allowed values: 2.0

Request Body^required

application/json

object

skip

Number of records to be skipped by the pager.

integer format: int32

Example

take

Number of records to take.

integer format: int32

default: 30 >= 1 <= 180

Example

sort

Descriptors used for sorting result set.

Array<object>

object

dir

Descriptors used for sorting result set

string

Allowed values: asc desc

Example

asc

field

Data set field to sort on

string

Example

hotel.name

filter

Descriptors used for filtering result set

object

logic

Whether to filter inclusively or exclusively

string

Allowed values: and or

Example

and

filters

Descriptors used for filtering the result set

Array<object>

object

field

required

Field name to filter on

string

"" >= 1 characters

Example

hotel.name

operator

required

Filter operator to use on field

string

Allowed values: neq eq contains doesnotcontain isnull isnotnull isempty isnotempty startswith endswith gte lte gt lt in nin

Example

startsWith

value

Value to filter dataset against

Example

Happy Res

ignoreCase

Make filter comparison case insensitive. Default: Case sensitive

boolean

Example

true

group

Descriptors to group result sets by.

Array<object>

object

field

Field to group data set on

string

Example

createdDate

dir

Group sort direction

string

Allowed values: asc desc

Example

asc

aggregates

Primitive aggregate data points

Array<object>

object

field

Field to run aggregate function on

string

Example

hotel.bookings

aggregate

Aggregate function

string

Allowed values: count sum average min max

Example

count

Responses

200

application/json

object

totalPages

integer format: int32

totalElements

integer format: int64

size

integer format: int32

content

Array<object>

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

number

integer format: int32

numberOfElements

integer format: int32

sort

object

empty

boolean

unsorted

boolean

sorted

boolean

first

boolean

last

boolean

pageable

object

offset

integer format: int64

sort

object

empty

boolean

unsorted

boolean

sorted

boolean

pageSize

integer format: int32

paged

boolean

pageNumber

integer format: int32

unpaged

boolean

empty

boolean

Example

{
  "content": [
    {
      "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

{}

Show Reviews

Parameters

Path Parameters

Example

Header Parameters

Request Body required

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Responses

200

Example

400

Example generated

401

403

500

Example generated

Request Body^required

Example ^generated

Example ^generated