Pearson
Always Learning

The SIS API SOAP messages can be either synchronous or asynchronous. Synchronous calls return data immediately and are used when a request has a single transaction, whereas asynchronous calls may process the operation at a later time and are used when multiple transactions are passed in a single request. Not all SIS services support multiple transactions and so are synchronous by default.

Synchronous Messages

The synchronous requests are best used for applications where the user is expecting a response quickly. All terms and courses requests are synchronous, as are all user and enrollment requests that involve only one user and one enrollment. If you want to make synchronous changes for more than one user or more than enrollment, you can accomplish this by making multiple requests.

To make synchronous User and Enrollment requests, use the ProcessSingleRequest message.

Asynchronous Messages

During periods of high activity, such as when your online campus is starting up or at the beginning of a semester, you can use the User Management web service to perform bulk operations, allowing you to create and enroll many students in a single operation. The data is processed within a 24 hour window.

Only the User and Enrollment services offer asynchronous capability. The response of the SOAP message contains a Job ID, which can be used in the Administrative Pages to locate and identify the status of the request and its results.

To make asynchronous User and Enrollment requests, use the ProcessRequest message.

2515 reads
Always Learning
Pearson