With the help of this new External Calendar API Endpoint feature, users of CAE LearningSpace will be able to process events (including date, event name and room name) using their software integration components and work with the event information in any way they desire, like:
- forwarding them to external calendar applications
- or presenting it as a static webpage
The External Calendar API Endpoint toggle can be activated in the System Manager, General tab.
This API endpoint can be queried and provide data from the CAE LearningSpace calendar to display outside of the system on a public-facing calendar.
- The calendar is hourly refreshed.
- It refers to current events ('today') and upcoming events (future events of the next 7 days).
If the feature is enabled, the list of all approved events is displayed according to the below:
- starting from 00:00 of the day of the query
- finishing at 23:59 on the 7th day of the query
API endpoint on the following URL: https://<your.learning.space.edu>/w/api/v2/public-calendar.json
{
"events": [
{
"isRecurringSeries": false,
"isPartOfRecurringSeries": true,
"activity": {
"color": "neonCarrot",
"title": "ACLS Testing "
},
"eventStart": "2022-06-13T07:00:00Z",
"note": "Weekly Assessment",
"rooms": [
{
"location": null,
"name": "Sim 1 (Sim Room)"
},
{
"location": null,
"name": "Sim 2 (Sim Room)"
},
{
"location": null,
"name": "Sim 3 (Sim Room)"
},
{
"location": null,
"name": "Sim 4 (Sim Room)"
},
{
"location": null,
"name": "Sim 5 (Sim Room)"
},
{
"location": null,
"name": "Sim 6 (Sim Room)"
}
],
"durationMinutes": 180,
"title": "ACLS Megacode Testing",
"eventEnd": "2022-06-13T10:00:00Z"
},
{
"isRecurringSeries": false,
"isPartOfRecurringSeries": false,
"activity": {
"color": "neonCarrot",
"title": "SON C/O 2019 Assessment"
},
"eventStart": "2022-06-09T07:00:00Z",
"note": null,
"rooms": [
{
"location": null,
"name": "Exam 1 (Exam Room)"
}
],
"durationMinutes": 135,
"title": "Effective Assessment and Communication Skills Event",
"eventEnd": "2022-06-09T09:15:00Z"
}
],
"eventsTo": "2022-06-16T21:59:59Z",
"generatedAt": "2022-06-09T05:57:10Z",
"eventsFrom": "2022-06-08T22:00:00Z"
}
CAE LearningSpace does not generate the external calendar. See details of how to use the API on the External Calendar API Endpoint page.
See further improvements in the Calendar in the Inventory Module Update 2022 Spring Feature notes.
Overview
Content Tools