GET api/courses/allCourses

Get all available courses on bksbLIVE2 system.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of OrgCourse
NameDescriptionTypeAdditional information
IsLicensed

If the course is licensed for your organisation.

 boolean

None.
CourseGroup

Course Group

 CourseGroup

None.
CourseName

Course Name

 string

None.
CourseSubject

Course Subject

 string

None.
CourseIconUrl

Course Icon

 string

None.

Response Formats

application/json, text/json

Sample: 
[
  {
    "IsLicensed": true,
    "CourseGroup": {
      "CourseGroupId": 1,
      "CourseGroupName": "sample string 2",
      "CourseGroupIconUrl": "sample string 3"
    },
    "CourseName": "sample string 2",
    "CourseSubject": "sample string 3",
    "CourseIconUrl": "sample string 4"
  },
  {
    "IsLicensed": true,
    "CourseGroup": {
      "CourseGroupId": 1,
      "CourseGroupName": "sample string 2",
      "CourseGroupIconUrl": "sample string 3"
    },
    "CourseName": "sample string 2",
    "CourseSubject": "sample string 3",
    "CourseIconUrl": "sample string 4"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfOrgCourse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrgCourse>
    <CourseName>sample string 2</CourseName>
    <CourseSubject>sample string 3</CourseSubject>
    <CourseIconUrl>sample string 4</CourseIconUrl>
    <CourseGroup>
      <CourseGroupId>1</CourseGroupId>
      <CourseGroupName>sample string 2</CourseGroupName>
      <CourseGroupIconUrl>sample string 3</CourseGroupIconUrl>
    </CourseGroup>
    <IsLicensed>true</IsLicensed>
  </OrgCourse>
  <OrgCourse>
    <CourseName>sample string 2</CourseName>
    <CourseSubject>sample string 3</CourseSubject>
    <CourseIconUrl>sample string 4</CourseIconUrl>
    <CourseGroup>
      <CourseGroupId>1</CourseGroupId>
      <CourseGroupName>sample string 2</CourseGroupName>
      <CourseGroupIconUrl>sample string 3</CourseGroupIconUrl>
    </CourseGroup>
    <IsLicensed>true</IsLicensed>
  </OrgCourse>
</ArrayOfOrgCourse>