Get a List of Courses
Get a list of courses in your organization.
Request URI
GET /courses?
Response Body
<Courses> <Course> <Id>string [max length 50]</Id> <Code>string [max length 50]</Code> <Name>string [max length 255]</Name> <Active>true/false</Active> <ForSale>true/false</ForSale> <OriginalId>integer</OriginalId> <Description>string</Description> <EcommerceShortDescription>string</EcommerceShortDescription> <EcommerceLongDescription>string</EcommerceLongDescription> <CourseCodeForBulkImport>string [max length 255]</CourseCodeForBulkImport> <Price>integer</Price> <AccessTillDate>integer</AccessTillDate> <CourseTeamLibrary>true/false</CourseTeamLibrary> </Course> <Course> ... </Course> </Courses>
Note:
- OriginalId can be used as part of a single sign in process to take a user straight into a particular course.
- ForSale indicates if the course has been marked for sale via the Litmos UI
Get a Course
Get a single course record.
Request URI
GET /courses/{courseid}?
Response Body
<Course xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <Id>string [max length 50]</Id> <Code>string [max length 50]</Code> <Name>string [max length 255]</Name> <Active></Active> <ForSale>true/false</ForSale> <OriginalId></OriginalId> <Description></Description> <EcommerceShortDescription>string</EcommerceShortDescription> <CommerceLongDescription>string</CommerceLongDescription> <CourseCodeForBulkImport></CourseCodeForBulkImport> <Price></Price> <AccessTillDate>datetime [iso 8601 format]</AccessTillDate> <CourseTeamLibrary>true/false</CourseTeamLibrary> <Tags></Tags> </Course>
Get Course Details
Get all the details of a course including arrays of data associated to the course .
Request URI
GET /courses/{courseid}/details?
Response Body (XML)
<Course> <Id>string [max length 50]</Id> <OriginalId>integer</OriginalId> <Code>string [max length 50]</Code> <Name>string [max length 255]</Name> <Description>string</Description> <CourseCodeForBulkImport>string [max length 50]</CourseCodeForBulkImport> <Active>true/false</Active> <IncludeInLibrary>true/false</IncludeInLibrary> <CompleteInOrder>true/false</CompleteInOrder> <CourseImageURL i:nil="true"/> <CreatedDate>YYYY-MM-DDTHH:MM:SS.SS</CreatedDate> <UpdatedDate>YYYY-MM-DDTHH:MM:SS.SS</UpdatedDate> <CreatedBy>string [max length 50]</CreatedBy> <UpdatedBy>string [max length 50]</UpdatedBy> <ForSale>true/false</ForSale> <EcommerceShortDescription/> <EcommerceLongDescription/> <Price>0.00</Price> <AccessTillDate i:nil="true"/> <AccessTillDays i:nil="true"/> <DueDate>YYYY-MM-DDTHH:MM:SS.SS</DueDate> <DueDateSpan>integer</DueDateSpan> <ComplianceDate i:nil="true"/> <ComplianceDateSpan i:nil="true"/> <ComplianceRetake i:nil="true"/> <Languages xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <a:string>Cultureid</a:string> <a:string>Cultureid</a:string> </Languages> <Topics> <a:string>string [max length 200]</a:string> <a:string>string [max length 200]</a:string> </Topics> <Tags xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <a:string>string [max length 30]</a:string> <a:string>string [max length 30]</a:string> </Tags> <CoursePreRequisites xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <a:string>string [max length 50]</a:string> </CoursePreRequisites> <LearningPathPreRequisites xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <a:string>string [max length 50]</a:string> </LearningPathPreRequisites> <Skills xmlns:a="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <a:string>string [max length 100]</a:string> </Skills> <Social>true/false</Social> <DiscussionForum>true/false</DiscussionForum> <AdvCourseCustomField1/> <AdvCourseCustomField2/> <AdvCourseCustomField3/> <AdvCourseCustomField4/> <AdvCourseCustomField5/> <AdvCourseCustomField6/> <AdvCourseCustomField7/> <AdvCourseCustomField8/> <AdvCourseCustomField9/> <AdvCourseCustomField10/> <AllModulesNewWindow>true/false</AllModulesNewWindow> <Certificate>true/false</Certificate> <BoostsReleased>integer</BoostsReleased> <BoostFrequency>integer</BoostFrequency> </Course>
Get Modules in a Course
Get a list of all modules in a course.
Request URI
GET /courses/{courseid}/modules?
Response Body (XML)
<Modules> <Module> <Id>string [max length 50]</Id> <Code>string [max length 20]</Code> <Name>string [max length 255]</Name> <Description>string [optional, max length 2000]</Description> </Module> </Modules>
Get Users Assigned to a Course
Get a list of all users assigned to a course.
Request URI
GET /courses/{courseid}/users?
Response Body
<Users> <User> <Id>string [max length 50]</Id> <UserName>string [max length 255]</UserName> <FirstName>string [max length 100]</FirstName> <LastName>string [max length 100]</LastName> <Completed>true/false</Completed> <PercentageComplete>integer (decimal)</PercentageComplete> <CompliantTill>2025-01-01T04:37:06.23 [ISO8601]</CompliantTill> <DueDate>2021-12-31T04:37:06.23 [ISO8601]</DueDate> <AccessTillDate></AccessTillDate> </User> <User> ... </User> </Users>
Get all User Results for a Course
Get all results of users assigned to a course.
Request URI
GET /courses/{courseid}/users?
Response (XML)
<Users xmlns:i="http://www.w3.org/2001/XMLSchema-instance"> <User> <Id>string [max length 50]</Id> <UserName>string [max length 255]</UserName> <FirstName>string [max length 100]</FirstName> <LastName>string [max length 100]</LastName> <Completed>true/false</Completed> <PercentageComplete>decimal</PercentageComplete> <CompliantTill i:nil="true"/> <DueDate i:nil="true"/> <AccessTillDate i:nil="true"/> </User> <User> ..... </User> </Users>
Delete a Course
Delete a course record.
Request URI
DELETE /courses/{courseid}?
Response Header
200 OK