Create Review entity.

POST/api/reviews/

POSTRequest

import { RecranetApiClient } from "@recranet/sdk";

const client = new RecranetApiClient({ apiKey: process.env.RECRANET_API_KEY! });

const result = await client.reviews.create({
  reservation: 0,
  token: "<token>",
  organization: 0,
});

Responses

Response 200

Successful response

application/json

Example responseGenerated from schema

{
  "id": 0,
  "date": "date",
  "score": "score",
  "locale": "locale",
  "created": "created",
  "aspectScores": [
    {
      "id": 0,
      "score": "score",
      "aspect": {
        "id": 0,
        "active": true,
        "aspectSpecification": {}
      },
      "aspectSpecification": {
        "id": 0,
        "locale": "locale",
        "type": "location",
        "name": "name"
      }
    }
  ],
  "comments": [
    {
      "id": 0,
      "created": "created",
      "review": {
        "id": 1000
      },
      "body": "body",
      "sent": "sent",
      "public": true,
      "modified": "modified"
    }
  ],
  "accommodation": {
    "id": 0,
    "title": "title",
    "slug": "slug",
    "position": 0,
    "locale": "locale",
    "content": {
      "id": 0,
      "title": "Zandsteeg 58",
      "metaTitle": "Zandsteeg 58",
      "locale": "locale",
      "subtitle": "Mooi vakantiehuis in Zoetewater",
      "excerpt": "Een geheel gerenoveerd vakantiehuis net buiten het dorp, maar nog altijd maar op 400m van het strand.",
      "description": "description",
      "iframeUrl": "https://www.youtube.com/embed/aqz-KE-bpKQ?modestbranding=1&controls=0",
      "energyLabelEnabled": true,
      "energyLabel": "A++++",
      "customFacilities": [
        "Woonkamer met houtkachel",
        "Groot atelier in de aangrenzende schuur",
        "Badkamer met douche, 2 aparte toiletten"
      ]
    },
    "reference": "reference",
    "address": "address",
    "postalCode": "postalCode",
    "locality": "locality",
    "municipality": 0,
    "region": "region",
    "country": "country",
    "latitude": "latitude",
    "longitude": "longitude",
    "numOfBedrooms": 0,
    "numOfBeds": 0,
    "numOfBathrooms": 0,
    "minNumOfPersons": 0,
    "maxNumOfPersons": 0,
    "maxNumOfPets": 0,
    "minNumOfDays": 0,
    "maxNumOfDays": 0,
    "area": "area",
    "governmentRegistrationNumber": "governmentRegistrationNumber",
    "regionalRegistrationNumber": "regionalRegistrationNumber",
    "active": true,
    "public": true,
    "featured": false,
    "created": "created",
    "modified": "modified",
    "houseCode": "houseCode",
    "petsAllowed": true,
    "localityCategory": {
      "id": 0,
      "name": "name",
      "locale": "locale",
      "displayName": "displayName",
      "excerpt": "excerpt",
      "disclaimer": "disclaimer",
      "description": "description",
      "address": "address",
      "postalCode": "postalCode",
      "locality": "locality",
      "municipality": 0,
      "region": "region",
      "country": "country",
      "latitude": "latitude",
      "longitude": "longitude",
      "public": true,
      "root": {
        "id": 1000
      },
      "parent": {
        "id": 1000
      }
    },
    "category": {
      "id": 0,
      "name": "name",
      "locale": "locale",
      "displayName": "displayName",
      "description": "description",
      "root": {
        "id": 1000
      },
      "parent": {
        "id": 1000
      }
    }
  },
  "title": "title",
  "name": "name",
  "body": "body",
  "feedback": "feedback",
  "travelledAs": "friends",
  "dateFrom": "dateFrom",
  "dateTo": "dateTo",
  "country": "country",
  "public": true,
  "modified": "modified",
  "reservation": null,
  "guest": null
}

Response 400

Bad request

application/json

Example 1

{
  "statusCode": 400,
  "description": "Bad request",
  "errors": [
    "Bad request"
  ]
}

Query parameters

reservationnumberrequired
tokenstringrequired
organizationnumberrequired
Organization ID

Request body

Required: No
Content type: application/json

