Data Types

JSON

type description
AboutResponse Information about the application and API.
AccessTokenResponse A response to a successful access token request, as described in RFC 6749 Section 5.1.
Account Detailed information about an account.
AccountBrief Brief information about an account.
AccountContentRequest A request to add content to an account.
AccountCreateRequest A request to create an account.
AccountLearnerData Information about a single learner's attempts on a single course in an account.
AccountLearnerDataResponse A list of AccountLearnerData.
AccountLicenseType License types for an account.
AccountListResponse A list of AccountBrief.
AdvancedCourseConfig Advanced course configuration settings. These settings control how the Engine player and content interact, and are destination-agnostic.
AttachedLicenseResponse
AuthErrorResponse A response to an unsuccessful access token request, as described in RFC 6749 Section 5.2. The optional "error_uri" parameter is not included.
BasicCourseConfig Basic course configuration settings. These settings control how the Engine player UI appears, and are usually destination-specific.
CompleteAdvancedCourseConfig Specifies an exhaustive map of the advanced settings and their values.
CompleteBasicCourseConfig Specifies a complete set of all basic CC course settings.
ContentListResponse A response containing a list of content (courses and equivalents).
Course Detailed information about a course.
CourseBrief Brief information about a course.
CourseListResponse An response containing a list of CourseBrief.
CreatedResponse A response to a successful resource creation request.
CustomLaunchData Custom launch data for an account course or equivalent.
DeleteLearnerDataRequest A request to delete a list of learner IDs from the system.
Equivalent Information about an equivalent.
EquivalentBrief Brief information about an equivalent.
EquivalentCourse Information about a course that belongs to an equivalent.
EquivalentCreateRequest A request to create a new equivalent.
EquivalentListResponse A response with a list of EquivalentBrief.
EquivalentMap A map of a course to a language used when creating an equivalent.
Available Languages
Language CodeLanguage
arArabic
en-AUAustralian English
pt-BRBrazilian Portuguese
en-CACanadian English
fr-CACanadian French
zh-HKCantonese
csCzech
da-DKDanish
nl-NLDutch
en-USEnglish
faFarsi
fiFinnish
nl-BEFlemish
frFrench
deGerman
elGreek
huHungarian
idIndonesian
itItalian
jaJapanese
koKorean
lvLatvian
msMalay
zh-CNMandarin
es-MXMexican Spanish
noNorwegian
plPolish
ptPortuguese
ruRussian
zhSimplified Chinese
esSpanish
svSwedish
thThai
zh-TWTraditional Chinese
trTurkish
en-UKUK English (British English)
viVietnamese
ImportResultResponse A response to an import request.
IncompleteAdvancedCourseConfig Specifies a possibly-incomplete set of advanced CC course settings.
IncompleteBasicCourseConfig Specifies a possibly-incomplete set of basic CC course settings.
Language A language code and name.
LanguageListResponse A list of languages.
LearnerData Information about a single learner's attempts on a single course.
LearnerDataJobResponse
LicenseLimit A license limit for a course or account.
LimitType License types for accounts and account content.
RegistrationCompletion Completion status for registrations and launches.
RegistrationSuccessStatus Completion values for a registration.
SettingGroupConfig A base class representing a collection of settings validated against a known group of setting IDs.
The design of this class and its subclasses is somewhat unusual. The problem is that we need to solve multiple slight variations of the problem of having collections of various settings that belong to a list: our internal API calls are designed to require all settings belonging to the list at once, while our public API calls require only a subset thereof. There is also the problem that this these need to be represented as JSON objects deserializable by our web framework, which works best if these sets of settings are types. We also need a way of specifying that a given set has been blessed in internal API calls that sometimes require a complete set of settings and behave otherwise if they don't (e.g., we only want to cache fully-specified lists of settings). Therefore, for each setting group represented by this class, there are two subclasses (e.g., IncompleteBasicCourseConfig, ) representing and guaranteeing these various constraints.
Version Information about a version.