External Course

External Course

External course allows you to retrieve the content of an individual course from within the LMS. This can be used to display a course on an external website or intranet. This endpoint requires the External Catalogue feature to be enabled in your LMS tenancy.

Get external course:

Query String Parameters:

Example Response:

{
  "status": "Complete",
  "data": [
      {
        "fullname": "Fraud Awareness",
        "summary": "This program assists all staff in meeting their responsibility to minimize the potential for fraud. More information is available here.",
        "summarytext": "This program assists all staff in meeting their responsibility to minimize the potential for fraud. More information is available here.",
        "contentid": "21",
        "contenttype": "Course",
        "url": "{base_url}/view_course/10",
        "imageurl": "{base_url}/local/acorn_shared/resources/assets/customfile.php/62/course/overviewfiles/0/shutterstock_295052687.jpg",
        "badge": "{base_url}/pluginfile.php/62/badges/badgeimage/8/f1?refresh=8210",
        "completionstatus": "In Progress",
        "coursesections": [
            {
               "name": "Course material",
               "activities": [
                   {
                       "activityid": 231,
                       "name": "Fraud Awareness",
                       "description": "This module assists all staff in meeting their responsibility to minimize the potential for fraud and take responsibility for reporting suspected fraud.",
                       "url": "{base_url}/view_course/5/231",
                       "hidden": false,
                       "type": "scorm",
                       "completionstatus": "Completed",
                       "embedUrl": "{base_url}/local/acorn_coursemanagement/index.php/scorms/43/view",
                  },
                  {
                       "activityid": 234,
                       "name": "Course Feedback",
                       "description": null,
                       "url": "{base_url}/view_course/5/234",
                       "hidden": false,
                       "type": "feedback",
                       "completionstatus": "Incomplete"
                  },
                  {
                       "activityid": 555,
                       "name": "Assignment",
                       "description": null,
                       "url": "{base_url}/view_course/5/555",
                       "hidden": false,
                       "type": "assign",
                       "completionstatus": "Incomplete"
                   }
            ]
      },
      {
             "name": "Optional activities",
             "activities": [
                  {
                        "activityid": 1529,
                        "name": "Guidelines and Tools",
                        "description": "Guidelines and Tools",
                        "url": "{base_url}/view_course/5/1529",
                        "hidden": false,
                        "type": "label",
                        "completionstatus": "Completed"
                   },
                  {
                        "activityid": 1532,
                        "name": "Course setup checklist",
                        "description": "Steps taken to setup the course.",
                        "url": "{base_url}/view_course/5/1532",
                        "hidden": true,
                        "type": "checklist",
                        "completionstatus": "Incomplete",
                        "listItems": [
                            {
                                 "text": "Step One"
                             },
                            {
                                 "text": "Step Two"
                             },
                            {
                                 "text": "Step Three"
                             }
                         ]
                      },
                     {
                         "activityid": 1520,
                         "name": "Discussion forum",
                         "description": "Discuss the course with other participants.",
                         "url": "{base_url}/view_course/5/1520",
                         "hidden": false,
                         "type": "forum",
                         "completionstatus": "Incomplete"
                      },
                     {
                          "activityid": 1530,
                          "name": "Course Goal",
                          "description": "Course Goal",
                          "url": "{base_url}/view_course/5/1530",
                          "hidden": false,
                          "type": "page",
                          "completionstatus": "Incomplete",
                          "pageContent": "Goals are important to everybody:\n"
                      }
                ]
          }
     ],
     "completioncriteria": {
           "condition": "completeAllActivities",
           "activityids": [
               "231",
               "234",
               "555"
           ]
      },
      "programs": [
          {
              "id": 10,
              "name": "Onboarding Journey"
          },
          {
              "id": 13,
              "name": "Program 2"
           }
      ],
      "category": {
              "id": 2,
              "name": "Core Learning"
       },
       "tags": [
           {
              "id": 25,
              "name": "Agency Staff"
           }
       ],
       "customfields": [
            {
               "name": "Catering",
               "data": "Tea & Coffee"
            },
           {
               "name": "Legislation",
               "data": "OH&S Act"
          }
     ]
     "timecreated": "2020-12-20T13:01:58+00:00",
     "timemodified": "2021-04-09T13:47:16+00:00"
  }
]