Show Accommodation entity.

GET/api/accommodations/{id}

GETRequest

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

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

const result = await client.accommodations.get({
  id: 0,
  organization: 0,
});

Responses

Response 200

Successful response

application/json

Example responseGenerated from schema

{
  "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
    }
  }
}

Response 400

Bad request

application/json

Example 1

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

Response 404

Not found

application/json

Example 1

{
  "statusCode": 404,
  "description": "Not found",
  "errors": [
    "Not found"
  ]
}

Path parameters

idnumberrequired

Query parameters

organizationnumberrequired
Organization ID
localestringoptional
Locale
include[]string[]optional
Additional (relational) data groups to include in the response
settingsbooleanoptional

Returns

Schema shown for 200 · application/json

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