List locations with their guest presence.

Returns the locations matching the filters, each with whether a guest is present at the given date. The presence follows the actual checkin and checkout: on the arrival day a location stays available until the guest has checked in, on the departure day it stays occupied until the guest has checked out. The arrival and departure indicators follow the dates of the reservation instead, regardless of whether the guest has checked in or out or not.

GETRequest

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

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

const result = await client.accommodationUnits.presence();

Responses

200400

Response 200

Successful response

application/json

Example responseGenerated from schema

[
  {
    "id": 1000,
    "number": "039",
    "active": true,
    "occupied": true,
    "arrival": false,
    "departure": true
  }
]

Response 400

Bad request

application/json

Example 1

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

Query parameters

• idnumberoptional
• datestringoptional
• accommodationnumberoptional
• accommodationCategorynumberoptional
• activebooleanoptional
• offsetnumberoptional
  Default: 0
• limitnumberoptional
  Default: 25

Returns

Array of object

Schema shown for 200 · application/json

• idnumberoptional
• numberstringoptional
• activebooleanoptional
• occupiedbooleanoptional

  A guest is present at the location

• arrivalbooleanoptional

  The location has a reservation starting at the given date

• departurebooleanoptional

  The location has a reservation ending at the given date