Group class schedule grid
Header Parameters
Api-Keystring
Query Parameters
startstring Required
Period start (date or datetime).
finishstring Required
Period end (date or datetime).
organization_idinteger
Branch filter (must be visible to the Api-Key).
location_idinteger
Room / location filter.
lesson_idinteger
Lesson filter.
segmentinteger
Segment filter (lesson must contain this segment).
page_startinteger
1-based index of the first record to return (offset = page_start - 1).
Defaults to 1. Named page_start (not start) on this endpoint
because start is already used for the schedule period.
Minimum
1
Default value
1
page_limitinteger
Page size. Defaults to 25; values above 100 are silently capped
to 100. Named page_limit (not limit) for symmetry with page_start.
Minimum
1
Maximum
100
Default value
25
Response
200
Object
Schedule events (crud envelope)
Response Attributes
successboolean
dataarray
Show child attributes
errorstring
error_codeinteger
totalinteger | null
summaryobject
401
Object
Session not established / invalid key.
Response Attributes
successboolean
dataarray
errorstring
session_expiredboolean
totalinteger
Was this section helpful?
Response
Was this section helpful?