APIs in LearningSpace

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

Data API Access

The LearningSpace Data API provides access to various data points from the system, allowing customers to retrieve information about Activities, Cases, Events, Students, video recordings, and more.

The Data API access can be manually toggled on or off on the Security NEW of the System Manager.

Once Data API access has been enabled, the Institution’s System developers can continue based on the API documentation provided by LearningSpace support.

Once Data API Access is activated, the 'All events are accessible via API by default' checkbox will also appear (checked by default) to make all events available by default within the system.

If the 'All events are accessible via API by default' option is unchecked in the System manager, only the events selected in the Calendar Modulewill be added to the range of Data API.

Both the events created in the Calendar and in Advanced Scheduling can be saved as API Access-capable events.

TIP: Notes can also be edited and saved in case of an Advanced scheduled event.

Content provided by the Data API

A detailed specification for the actual development can be utilized via the generated OpenAPI descriptor, which describes the API contents. This specification is available at:
https://[learning.space.url]/api/openapi/views.yaml.

Available Endpoints

1. Activities

   • GET /api/data/v1/activities

     • Retrieve a list of activities.

     • Response includes activity details like ID, title, start, and end dates.

2. Cases

   • GET /api/data/v1/cases

     • Retrieve a list of cases.

     • Response includes case details such as patient name, presenting complaint, case ID, and case number.

3. Events of an Activity

   • GET /api/data/v1/events/activity/{ActivityID}

     • Retrieve events related to a specific activity.

     • Requires ActivityID as input.

4. Nbome Events

   • GET /api/data/v1/events/nbome

     • Retrieve events marked as ready for NBOME integration.

5. Student Assessments (NBOME)

   • GET /api/data/v1/student-assessments/nbome/event/{EventID}

     • Retrieve student assessment results for a specific event.
       The results adhere to the NBOME format.

       IMPORTANT: If two SPs are assigned to one station of a scheduled event, every Case item of the section will appear duplicated in the Data API (one with the name of the first SP, the other with the name of the second SP, respectively).

6. Student Video Recordings for NBOME

   • GET /api/data/v1/student-video-recordings/nbome/event/{EventID}

     • Retrieve student video recordings for a specific NBOME event.

7. Students

   • GET /api/data/v1/students

     • Retrieve a list of students.

     • Response includes student details like ID, full name, and NBOME ID.

8. Student Video Recordings for Event and Case

   • GET /api/data/v1/student-video-recordings/event/{EventID}/case/{CaseID}/student/{StudentID}

     • Retrieve video recordings for a specific student, event, and case.

9. Video Files for Video Recording

   • GET /api/data/v1/video-files/video-recording/{VideoRecordingID}

     • Retrieve a list of video files associated with a specific video recording.

       When requesting video file content, you will be provided with links to the video recording files in MP4 format.

Response Format

Each response will include the following:

• success: A boolean indicating if the request was successful.

• total: The total number of records returned.

• offset: The offset value, useful for pagination.

• limit: The number of records returned in the current request.

• data: An array containing the data objects related to the request.

Authentication

The API uses Bearer Authentication. You will need to provide a valid JWT token in the Authorization header of your request.

External Calendar API Endpoint

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

By 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 provides video-related functionality in LearningSpace to external applications. Such external applications can use simple HTTP GET commands to control LearningSpace's video recording capabilities. LearningSpace also provides download access to recorded video content.

❔ Use case: The customer develops external tools 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. Annotations can also be added to the recordings to tag them with notes, remarks, or participant names.

While the Recording State can be controlled by a logged-in Video Control privilege user from a client computer connected, the end user might want to have a more direct way to control the Recording State. It is equally important for those in the room to understand the status of Recording 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 enables easier lookup and identification of the recording, and 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 Recording status (recording or not recording). Before starting a recording, the end user can select an Activity defined to assign the recording. During recording, the touch panel can be used to add annotations. Finally, the recording can be stopped to reset the room's recording state.

Components of the integration

• Touch Panel

• Touch Panel Master Controller

• Recording API

Privacy API

This API of LearningSpace allows a device to control the room’s privacy settings directly from within the room, using a wall-mounted touch panel (a network device panel).

Setup process

1. Add the Touch Panel Master Controller computer to LearningSpace as an additional station.

2. Add the Touch Panel Master Controller station to all the rooms that need to be controlled.

3. Use curl to verify the operation of the API at http://learning.space.address/w/api/v2/privacy.cgi,

   It acts/performs just like pressing the privacy buttons on the UI.

Note: If the computer is not a station in any room in LearningSpace, nothing happens: since the station's IP is used to look up the associated room, this API does not allow non-stations to control the privacy of LearningSpace.

Blacked-out Camera Views - SP Privacy Mode Active