![]() Web access URL: URL where your OneRoster API is accessible for your SIS/SMSĬlient ID that is used to connect to your SIS/SMS OneRoster APIĬlient Secret that is used to connect to your SIS/SMS OneRoster APIĪccess Token URL, if your SIS/SMS OneRoster API is configured for authentication using OAuth2, you need to provide the Access Token URL endpoint that used to connect. For more information, see your specific provider's documentation to obtain or to generate them. ![]() To enable the connection to the OneRoster API for your SIS/SMS, you need to provide the connection credentials. "erFlags" : "freeLunch,homeless,giftedOrTalented“ User flags may appear in any order and aren't case sensitive.įor more information, see the default list of user flag values supported by SDS see Default List of Values: User Flags. The key should be named erFlags and must be formatted as a comma delimited list. User flags are included (when true for the user), or not included if not applicable.įlags are specified as a metadata extension for the user, in a metadata field, following a Key|Value pair. User flags may be specified for student users to indicate their participation in a program or cohort. If reverse data is provided, from a contact relationship guardian record to student in the contact users ‘agents’ field, these records are filtered out. Contacts are more users that are supplied with the /users and association to a student are found in the student’s user record under ‘agents’.įor more information, see the supported student contact relationship roles supported by SDS see Default List of Values: Contact Relationship Roles.įamilyName, givenName, and email are required for users that have contact/guardian roles.Įxpect phone and sms to be in E.164 and + must be included. Student contact relationship may be specified for student users to enhance educator experiences for communication to parents and guardians. Optional user student contact relationships academicSessions?offset=0&limit=5000&filter=status=’active’/academicSessions?filter=dateLastModified>’’ The following list is provided to help you better understand what data is being accessed when connecting to your SIS/SMS via OneRoster API.What endpoints are being accessed when ingesting roster data? The article includes steps needed to request being added as a OneRoster provider, including testing and validation before being placed in test mode first and then eventually in the public list for selection by tenants. Share with your provider the following article Onboarding Guidance for OneRoster API Providers with SDS.Is there information to share with them to participate as a OneRoster provider with SDS? Once the test is successful, the OneRoster Provider status is updated (from test mode to public) and available on list of publicly accessible providers for all tenants. If you run into any issue, work with the provider and SDS POC to get them resolved. Once your tenant is flighted, work with your OneRoster provider, and SDS POC to run tests and ensure that the integration is successful. Share following information when raising the request: Reach out to the Customer support team to flight your tenant and gain access to the API providers currently Test. What do I need to do to see them in the provider list? My provider is not listed in the dropdown and the status here says Test. OneRoster providers status and capabilities Provider name The OneRoster REST APIs (Application Programming Interfaces) are how we can synchronize objects from SIS/SMS that provides OneRoster APIs through the School Data Sync (SDS) platform.įor more information on how to set up your tenant to use OneRoster API as a source, Data Ingestion with OneRoster API. ![]() It also allows you to enhance experiences of the Microsoft 365 products and features. Using the OneRoster API to ingest the data enables you to light up core SDS capabilities for provisioning. ![]() The API support allows you to synchronize data directly instead of using CSV (Comma Separated Value) files. Using this sync method, you can connect directly to your SIS/SMS using the REST-based OneRoster 1.1 APIs developed by your SIS/SMS provider. OneRoster is an Industry Standard format, from IMS Global, for exchange of Student Information System (SIS) / Student Management Systems (SMS) data. ![]()
0 Comments
Leave a Reply. |
Details
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |