title

The announcement's headline

text

The announcement's content, in Markdown format

image_url

URL to the announcement image, if available

published_at

Time of publication

visited

Whether the announcement has been seen by the current user

course

GET /api/v2/announcements

Retrieve latest announcements

GET /api/v2/announcements/:id

Retrieve announcement details

PATCH /api/v2/announcements/:id

Change article information

course

Only return announcements belonging to the course with this UUID

global

Include global announcements

language

Load the announcements in this language (falls back to the default language if a translation is not available)

title

The public title of this channel

color

Hexadecimal RGB color values as known from CSS, e.g. FF0000 for red

position

Relative position in the channel list

description

A localized long-form text describing the channel contents in greater detail. Picks an available language based on the Accept-Language header.

mobile_image_url

URL to the mobile-friendly channel image

stage_logo_url

URL to the channel logo

stage_image_url

URL to the stage image

stage_statement

A short text describing the channel contents

stage_stream

Media info about the stage stream, if it exists

{
  "hd_url": "string",
  "sd_url": "string",
  "hls_url": "string",
  "hd_size": "integer",
  "sd_size": "integer",
  "thumbnail_url": "string"
}

courses

GET /api/v2/channels

List all channels on this platform

GET /api/v2/channels/:id

Retrieve information about a channel

visible

Whether this cluster is visible to users

title

The localized cluster title

GET /api/v2/clusters

List all clusters

type

The type of event (one of course_start, section_start, item_submission_publishing, item_submission_deadline)

title

The name of the referenced resource (a course, section or item)

date

Date and time when this event occurs

course

GET /api/v2/course-dates

Returns next course dates (assignments, deadlines etc.) relevant to the user

course

Only return dates for the course with this UUID

features

List of feature flipper's name

[
  "string"
]

GET /api/v2/course-features/:id

Get all course features

title

The item's title

position

The item's position within its section

deadline

The date at which the item must have been finished by the user

content_type

The type of item: one of quiz, video, rich_text, lti_exercise

icon

The icon for this item (reflecting the icon in the xikolo-font)

icon

The icon for this item (reflecting the icon in the xikolo-font)

exercise_type

The rank of this exercise: one of main, bonus, selftest, survey

max_points

The number of points (with decimal) that can be achieved with this item

optional

Whether this item is optional

proctored

Whether this item is only accessible with proctoring if certificate was booked

accessible

Whether the item's content can be accessed at this time

time_effort

The estimated time needed to complete the item

visited

Whether the current user has visited this item before

content

section

course

GET /api/v2/course-items

List all items for a given course section

GET /api/v2/course-items/:id

Retrieve a single item

PATCH /api/v2/course-items/:id

Update an item

section

Only return items belonging to the section with this UUID

course

Only return items belonging to the course with this UUID

content_type

Only return items of this content type (e.g. quiz or video)

main_exercises

The course's main exercise statistics for user

{
  "exercises_available": "integer",
  "exercises_taken": "integer",
  "points_possible": "float",
  "points_scored": "float"
}

selftest_exercises

The course's selftest exercise statistics for user

{
  "exercises_available": "integer",
  "exercises_taken": "integer",
  "points_possible": "float",
  "points_scored": "float"
}

bonus_exercises

The course's bonus exercise statistics for user

{
  "exercises_available": "integer",
  "exercises_taken": "integer",
  "points_possible": "float",
  "points_scored": "float"
}

visits

The course's item visit statistics for user

{
  "items_available": "integer",
  "items_visited": "integer",
  "visits_percentage": "integer"
}

section_progresses

GET /api/v2/course-progresses/:id

Get course progress

title

The section's title

description

A text describing the section's content

position

The sections's position within its course

start_at

The date when this section becomes available

end_at

The date when access to this section is closed

accessible

Whether the section's content can be accessed at this time

parent

Whether the section is a parent section of alternative sections

course

items

GET /api/v2/course-sections

List all sections for a given course

GET /api/v2/course-sections/:id

Retrieve information about a section

course

