Bookings & Attendance

The bookings and attendance query returns a combination of data from three different models: attendance, bookings and plans. It is recommended that you read the Calven Data Models overview to get more details on those.

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string {{Username}}:{{Password}}

Example:

Authorization: Basic *****************

Query Params

startDate

string

required

Start date in the format YYYYMMDD or YYYY-MM-DD

Example:

20211224

endDate

string

required

End date in the format YYYYMMDD or YYYY-MM-DD

Example:

20211224

locationId

string

optional

Location Id to query data for. If not provided, data for all locations is queried.

Example:

3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

array of:

userId

string

required

The ID of a user

Example:

3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b

primaryLocationId

string

required

The primary location ID of a user

Example:

3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b

primaryLocationName

string

required

The primary location name of a user

Example:

New York

day

string

required

The day in the format YYYY-MM-DD

Example:

2021-12-24T00:00:00.000Z

plan

enum<string>

required

The type of plan

Allowed values:

aor

Example:

bookingDepth

enum<number>

optional

The booking depth

Allowed values:

123

Example:

attendanceType

enum<string>

optional

The attendance type

Allowed values:

confirmednoShowunconfirmedwalkIn

Example:

confirmed

bookingLocationId

object

optional

The location ID of the booking

Example:

3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b

bookingLocationName

object

optional

The location name of the booking

Example:

New York

bookingLevelId

object

optional

The level ID of the booking

Example:

3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b

bookingLevelName

object

optional

The level name of the booking

Example:

Level 1

bookingZoneId

object

optional

The zone ID of the booking

Example:

3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b

bookingZoneName

object

optional

The zone name of the booking

Example:

Engineering Zone

bookingPlaceId

object

optional

The place ID of the booking

Example:

3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b

bookingPlaceName

object

optional

The place name of the booking

Example:

WD1

primaryGroupId

object

optional

The primary group ID of a user

Example:

3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b

primaryGroupName

object

optional

The primary group name of a user

Example:

Engineering

bookingGroupId

object

optional

The group ID of the booking

Example:

3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b

bookingGroupName

object

optional

The group name of the booking

Example:

Engineering

bookingSource

string

required

The source of the booking

Example:

user

bookingReasonCode

object

required

The reason code of the booking

Example:

userSelected

onWaitlist

boolean

required

The waitlist status of the booking

Example:

true

Example

[
  {
    "userId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
    "primaryLocationId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
    "primaryLocationName": "New York",
    "day": "2021-12-24T00:00:00.000Z",
    "plan": "a",
    "bookingDepth": 1,
    "attendanceType": "confirmed",
    "bookingLocationId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
    "bookingLocationName": "New York",
    "bookingLevelId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
    "bookingLevelName": "Level 1",
    "bookingZoneId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
    "bookingZoneName": "Engineering Zone",
    "bookingPlaceId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
    "bookingPlaceName": "WD1",
    "primaryGroupId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
    "primaryGroupName": "Engineering",
    "bookingGroupId": "3a2b0fd7-5f5a-4472-ab61-a2cc1784d38b",
    "bookingGroupName": "Engineering",
    "bookingSource": "user",
    "bookingReasonCode": "userSelected",
    "onWaitlist": true
  }
]