The SIS APIs provides the ability to quickly create terms, courses, users, and enrollments in LearningStudio, either on an ad hoc basis or to synchronise the LMS with your Student Information System. These APIs use SOAP, where XML files are sent and received; they are nearly instantaneous, and serve as an alternative to using batch files, which are typically processed overnight and can take up to 24 hours to complete. (See the SIS overview for information on which method to use.)
Here are some examples of when you would use the SIS API:
- On-demand enrollment. Create an application with a dashboard that allows students to self-enroll in courses.
- SIS Adaptors. Create a back-end process that monitors for changes in the SIS and immediately reflects them in LearningStudio, without having to upload batch files to LearningStudio.
- Teacher-selected Course Development. Create an application that allows teachers to choose homework or supplementary courses (e.g., MyLabs Plus) to copy and enroll their students in.
The following information is useful when working with the SIS API:
Operations can be synchronous or asynchronous. When using the API for single operations, such as creating a single course or a single user, the operation will be synchronous. When using the API for operations that involve multiple users, the operation will be asynchronous. See Synchronous vs. Asynchronous for more information.
Synchronous operations can take time. Synchronous operations calls can take up to 10 seconds or more depending on system load.
The API does not use sessions. Although SOAP protocols allow for session-based operations, the SIS API does not support sessions. Each request is processed individually, similar to REST APIs.
The API partially follows the IMS Enterprise Specification 1.1. The Users and Enrollments services follow a subset of the IMS Enterprise Specification v1.1; however, the Terms and Courses services use a proprietary format.