Only return items belonging to the course with this UUID

title

The course name

slug

A short name for use in URLs etc.

start_at

Date and time when this course starts

end_at

Date and time when this course ends

abstract

A short text describing the course contents

description

A long-form text describing the course contents in greater detail

image_url

URL to the course image

images

URLs to the course image in various sizes, with the exact dimensions of each image. \ Clients can use these for loading the optimal size of an image depending on the viewport size.

[
  {
    "max_width": "integer",
    "max_height": "integer",
    "url": "string"
  }
]

language

The language in which the course will be held

status

Current state of the course: one of external, preparation, announced, preview, active or self-paced

classifiers

A hash of classifiers for this course (used for categorization), mapping from names to arrays of assigned groups in these categories.

{
  "any": "any"
}

teachers

A string, listing the names of teachers or a short title for the teaching team

accessible

Whether the course content is already accessible

enrollable

Whether any user can enroll in this course

hidden

Whether this course is hidden (i.e. not visible to guests and regular users)

external

Whether this course is hosted on an external platform

external_url

URL to the external course, if it is hosted on another platform

policy_url

URL to a document detailing any policies that the user has to agree to before enrolling

certificates

A hash with information about the certificates that can be gained in this course.

{
  "confirmation_of_participation": {
    "available": "boolean",
    "threshold": "integer"
  },
  "record_of_achievement": {
    "available": "boolean",
    "threshold": "integer"
  },
  "qualified_certificate": {
    "available": "boolean"
  }
}

on_demand

Whether this course is available for on_demand/reactivation option

learning_goals

What the learner is expected to gain from the course

[
  "string"
]

target_groups

The groups at which the course is targeted

[
  "string"
]

show_on_list

Whether this course should be shown on the course list

teaser_stream

Media info about the teaser stream, if it exists

{
  "hd_url": "string",
  "sd_url": "string",
  "hls_url": "string",
  "hd_size": "integer",
  "sd_size": "integer",
  "thumbnail_url": "string"
}

channel

user_enrollment

sections

documents

progress

last_visit

dates

repetition_suggestions

GET /api/v2/courses

List all courses

GET /api/v2/courses/:id

Get information about a course

channel

Only return courses belonging to the channel with this UUID

document

Only return courses belonging to the document with this UUID

title

The title of the document

description

A short description of the document contents

tags

A lists of tags ot the document

[
  "string"
]

public

flag indication whether a document is available on the platform

localizations

courses

GET /api/v2/documents

List all documents

GET /api/v2/documents/:id

Retrieve information about a document

course

Only return documents belonging to the course with this UUID

tag

Only return documents that are tagged with this tag

language

Only return documents that are available in this language

certificates

A hash with information about the achieved certificates (confirmation_of_participation, record_of_achievement, qualified_certificate): Every value is either a URL pointing to the certificate file, or null

{
  "confirmation_of_participation": "string",
  "record_of_achievement": "string",
  "qualified_certificate": "string"
}

completed

Whether or not the user completed this course

reactivated

Whether this enrollment has an active course reactivation, i.e. when the user has paid for taking the full course, with homework and exam, after the regular course time has ended

proctored

Whether the user booked a certificate for this course

created_at

The date and time when this enrollment was created

course

progress

GET /api/v2/enrollments

List all enrollments

POST /api/v2/enrollments

Create enrollments

GET /api/v2/enrollments/:id

Get the enrollment

PATCH /api/v2/enrollments/:id

Update the enrollment

DELETE /api/v2/enrollments/:id

Delete the enrollment

identifier

The identifier of the experiment. Required for POST.

course

POST /api/v2/experiment-assignments

Create experiment assignment

features

List of feature flipper's names

[
  "string"
]

GET /api/v2/features/:id

Get global features

visit_date

The date of the last item visit

item

GET /api/v2/last-visits/:id

Get last visit information

instructions

A text with detailed explanation what this task will entail

weight

A multiplier (integer) for the LTI score (a number between 0 and 1) to achieve the final score for this exercise

allowed_attempts

