For the complete documentation index, see llms.txt. This page is also available as Markdown.

Courses API: Courses

Retrieves one specific course

get
Authorizations
BearerstringRequired
Path parameters
coursestring · uuidRequired
Responses
200

OK

CatalogIdstring · uuid · nullableOptional
CompletedToAdministratorMessageIdstring · uuid · nullableOptional
CompletedToLearnerMessageIdstring · uuid · nullableOptional
CompletionActivityIdstring · uuid · nullableOptional
CourseIdstring · uuidOptional
CreatedBystring · uuidOptional
FrameworkStandardIdstring · uuid · nullableOptional
GradebookIdstring · uuid · nullableOptional
ModifiedBystring · uuidOptional
SourceIdstring · uuid · nullableOptional
StalledToAdministratorMessageIdstring · uuid · nullableOptional
StalledToLearnerMessageIdstring · uuid · nullableOptional
AllowDiscussionbooleanOptional
CourseIsHiddenbooleanOptional
IsDisplayOverviewOnlybooleanOptional
IsMultipleUnitsEnabledbooleanOptional
IsProgressReportEnabledbooleanOptional
CourseCodestring · nullableOptional
CourseDescriptionstring · nullableOptional
CourseFlagColorstring · nullableOptional
CourseFlagTextstring · nullableOptional
CourseHookstring · nullableOptional
CourseIconstring · nullableOptional
CourseImagestring · nullableOptional
CourseLabelstring · nullableOptional
CourseLevelstring · nullableOptional
CourseNamestring · nullableOptional
CoursePlatformstring · nullableOptional
CourseProgramstring · nullableOptional
CourseSlugstring · nullableOptional
CourseStylestring · nullableOptional
CourseUnitstring · nullableOptional
CourseAssetinteger · int32Optional
CourseSequenceinteger · int32 · nullableOptional
OutlineWidthinteger · int32 · nullableOptional
SendMessageStalledAfterDaysinteger · int32 · nullableOptional
SendMessageStalledMaxCountinteger · int32 · nullableOptional
Closedstring · date-time · nullableOptional
Createdstring · date-timeOptional
Modifiedstring · date-timeOptional
get/api/courses/{course}

Checks for the existence of one specific course

head
Authorizations
BearerstringRequired
Path parameters
coursestring · uuidRequired
Responses
200

OK

No content

head/api/courses/{course}

No content

Collects the list of courses that match specific criteria

post
Authorizations
BearerstringRequired
Body
ClosedSincestring · date-time · nullableOptional
ClosedBeforestring · date-time · nullableOptional
CreatedSincestring · date-time · nullableOptional
CreatedBeforestring · date-time · nullableOptional
ModifiedSincestring · date-time · nullableOptional
ModifiedBeforestring · date-time · nullableOptional
IsPublishedboolean · nullableOptional
Responses
200

OK

CatalogIdstring · uuid · nullableOptional
CompletedToAdministratorMessageIdstring · uuid · nullableOptional
CompletedToLearnerMessageIdstring · uuid · nullableOptional
CompletionActivityIdstring · uuid · nullableOptional
CourseIdstring · uuidOptional
CreatedBystring · uuidOptional
FrameworkStandardIdstring · uuid · nullableOptional
GradebookIdstring · uuid · nullableOptional
ModifiedBystring · uuidOptional
SourceIdstring · uuid · nullableOptional
StalledToAdministratorMessageIdstring · uuid · nullableOptional
StalledToLearnerMessageIdstring · uuid · nullableOptional
AllowDiscussionbooleanOptional
CourseIsHiddenbooleanOptional
IsDisplayOverviewOnlybooleanOptional
IsMultipleUnitsEnabledbooleanOptional
IsProgressReportEnabledbooleanOptional
CourseCodestring · nullableOptional
CourseDescriptionstring · nullableOptional
CourseFlagColorstring · nullableOptional
CourseFlagTextstring · nullableOptional
CourseHookstring · nullableOptional
CourseIconstring · nullableOptional
CourseImagestring · nullableOptional
CourseLabelstring · nullableOptional
CourseLevelstring · nullableOptional
CourseNamestring · nullableOptional
CoursePlatformstring · nullableOptional
CourseProgramstring · nullableOptional
CourseSlugstring · nullableOptional
CourseStylestring · nullableOptional
CourseUnitstring · nullableOptional
CourseAssetinteger · int32Optional
CourseSequenceinteger · int32 · nullableOptional
OutlineWidthinteger · int32 · nullableOptional
SendMessageStalledAfterDaysinteger · int32 · nullableOptional
SendMessageStalledMaxCountinteger · int32 · nullableOptional
Closedstring · date-time · nullableOptional
Createdstring · date-timeOptional
Modifiedstring · date-timeOptional
post/api/courses/collect
200

OK

Counts the courses that match specific criteria

post
Authorizations
BearerstringRequired
Body
ClosedSincestring · date-time · nullableOptional
ClosedBeforestring · date-time · nullableOptional
CreatedSincestring · date-time · nullableOptional
CreatedBeforestring · date-time · nullableOptional
ModifiedSincestring · date-time · nullableOptional
ModifiedBeforestring · date-time · nullableOptional
IsPublishedboolean · nullableOptional
Responses
200

OK

Countinteger · int32Optional
Summarystring · nullableOptional
post/api/courses/count
200

OK

Downloads the list of courses that match specific criteria

post
Authorizations
BearerstringRequired
Body
ClosedSincestring · date-time · nullableOptional
ClosedBeforestring · date-time · nullableOptional
CreatedSincestring · date-time · nullableOptional
CreatedBeforestring · date-time · nullableOptional
ModifiedSincestring · date-time · nullableOptional
ModifiedBeforestring · date-time · nullableOptional
IsPublishedboolean · nullableOptional
Responses
200

OK

No content

post/api/courses/download
200

OK

No content

Searches for the list of courses that match specific criteria

post
Authorizations
BearerstringRequired
Body
ClosedSincestring · date-time · nullableOptional
ClosedBeforestring · date-time · nullableOptional
CreatedSincestring · date-time · nullableOptional
CreatedBeforestring · date-time · nullableOptional
ModifiedSincestring · date-time · nullableOptional
ModifiedBeforestring · date-time · nullableOptional
IsPublishedboolean · nullableOptional
Responses
200

OK

CourseIdstring · uuidOptional
CourseNamestring · nullableOptional
CourseCodestring · nullableOptional
CourseLabelstring · nullableOptional
CourseHookstring · nullableOptional
CatalogIdstring · uuid · nullableOptional
CatalogNamestring · nullableOptional
PublicationStatusstring · nullableOptional
PublicationDatestring · date-time · nullableOptional
PublicationAuthorstring · nullableOptional
PublicationPageIdstring · uuid · nullableOptional
UnitCountinteger · int32 · nullableOptional
ModuleCountinteger · int32 · nullableOptional
ActivityCountinteger · int32 · nullableOptional
EnrollmentCountinteger · int32Optional
EnrollmentCountStartedinteger · int32Optional
EnrollmentCountCompletedinteger · int32Optional
GradebookIdstring · uuid · nullableOptional
GradebookTitlestring · nullableOptional
post/api/courses/search
200

OK

Last updated

Was this helpful?