If you are working for a LearningStudio client institution, you will need to contact your Strategic Customer Operations (SCO) team in order to get started with SIS APIs. They will provide you with a username and password to use with these APIs (see Authentication & Security for more information).
If you are only working on the Sandbox Campus, create a support request with the API Support team.
Your SCO team will require the following information from you to activate the SIS APIs for your institution. Unless otherwise specified, all information is required. If you have any questions on how these settings work, please speak with your SCO team.
|Yes||Users will receive email notifications.|
|No||Users will not receive email notifications.|
Email settings can be different for each enrollable node, user role type (for example, student or faculty), or action (for example, enrollment confirmation, drop confirmation, course waitlist, etc.). These emails can also pass the following user-specific information:
- User Name
- User Login ID
- User Password
- Course(s) Enrolled
Auto-generated emails must be configured during the initial setup of the API, and can be updated by your SCO Consultant. You can create your own email "templates" and send them to your Client Services Representative. Use the Templates for Auto-generated Emails page as a starting point.
Generate User Passwords?
|Yes||A random password will be auto-generated for each new user. Leave the password field blank in the SIS Integration request. If you are sending email notifications, then the auto-generated password will be included in the instruction email sent to the user.|
|No||A password must be supplied in the request for the new user.|
Update User Properties?
Select how user properties will be updated in LearningStudio if it is determined that a value differs between an API request and the value in LearningStudio when the request is processed.
|Yes||Any change in the SIS Integration request to user's name, password, email address, or any of the optional property fields will be updated to the user information in LearningStudio.|
|No||Any differences will be ignored and not updated.|
|Selectively Update||Only the designated user property changes will be updated. For example, a user's email address may be updated, but the password remains unchanged.|
The following user properties are affected by this configuration:
- First, middle, and last names
- Login ID (also called "username")
- Daytime and evening phone numbers
- Address (including street, city, state/province, postal code, country)
For example, if this configuration = Yes and a user email address is different in the batch file from the value already in LearningStudio, the LearningStudio value will be changed to match the value in the data file. If the configuration = No, then the difference is ignored and the LearningStudio data is unchanged.
Source of Student Email Addresses?
If you've opted to have LearningStudio email the user, we need to know what email address to use for them. This setting only applies if the (1) Send Email Notifications? setting is set to "Yes" and (2) the user's email address is not set to update in the Update User Properties settin.
|LearningStudio Database||We'll email the student at the address we have in LearningStudio, whether or not it matches the incoming information.|
|API Request||We'll email the student at the address in the API request, whether or not it matches the value in LearningStudio.|
Note: If you are setting the system to always update user properties, or selectively update at least the email address (see previous section), the email address will be updated in LearningStudio before an email is sent.