The maximum number of attempts allowed per user (0 is infinite)

launch_url

URL to launch the LTI tool

GET /api/v2/lti-exercises/:id

Retrieve information about a LTI exercise

title

The title of the topic

abstract

The abstract of the topic

created_at

The timestamp at which the topic was created

reply_count

The number of replies to a topic

closed

The state of the topic (boolean)

meta

Meta information about the topic (e.g. the video timestamp)

{
  "any": "any"
}

course

item

GET /api/v2/pinboard-topics

List all topics

POST /api/v2/pinboard-topics

Create a topic

item

Only return topics belonging to the item with this UUID

type

The event type (e.g. pinboard.question.new)

title

A description of the event (formatted as Markdown)

preview_html

A short HTML snippet to show as preview of the related content

created_at

The time when the event was logged

course

collab_space

GET /api/v2/platform-events

Returns events for the user, can be filtered to course or learning room context

course

collab_space

only_collab_space_related

text

The question text

explanation

A short text explaining the solution (may be null when this is kept secret)

type

The question type (one of select_multiple, select_one, or free_text)

position

The question's position within its quiz

max_points

The maximum number of points (with decimal) that can be achieved with this question

shuffle_options

Whether the options should be shown in random order

eligible_for_recap

Whether the question is eligible for a quiz recap

options

An array of possible options

[
  {
    "id": "string",
    "position": "integer",
    "text": "string",
    "correct": "boolean",
    "explanation": "string"
  }
]

quiz

GET /api/v2/quiz-questions

Retrieve all questions for a given quiz

GET /api/v2/quiz-questions/:id

Retrieve a quiz question by ID

quiz

Only return questions belonging to the quiz with this UUID

created_at

The date and time when submission data was first saved for this user and quiz

submitted_at

The date and time when the user finalized this submission

submitted

Whether this submission has been finalized by the user

points

The total number of points (with decimal) the user received

answers

A hash of question IDs mapping to an array of submitted answer objects for this question

{
  "any": "any"
}

course

quiz

user

POST /api/v2/quiz-submissions

Start a quiz submission

GET /api/v2/quiz-submissions/:id

Load a quiz submission

PATCH /api/v2/quiz-submissions/:id

Update a quiz submission

instructions

Textual instructions for the quiz taker in Markdown format

time_limit

The time (in seconds) that the user can take to finish the quiz, or zero if unlimited

allowed_attempts

The number of allowed attempts the user has to finish the quiz, or zero if unlimited

questions

newest_user_submission

GET /api/v2/quizzes/:id

Retrieve information about a quiz

title

The repetition suggestion's title

content_type

The type of item: one of quiz, video, rich_text, lti_exercise

icon

The icon for this item (reflecting the icon in the xikolo-font)

exercise_type

The rank of this exercise: one of main, bonus, selftest, survey

user_points

The (maximum) number of points (with decimal) that the user scored for this item

max_points

The number of points (with decimal) that can be achieved with this item

percentage

The percentage of scored points (with regard to the max_points) for this item

GET /api/v2/repetition-suggestions

List all repetition suggestions for the current user

course

Only return repetition suggestions belonging to the course with this UUID

text

The text content (formatted as Markdown) to be shown to the user

GET /api/v2/rich-texts/:id

Retrieve a single text item

title

The section's title

description

A text describing the section's content

position

The sections's position within its course

available

Whether the section was unlocked yet

parent

Whether the section is a parent section

main_exercises

The sections's main exercise statistics for user

{
  "exercises_available": "integer",
  "exercises_taken": "integer",
  "points_possible": "float",
  "points_scored": "float"
}

selftest_exercises

The sections's selftest exercise statistics for user

{
  "exercises_available": "integer",
  "exercises_taken": "integer",
  "points_possible": "float",
  "points_scored": "float"
}

bonus_exercises

The sections's bonus exercise statistics for user

{
  "exercises_available": "integer",
  "exercises_taken": "integer",
  "points_possible": "float",
  "points_scored": "float"
}

visits

The sections's item visit statistics for user

