Characteristics
A guest review can vary heavily in terms of details of information. It may be just a score or a whole survey of questions. That information will be included as the content of a request.
Functionality
Typically, only the information from the review should be forwarded to the customer. For this only the functionality message_import is needed.
Setup Request Type
For getting the core information of the request, at least the overall score should be submitted in the title of the request.
The link to the request in the partner’s backend should be submitted as well.
The information of the review should be imported via content:
PUT /setup/requests
{
"type":"reviewDetail",
"labelForCustomer":{
"de_DE":"Gastbewertung",
"en_US":"Guest review"
},
"content":"true",
"link":"true",
"title":"true",
"referenceID":"false",
"attachements":"false",
"enabledByDefault":"true",
"text":"false"
}
Enable Request
Before sending requests to a client, the requestType must be enabled for the respective client.
PUT /setup/customer
{
"enabledRequests":["reviewDetail"]
}
Request Import
Survey
In this case the partner has several surveys that can be imported. Therefore, the name of the survey will be added to the title as well.
The questions of the survey will be imported as a list.
POST /requests?type=reviewDetail
{
"title":"How happy are you with the documentation: 5.38",
"link":"https://hotelkit.net/review/538",
"content":{
"Date":"07.08.2018",
"Guest":"Stephan Lange",
"Do you recommend":"Yes",
"Score":"5.38",
"Questions":{
"Were you able to create the correct signature?": "5.00",
"Did you learn how to set up the webhook?": "5.00",
"Did you change the status of an item?": "6.00"
}
}
}