Get Reservations (all)

GET /v1/reservations/{deviceId}/all

Gets all reservations for a given VAKA system.

Headers

Name
Value

Authorization

Bearer <token>

x-api-key

<api key>

Parameters

deviceId string(uuid) path parameter (required)

Identifier of the VAKA system to get reservations from.

pageSize int32 query parameter (optional)

The maximum number of reservations to return. Default page size is 50, maximum allowed page size is 100.

continuationToken (string) query parameter (optional)

Token returned in a previous response that can be used to return the next page of reservations.

Response

200 OK

A list containing details about each reservation.

Body

reservations array of Reservation objects

A list of Reservation objects.

Show Reservation attributes

Represents a reservation made by a user for a specific resource and period of time.

id string(uuid)

Unique identifier of the reservation.

userId string(uuid)

Identifier of the user that made the reservation, or null if ownerType is Service.

ownerId string(uuid)

Identifier of the entity that owns the reservation, or null if ownerType is Service.

ownerType string

The type of entity that owns the reservation. Can be one of the following values:

  • User The owner is a user.

  • Group The owner is a user group (e.g apartment or other type of organisational unit).

  • Service The reservation belongs to a maintenance window.

status string

Current status of the reservation. Can be one of the following values:

  • Unused The reservation has not yet been consumed by any user.

  • Used The reservation has been activated/consumed.

resourceId string(uuid)

Identifier of the resource.

startTime string(date-time)

Time when the reservation starts, expressed in UTC.

endTime string(date-time)

Time when the reservation ends, expressed in UTC.

deviceId string(uuid)

Identifier of the VAKA system the reservation belongs to.

continuationToken string

A token that can be used in subsequent request to fetch the next page of reservations, or null if there is no more reservations to get.

PreviousGet Resource by IdNextGet Reservations by User

Last updated