With the help of the 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:
This process is not a two-way flow of information: data modified or created in an external calendar cannot be returned/sent back to LearningSpace. |
The External Calendar API Endpoint can be enabled by a toggle in the System Module, 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.
With the feature enabled, when starting a query, events that
CAE LearningSpace does not generate an external calendar application: the raw data can be used to generate entries to an external (3rd party) calendar. |
Information for software developers of our customers:
use an HTTP GET request to retrieve the external facing calendar contents as a JSON document
the API endpoint is https://<your.learning.space.edu>/w/api/v2/public-calendar.json
the API definition is available as an OpenAPI specification at: https://<your.learning.space.edu>/w/api/v2/openapi.yml
write code to parse the event list to present it or process it according to your requirements
{ "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" } |
See also External Calendar API Endpoint in System Manager - Feature Notes and How to utilize External Calendar API Endpoint. |