Show AccommodationUnit entity.

GETRequest

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

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

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

Responses

200400404

Response 200

Successful response

application/json

Example responseGenerated from schema

{
  "id": 0,
  "number": "number",
  "locale": "locale",
  "content": {
    "id": 0,
    "locale": "locale",
    "description": "description"
  },
  "features": [
    {
      "id": 1000
    }
  ],
  "latitude": "latitude",
  "longitude": "longitude",
  "public": true,
  "active": true,
  "availabilityEnabled": false,
  "available": true,
  "petsAllowed": true,
  "area": 0,
  "created": "created",
  "modified": "modified",
  "wifiConfiguration": {
    "id": 0,
    "securityProtocol": "securityProtocol",
    "ssid": "ssid",
    "accommodationUnits": [
      {
        "id": 1000
      }
    ],
    "psk": "psk"
  }
}

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

• include[]string[]optional

  Additional (relational) data groups to include in the response

• settingsbooleanoptional

Returns

Schema shown for 200 · application/json

• idnumber
• numberstring
• latitudestringoptional
• longitudestringoptional
• publicbooleanoptional
  Default: true
• activebooleanoptional
  Default: true
• availabilityEnabledbooleanoptional
  Default: false
• availablebooleanoptional
  Default: true
• petsAllowedbooleanoptional
• areanumberoptional
• localestring
• createdstringoptional
• modifiedstringoptional
• contentAccommodationUnitContent
  Show 3 properties

  • idnumber
  • descriptionstringoptional
  • localestring
• wifiConfigurationone of 1 variantsoptional
  Show 1 variant

  • AccommodationUnitWifiConfiguration
    Show 5 properties

    • idnumber
    • securityProtocolstring
    • ssidstring
    • pskstringoptional
    • accommodationUnitsobject[]
      Show array — 1 property

      • idnumberoptional
• featuresobject[]
  Show array — 1 property

  • idnumberoptional