getLiveSession
query to retrieve the information about the session by its ID:
getLiveSessions
query.
There are several arguments that can be used in this query:
Argument | Type | Description | Default |
---|---|---|---|
bucketId | ID | Required argument; ID of the bucket to get live sessions for. | — |
status | LiveSessionStatus , possible options: - DISABLED - PUBLISHED | Allows to filter by the live session status. Disabled live sessions are not available for registration. | — |
reverse | Boolean | Allows to change the order of the sorting to DESC . | FALSE |
sortKey | LiveSessionSortKey , possible options: - ID - START | Allows to change the default sorting (by the start date). | START |
getLiveSessionBucket
query to retrieve the information about the bucket in addition to the list of sessions.
getLiveSessionBucket
query there is no possibility to sort live sessions.LearningPath
object:
getLiveSessionBuckets
can be used if you need the list of related buckets.
Here is the list of arguments that can be used:
Argument | Type | Description | Default |
---|---|---|---|
lpId | ID | Required argument; ID of the learning path to get buckets for. | — |
status | LiveSessionStatus , possible options: - DISABLED - PUBLISHED | Allows to filter by the bucket status. Live sessions that relate to the disabled buckets are not available for registration. | — |
reverse | Boolean | Allows to change the order of the sorting to DESC . | FALSE |
sortKey | LiveSessionBucketSortKeys , possible options: - ID - TITLE | Allows to change the default sorting. | TITLE |
registerToLiveSession
is used.
Argument | Type | Description |
---|---|---|
liveSessionId | ID | Required argument; ID of the live session to register for. |
userContextId | ID | Optional; if set, the user with the given API context will be registered to the live session if it’s possible. Otherwise the current user will be registered (if possible). |
LiveSessionAttendance
object will be returned.