APIs in LearningSpace

This page lists and outlines APIs (Application Programming Interfaces) of LearningSpace that allow other software to programmatically interact with the LearningSpace system.

Raw Data API

Developers and system integrators might want to write applications (similar to an SQL query) to interact with the data API interface of in order to retrieve responses of specified Activities in XML format.

Use case: results of an exam need to be analyzed using external tools (e.g. Excel or STATISTICA), or archived outside of LearningSpace.

The data retrieved from the API interface of includes

• the UCIDs of learners
• the case IDs
• the activity IDs
• submits are also grouped according to virtual sections if the Case contains virtual section tags.

External Calendar API Endpoint

With the help of the External Calendar API Endpoint feature, users of 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.

Learner Schedule API

This API allows an export of the times (i.e. rounds in ) the learner is scheduled for, given a timeframe.

Use case: using this data to enter into an external calendar software or to provide notifications (e.g. text messages to a phone) for learners about their scheduled exams. Output format: XML

With specifying an email address (learner email address saved in ) and a date range, the Student Calendar API returns the scheduled Activity titles and the start and end dates of the round(s) the learner has been scheduled to.

Video Recording Control API

This API is providing video related functionality in LearningSpace to external applications. Such external applications can use simple HTTP GET commands to control the video recording capabilities of LearningSpace. LearningSpace also provides download access to recorded video content.

Use case: external tools are developed by the customer to perform scheduled or automated recordings using the LearningSpace A/V system.

Goal of Integration

The end user wants to control the Recording State of the room, from within the room. Recording State control means that users can start and stop video recordings in . Annotations can also be added to the recordings to tag the recording with notes, remarks or participant names.

While Recoding State can be controlled by a logged in Video Control privilege user, from a client computer connected to , the end user might want to have a more direct way to control the Recording State. It is equally important to be able to understand the status of Recording in the room, for those in the room.

A similarly important piece of information regarding video recording privacy and access control is being able to assign the video recording to an Activity (a building block in tying together participants, schedule, curriculum and access control).

Finally, adding notes or participant names to the recording from the Touch Panel to the recording in allows for easier lookup and identification of the recording, while also provides a way to direct debriefing sessions or provide performance-related feedback to participants.

Typical Use Case

The end user in the simulation room uses the touch panel to check the status of Recording (recording or not recording). Before starting a recording, end user has the ability to select an Activity defined in to assign the recording to. During recording, the touch panel can be used to add annotations to the recording. Finally, the recording can be stopped to re-set the recording state of the room.

Components of the integration

• Touch Panel
• Touch Panel Master Controller
• Recording API