API Reference

Endpoint

GET /v1/classes/{classId}/slots/{classSlotId}

Path Parameters

classId required integer (int64)

Id of the class.

classSlotId required integer (int64)

Unique ID of the class slot

Responses

Response Body application/json

Basic class slot information

id integer(int64) required

Unique ID of a class slot

Example: 1001

startDateTime string(date-time)

Class slot start date and time with zone

Example: "2022-06-22T08:00:00.000+02:00[Europe/Berlin]"

endDateTime string(date-time)

Class slot end date and time with zone

Example: "2022-06-22T09:00:00.000+02:00[Europe/Berlin]"

instructors array[object]

List of instructors

id integer(int64) required

Unique ID of the instructor

Example: 101

firstName required

Instructor's first name

Example: "Anna"

lastName required

Instructor's last name

Example: "Chodakowska"

publicName

Public name that should be shown to customers

Example: "Peter2000"

location

Represents location data

id integer(int64) required

Unique ID of the location

Example: 203

name required

Name of the location

Example: "Room 1"

description

Description of the location

Example: "Room located behind reception"

earliestBookingDateTime string(date-time)

Class slot earliest booking date and time with zone

Example: "2022-06-15T00:00:00.000+02:00[Europe/Berlin]"

latestBookingDateTime string(date-time)

Class slot latest booking date and time with zone

Example: "2022-06-15T23:59:59.999+02:00[Europe/Berlin]"

maxParticipants integer(int32)

Maximum participants allowed for a class slot

Example: 25

maxWaitingListParticipants integer(int32)

Maximum number of waiting list participants allowed for a class slot

Example: 5

bookedParticipants integer(int32)

Current number of booked participants of a class slot

Example: 25

additionalParticipants integer(int32) required

Additional participants added by the operator

Example: 5

waitingListParticipants integer(int32)

Current number of waiting list participants of a class slot

Example: 2

Validation of the request failed.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

TIMESTAMP BOOLEAN DATE MONTH_DAY TIME TERM TERM_LIST INTEGER DECIMAL STRING MONEY LIMITABLE_CONFIG_PROPERTY I18N_KEY I18N_KEY_LIST PERMISSION_LIST ENUM AVAILABILITY_LIST

reference

Reference to validation error

Example: "parent.child"

Authentication failed. No api-key, wrong api-key or wrong header name.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"

Authorization failed. The caller has no privilege to the given resource.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"

Entity does not exists.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"

Concurrent modification detected. The entity was modified by another request.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"

Access denied - rate limit is exceeded.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"

Unexpected system error.

Response Body application/json

Error data

errorMessage required

Resolved message in the context-specific default locale

errorCode

Key for translation files

traceId

Datadog trace id

args array[object] deprecated

Arguments referenced by format specifiers while resolving the message from translation files

typedArgs array[object] deprecated

Same as `args` but with type information

value

type

Allowed values:

reference

Reference to validation error

Example: "parent.child"