Models

roleString · string

Usually either teacher or student

datetimeString · string

pattern: /^\d{4}-\d{2}-\d{2}T\d{2}\:\d{2}\:\d{2}\.\d{3}Z$/

objectIdString · string

_pattern: /^[0-9a-f]{24}$/_

UserResponse

Show Subset of properties listed here

_id · string

objectIdString pattern: /^[0-9a-f]{24}$/

email · string

name · string

slug · string

role · string

roleString Usually either ‘teacher’ or ‘student’

stats

Show Properties

gamesCompleted · number

concepts · number

playTime · number

Included only when specifically requested on the endpoint

oAuthIdentities

Show Properties

provider · string

id · string

subscription

Show Properties

ends · string

datetimeString pattern: /^\d{4}-\d{2}-\d{2}T\d{2}\:\d{2}\:\d{2}\.\d{3}Z$/

active · boolean

license

Show Properties

ends · string

datetimeString pattern: /^\d{4}-\d{2}-\d{2}T\d{2}\:\d{2}\:\d{2}\.\d{3}Z$/

active · boolean

ClassroomResponse

Show Subset of properties listed here

_id · string

objectIdString pattern: /^[0-9a-f]{24}$/

name · string

members · string

objectIdString pattern: /^[0-9a-f]{24}$/]

ownerID · string

objectIdString pattern: /^[0-9a-f]{24}$/

description · string

courses

objectIdString pattern: /^[0-9a-f]{24}$/

Show Properties

_id · string

levels · string

enrolled · string

instance_id · string

ClassroomResponseWithCode

Show Subset of properties listed here

_id · string

objectIdString pattern: /^[0-9a-f]{24}$/

name · string

members · string

objectIdString pattern: /^[0-9a-f]{24}$/]

ownerID · string

objectIdString pattern: /^[0-9a-f]{24}$/

description · string

code · string

codeCamel · string

courses

objectIdString pattern: /^[0-9a-f]{24}$/

Show Properties

_id · string

levels · string

enrolled · string

instance_id · string

clanId · string

objectIdString pattern: /^[0-9a-f]{24}$/

PlaytimeStatsResponse

Show Subset of properties listed here

playTime · number

Total play time in seconds

gamesPlayed · number

Number of levels played

LicenseStatsResponse

Show Subset of properties listed here

licenseDaysGranted · number

Total number of license days granted

licenseDaysUsed · number

Number of license days used

licenseDaysRemaining · number

Number of license days remaining

activeLicenses · number

Number of active/valid licenses

LevelSessionResponse

Show Subset of properties listed here

state · boolean

complete

level · string

original** The id for the level.

levelID · string

Level slug like wakka-maul

creator · string

objectIdString pattern: /^[0-9a-f]{24}$/

playtime · integer

Time played in seconds.

changed · string

datetimeString _pattern: /^\d{4}-\d{2}-\d{2}T\d{2}\:\d{2}\:\d{2}\.\d{3}Z$/

created · string

datetimeString _pattern: /^\d{4}-\d{2}-\d{2}T\d{2}\:\d{2}\:\d{2}\.\d{3}Z$/

dateFirstCompleted · string

datetimeString _pattern: /^\d{4}-\d{2}-\d{2}T\d{2}\:\d{2}\:\d{2}\.\d{3}Z$/

submitted · boolean

For arenas. Whether or not the level has been added to the ladder.

published · boolean

For shareable projects. Whether or not the project has been shared with classmates.

ClanResponse

Show Subset of properties listed here

_id · string

objectIdString pattern: /^[0-9a-f]{24}$/

name · string

displayName · string

members · string

objectIdString pattern: /^[0-9a-f]{24}$/

ownerID · string

objectIdString pattern: /^[0-9a-f]{24}$/

description · string

type · string

kind · string

metadata