Booking API

List bookable offerings

List active catalogue offerings that can be scheduled at a place.

GET/v1/booking/offerings

capability booking.offerings.list · v1operational dataserver-scoped workspace

Request

Path, query, and JSON body fields accepted by this operation.

status"active" | "inactive"
query

Response

Successful responses use Dawn's data envelope.

dataBookingOfferingListrequired
- idstring<uuid>required
- workspaceIdstring<uuid>required
- catalogueItemIdstring<uuid>required
- catalogueItemNamestringrequired
  min length 1max length 160
- placeResourceIdstring<uuid>required
- placeNamestringrequired
  min length 1max length 120
- durationMinutesintegerrequired
  min 5max 1440
- intervalMinutesintegerrequired
  min 5max 120
- minimumNoticeMinutesintegerrequired
  min 0max 525600
- bookingHorizonDaysintegerrequired
  min 1max 730
- status"active" | "inactive"required
metaobject

Errors

Error responses use the shared error envelope.

403Scheduling is disabled or unavailable.
422The booking offering query is invalid.
503Booking offerings are temporarily unavailable.

Request

import { createDawnClient } from "@dawn/api";

const dawn = createDawnClient({
  baseUrl: "http://localhost:6400",
});

const result = await dawn.capabilities["booking.offerings.list"]({
  "status": "active",
});

if (result.isErr()) throw result.error;
console.log(result.value);

Response

Successful response.

{
  "data": [
    {
      "id": "11111111-1111-4111-8111-111111111111",
      "workspaceId": "22222222-2222-4222-8222-222222222222",
      "catalogueItemId": "11111111-1111-4111-8111-111111111111",
      "catalogueItemName": "string",
      "placeResourceId": "11111111-1111-4111-8111-111111111111",
      "placeName": "string",
      "durationMinutes": 5,
      "intervalMinutes": 5,
      "minimumNoticeMinutes": 0,
      "bookingHorizonDays": 1,
      "status": "active"
    }
  ],
  "meta": {}
}