External Catalogue External Catalogue

External Catalogue

Mounika Vukkadam Mounika Vukkadam

External Catalogue

The external catalogue allows you to retrieve content from within the LMS in order to display it on an external website or intranet. This endpoint requires the External Catalogue feature to be enabled in your LMS tenancy.

 

Get external catalogue content:

Description
Returns all content within the external catalogue.
Request Method GET
Request URL {{base_url}}/local/acorn_coursemanagement/index.php/api/1/external_catalogue/{{tenancy_id}}
Authorisation Header Bearer {api_key}

 

Query String Parameters:

Parameter Data Type Details
username string optional, the username of the user viewing the catalogue
nameFilter string optional, filter the results by fullname
contentType string

optional, filter the results by contenttype

Available Values:

  • course
  • live learning
  • resource
  • video
  • program
  • page
  • partnered content
programId integer optional, filter the results by program
categoryId integer optional, filter the results by category
page integer optional, specify the page number for pagination purposes
perPage integer

optional, specify the number of results per page, 16 is the default

showHidden boolean

optional, if true hidden content will be included

showDeactivated boolean

optional, if true deactivated content will be included

 

Example Response:

{
"status": "Complete",
"data": {
"items": [
{
"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": "10",
"contenttype": "Course",
"url": "{base_url}/view_course/10",
"imageurl": "",
"badge": "{base_url}/pluginfile.php/63/badges/badgeimage/10/f1?refresh=4854",
"completionstatus": "Completed",
"programs": [
{
"id": 10,
"name": "Onboarding Journey"
},
{
"id": 13,
"name": "Program 2"
}
],
"category": null,
"tags": [
{
"id": 2,
"name": "Introduction"
},
{
"id": 25,
"name": "Agency Staff"
}
],
"customfields": [],
"cost": 10000,
"duration": "",
"timecreated": "2019-01-06T16:14:41+00:00",
"timemodified": "2019-09-09T13:47:16+00:00"
},
{
"fullname": "Safety Workshop",
"summary": "Learn the basics of safety in the workplace.",
"summarytext": "Learn the basics of safety in the workplace.",
"contentid": "35",
"contenttype": "Live Learning",
"url": "{base_url}/view_facetoface/35",
"imageurl": "{base_url}/local/acorn_shared/resources/assets/customfile.php/74/course/overviewfiles/0/safety.jpg",
"badge": "",
"completionstatus": "In Progress",
"programs": [],
"category": {
"id": 2,
"name": "Core Learning"
},
"tags": [],
"customfields": [
{
"name": "Catering",
"data": "Tea & Coffee"
},
{
"name": "Legislation",
"data": "OH&S Act"
}
],
"cost": 0,
"duration": "1h ",
"timecreated": "2020-07-21T11:05:08+00:00",
"timemodified": "2020-07-21T11:05:08+00:00"
},
{
"fullname": "27722",
"summary": "",
"summarytext": "",
"contentid": 32,
"contenttype": "Page",
"url": "{base_url}/page/32",
"imageurl": "{base_url}/local/acorn_shared/resources/assets/customfile.php/1/content_pages_cover/content_pages_cover_32/0//Screenshot%20%281%29.png",
"badge": "",
"completionstatus": null,
"programs": [],
"category": null,
"tags": [],
"customfields": [],
"cost": 0,
"duration": "",
"timecreated": "2022-05-13T04:53:05+00:00",
"timemodified": "2022-05-13T04:53:05+00:00"
},
{
"fullname": "Suggested Learning",
"summary": "Suggested learning for excellent employees.",
"summarytext": "Suggested learning for excellent employees.",
"contentid": 35,
"contenttype": "Resource",
"url": "{base_url}/catalogue?tab=resources&query=Suggested Learning&id=35",
"imageurl": "{base_url}/local/acorn_shared/resources/assets/customfile.php/1/content_resources_cover/content_resources_cover_35/0//Suggested%20Learning.png",
"badge": "",
"completionstatus": "Viewed",
"programs": [
{
"id": 6,
"name": "Suggested Learning"
}
],
"category": {
"id": 5,
"name": "Foundational"
},
"tags": [],
"customfields": [],
"cost": 2000,
"duration": "20m 20s",
"timecreated": "2019-10-16T23:42:56+00:00",
"timemodified": "2019-10-16T23:42:56+00:00"
},
{
"fullname": "Welcome Video",
"summary": "Welcome to the agency.",
"summarytext": "Welcome to the agency.",
"contentid": 12,
"contenttype": "Video",
"url": "{base_url}/catalogue?tab=videos&query=Welcome Video&id=12",
"imageurl": "{base_url}/local/acorn_shared/resources/assets/customfile.php/1/content_videos_cover/content_videos_cover_12/0//IMG_90B76E3BE8E5-1.jpeg",
"badge": "",
"completionstatus": "In Progress",
"programs": [
{
"id": 10,
"name": "Onboarding Journey"
}
],
"category": null,
"tags": [
{
"id": 25,
"name": "Agency Staff"
}
],
"customfields": [
{
"name": "Catering",
"data": "Tea & Coffee"
}
],
"cost": 0,
"duration": "",
"timecreated": "2020-07-27T14:25:33+00:00",
"timemodified": "2020-07-27T14:25:33+00:00"
}
],
"total": 4,
"next_page_url": "{base_url}/local/acorn_coursemanagement/index.php/external_catalogue/1?page=2",
"previous_page_url": null,
"per_page": "2",
"last_page": 2
}
}

Add comment

Please sign in to leave a comment.