{
  "items_available": "integer",
  "items_visited": "integer",
  "visits_percentage": "integer"
}

items

The sections's item visit statistics for user

[
  {
    "id": "string",
    "user_state": "string",
    "max_points": "float",
    "user_points": "float",
    "time_effort": "integer",
    "completed": "boolean"
  }
]

course_progress

GET /api/v2/section-progresses

List all section progresses for a given course

course

Only return sections belonging to the course with this UUID

identifier

The cue identifier, mainly used as position for ordering

text

The actual text of the subtitle cue

start

The start time of the subtitle cue

end

The end time of the subtitle cue

settings

The display configuration of the subtitle cue

GET /api/v2/subtitle-cues

List all subtitle cues for video

track

Only return subtitle cues belonging to the subtitle track with this UUID

language

The subtitle language

created_by_machine

Whether the subtitles were created by a machine (or human if not)

vtt_url

URL to the corresponding WebVTT file

video

cues

GET /api/v2/subtitle-tracks

List all subtitles for video

video

Only return subtitles belonging to the video with this UUID

language

Only return subtitles with this language

title

The title of the ticket. Required for POST.

report

The description of the ticket. Required for POST.

topic

The topic of the ticket, either technical, reactivation, or course. If course, a relationship must be passed as well. Required for POST.

language

The language of the user's client. Required for POST.

mail

The user's email. Required for POST if no authorization header is sent, otherwise ignored and extracted automatically.

url

An optional URL.

data

An optional data string, usually some client information formatted as a user-agent.

course

POST /api/v2/tickets

Store helpdesk tickets

user

A hash describing the user causing this event. Required keys: uuid - the user's UUID.

{
  "uuid": "string"
}

verb

A hash describing the kind of action that is being tracked. Required keys: type - one of the predefined constants, e.g. VIDEO_PLAY.

{
  "type": "string"
}

resource

A hash describing the object that was acted upon. Required keys: type, uuid.

{
  "uuid": "string",
  "type": "string"
}

timestamp

Full date and time of the event. Example: 2015-09-24T10:06:49+02:00

result

A hash of information describing the result of the action that was executed. Arbitrary keys allowed.

{
  "any": "any"
}

context

A hash of additional context information relevant to this element. Arbitrary keys allowed.

{
  "any": "any"
}

POST /api/v2/tracking-events

Store tracking events

name

The user's display name

avatar_url

profile

GET /api/v2/users/:id

Load information about a user (use "me" as ID if the current user's ID is not available)

summary

A short description of the video contents

duration

The video's duration in seconds, if known

single_stream

Media info about the single stream (picture-in-picture), if it exists. Clients can choose to use this version instead of combining the lecturer and slides streams.

{
  "hd_url": "string",
  "sd_url": "string",
  "hls_url": "string",
  "hd_size": "integer",
  "sd_size": "integer",
  "thumbnail_url": "string"
}

lecturer_stream

Media info about the lecturer stream, if it exists.

{
  "hd_url": "string",
  "sd_url": "string",
  "hls_url": "string",
  "hd_size": "integer",
  "sd_size": "integer",
  "thumbnail_url": "string"
}

slides_stream

Media info about the slides stream, if it exists.

{
  "hd_url": "string",
  "sd_url": "string",
  "hls_url": "string",
  "hd_size": "integer",
  "sd_size": "integer",
  "thumbnail_url": "string"
}

slides_url

URL to the lecture slides (PDF), if available

slides_size

Size of the lecture slides in bytes, if available

audio_url

URL to the audio recording (MP3), if available

audio_size

Size of the audio recording in bytes, if available

transcript_url

URL to the video transcript (PDF), if available

transcript_size

Size of the video transcript in bytes, if available

thumbnail_url

URL to the thumbnail image that can be shown as a preview

subtitles

All subtitles for video

[
  {
    "language": "string",
    "created_by_machine": "boolean",
    "vtt_url": "string"
  }
]

subtitle-tracks

GET /api/v2/videos/:id

Retrieve information about a video