scorenumberoptional
publicbooleanoptional
datestringoptional
titlestringoptional
namestringoptional
bodystringoptional
travelledAsstringoptional
Allowed values: couple, family, friends, single, other
dateFromstringoptional
dateTostringoptional
localestringoptional
countrystringoptional
aspectScoresobject[]optional
Show array — 2 properties
- scorenumberoptional
- aspectobjectoptional
  Show 1 property
  - idnumberoptional

Returns

Schema shown for 200 · application/json

idnumber
datestring
titlestringoptional
namestringoptional
bodystringoptional
feedbackstringoptional
scorestring
travelledAsstringoptional
Allowed values: couple, family, friends, single, other
dateFromstringoptional
dateTostringoptional
localestring
countrystringoptional
publicbooleanoptional
Default: true
createdstring
modifiedstringoptional
aspectScoresReviewAspectScore[]
Show array — 4 properties
- idnumber
- scorestring
- aspectone of 1 variantsoptional
  Show 1 variant
  - ReviewAspect
    Show 3 properties
    idnumber
    activeboolean
    aspectSpecificationone of 1 variantsoptional
    Show 1 variant
    ReviewAspectSpecification
- aspectSpecificationone of 1 variantsoptional
  Show 1 variant
  - ReviewAspectSpecification
    Show 4 properties
    idnumber
    typestringoptional
    Allowed values: beach, child-friendly, hygiene, location, pool, value-for-money, sanitary, service, surroundings, restaurant, facilities, recommendation, accommodation, recreation-team, playground, terrain-maintenance, cleaning
    namestringoptional
    localestring
commentsReviewComment[]
Show array — 7 properties
- idnumber
- bodystringoptional
- sentstringoptional
- publicbooleanoptional
  Default: true
- createdstring
- modifiedstringoptional
- reviewobject
  Show 1 property
  - idnumberoptional
reservationobjectoptional
Show 1 property
- idnumberoptional
guestobjectoptional
Show 1 property
- idnumberoptional
accommodationAccommodation
Show 35 properties
- idnumber
- titlestring
- referencestringoptional
- slugstring
- addressstringoptional
- postalCodestringoptional
- localitystringoptional
- municipalitynumberoptional
- regionstringoptional
- countrystringoptional
- latitudestringoptional
- longitudestringoptional
- numOfBedroomsnumberoptional
- numOfBedsnumberoptional
- numOfBathroomsnumberoptional
- minNumOfPersonsnumberoptional
- maxNumOfPersonsnumberoptional
- maxNumOfPetsnumberoptional
- minNumOfDaysnumberoptional
- maxNumOfDaysnumberoptional
- areastringoptional
- positionnumber
- governmentRegistrationNumberstringoptional
- regionalRegistrationNumberstringoptional
- localestring
- activebooleanoptional
- publicbooleanoptional
- featuredbooleanoptional
  Default: false
- createdstringoptional
- modifiedstringoptional
- houseCodestringoptional
- petsAllowedbooleanoptional
- localityCategoryone of 1 variantsoptional
  Show 1 variant
  - LocalityCategory
    Show 18 properties
    idnumber
    namestring
    excerptstringoptional
    disclaimerstringoptional
    descriptionstringoptional
    addressstringoptional
    postalCodestringoptional
    localitystringoptional
    municipalitynumberoptional
    regionstringoptional
    countrystringoptional
    latitudestringoptional
    longitudestringoptional
    localestring
    publicbooleanoptional
    Default: true
    rootobjectoptional
    Show 1 property
    idnumberoptional
    parentobjectoptional
    Show 1 property
    idnumberoptional
    displayNamestring
- categoryone of 1 variantsoptional
  Show 1 variant
  - AccommodationCategory
    Show 7 properties
    idnumber
    namestring
    descriptionstringoptional
    localestring
    rootobjectoptional
    Show 1 property
    idnumberoptional
    parentobjectoptional
    Show 1 property
    idnumberoptional
    displayNamestring
- contentAccommodationContent
  Show 11 properties
  - idnumber
  - titlestring
    Title shown to user
  - metaTitlestring
    Title used in the <meta> tag
  - subtitlestringoptional
  - excerptstringoptional
  - descriptionstringoptional
  - iframeUrlstringoptional
  - energyLabelEnabledbooleanoptional
  - energyLabelstringoptional
    Allowed values: A++++, A+++, A++, A+, A, B, C, D, E, F, G, N/A
  - customFacilitiesstring[]optional
  - localestring