For the complete documentation index, see llms.txt. This page is also available as Markdown.

Class Details by Date Range

Overview

Returns detailed class records — class times, discipline, ability level, locations, the assigned instructors, and the guests booked into each class — for a date range. Use this to ingest historical or upcoming class detail into a data warehouse, reporting tool, or guest-experience system.

Authentication

Include your access token in the Authorization header:

Authorization: Bearer {access_token}

See the Authentication Guide for details on obtaining access tokens.

Endpoint

GET {api-url}/api/classmanagement/classes/{startDate}/{endDate}

Path Parameters

Parameter
Type
Required
Description

startDate

date

Yes

First day of the range, inclusive (YYYY-MM-DD)

endDate

date

Yes

Last day of the range, inclusive (YYYY-MM-DD). Must be ≤ 5 days after startDate.

Query Parameters

None.

Example Request

Response Format

Class Record Fields

Field
Type
Description

id

integer

Unique class identifier

startDateTime

datetime

Class start (YYYY-MM-DDTHH:mm:ss, resort-local time — no offset/zone marker)

endDateTime

datetime

Class end (YYYY-MM-DDTHH:mm:ss, resort-local time)

disciplineId

integer

Discipline identifier (nullable)

disciplineName

string

Discipline display name — empty string if not set

abilityLevelId

integer

Ability level identifier (nullable)

abilityLevelName

string

Ability level display name — empty string if not set

taskId

integer

Scheduling product (task definition) identifier (nullable)

taskType

integer

Type of task — see Task Types below (nullable)

taskName

string

Task display name — empty string if not set

startLocationId

integer

Class start location identifier (nullable)

startLocationName

string

Class start location name — empty string if not set

morningSnackLocationId

integer

Morning snack location identifier (nullable)

morningSnackLocationName

string

Morning snack location name — empty string if not set

lunchLocationId

integer

Lunch location identifier (nullable)

lunchLocationName

string

Lunch location name — empty string if not set

afternoonSnackLocationId

integer

Afternoon snack location identifier (nullable)

afternoonSnackLocationName

string

Afternoon snack location name — empty string if not set

pickUpLocationId

integer

Pick-up location identifier (nullable)

pickUpLocationName

string

Pick-up location name — empty string if not set

classGuests

array

Guests booked into the class (see Guest Fields below)

classInstructors

array

Instructors assigned to the class (see Instructor Fields below)

Guest Fields (classGuests[])

Field
Type
Description

id

integer

Class-guest assignment identifier (unique to this booking)

guestId

integer

flaik guest identifier (nullable for guests not yet linked to a guest profile)

identifierCode

string

External guest identifier — empty string if not set

firstName

string

Guest first name — empty string if not set

lastName

string

Guest last name — empty string if not set

email

string

Guest email — empty string if not set

phone

string

Guest phone — empty string if not set

dateOfBirth

date

Guest date of birth (YYYY-MM-DD, nullable)

Instructor Fields (classInstructors[])

Field
Type
Description

id

integer

Class-instructor assignment identifier

employeeId

integer

flaik employee identifier (nullable)

identifierCode

string

External employee identifier — empty string if not set

payrollIdentifier

string

Employee identifier in your payroll system — empty string if not set

firstName

string

Instructor first name — empty string if not set

lastName

string

Instructor last name — empty string if not set

Task Types

The taskType field is an integer enum:

Value
Meaning

1

Non-teaching

2

Group lesson

3

Private lesson

6

Hold block

7

Program lesson

Note: Legacy values 4 and 5 have been retired and should not appear in production data. Treat any unexpected value defensively (skip rather than fail).

Walking a Larger Window

Because the date range is capped at 5 days, ingesting a longer period requires walking through the range in chunks. A simple loop:

Error Responses

HTTP Status
Description

400

startDate or endDate is missing, malformed, or not a valid date

400

The supplied date range exceeds 5 days

401

Missing or invalid access token

Need help with class ingest? Contact resortsupport@flaik.com.

Last updated

Was this helpful?