Доступ к данным API OneRoster с помощью school Data Sync
Важно!
Подключая данные учреждений и делая их доступными с помощью School Data Sync, вы подтверждаете, что имеете право делиться данными с корпорацией Майкрософт и обязуетесь соблюдать стандарты управления данными вашей организации.
OneRoster API (Интерфейсы программирования приложений) — это отраслевой стандартный формат, от 1EdTech (ранее IMS Global), для обмена данными системы информации о учащихся (SIS) и системах управления учащимися (SMS). С помощью этого метода синхронизации можно подключаться непосредственно к SIS/SMS с помощью ИНТЕРФЕЙСОВ API OneRoster 1.1 на основе REST, разработанных поставщиком SIS/SMS. Поддержка API позволяет синхронизировать данные напрямую, а не использовать csv-файлы (значения с разделимы-запятыми).
Следующий список поможет вам лучше понять, к каким данным обращается при подключении к SIS/SMS через API OneRoster.
Обязательные конечные точки API OneRoster для учебных данных
| Действие | URL-адрес | Обязательные свойства фильтра | Необязательный или рекомендуемый фильтр | Примеры |
|---|---|---|---|---|
| GetAllAcademicSessions | /academicSessions | status | dateLastModified | /academicSessions?offset=0&limit=5000&filter=status='active'/academicSessions?filter=dateLastModified>'{deltaDateTime}' |
| GetAllOrgs | /orgs | status | dateLastModified | /orgs?offset=0&limit=5000&filter=status='active'/orgs?filter=dateLastModified>'{deltaDateTime}' |
| GetAllUsers | /Пользователей | status | dateLastModified | /users?offset=0&limit=5000&filter=status='active'/users?filter=dateLastModified>'{deltaDateTime}' |
| GetAllClasses | /Классы | status | dateLastModified | /classes?offset=0&limit=5000&filter=status='active'/classes?filter=dateLastModified>'{deltaDateTime}' |
| GetAllEnrollments | /Регистрации | status | dateLastModified | /enrollments?offset=0&limit=5000&filter='active'/enrollments?filter=dateLastModified>'{deltaDateTime}' |
Необязательные конечные точки API для синхронизации данных в учебном заведении
Примечание.
Для дополнительных фрагментов данных для демографических данных, связей контактов учащихся и флагов пользователей учащиеся возможность включать эти данные или не включать эти данные будет зависеть от поддерживаемых дополнительных возможностей данных из вашего профиля поставщика OneRoster SIS/SMS. Если поставщик SIS/SMS также поддерживает эти данные, вы увидите переключатель (по умолчанию ) для включения дополнительных данных. При желании можно выбрать переключатель, чтобы отключить его. Если переключатель недоступен, отображается, но отключен и недоступен для взаимодействия, это означает, что профиль поставщика в настоящее время не поддерживает предоставление этих данных.
Примечание.
Если в профиле поставщика отображаются демографические данные, контакты или демографические флаги пользователей как недоступные и вы хотите, чтобы они поддерживали эту функцию, обратитесь к поставщику и запросите добавление поддержки , чтобы включить SDS для приема данных и разрешить вам сценарии и возможности, поддерживаемые данными.
| Действие | URL-адрес | Обязательные свойства фильтра | Необязательный или рекомендуемый фильтр | Примеры |
|---|---|---|---|---|
| GetAllCourses | /Курсы | status | dateLastModified | /courses?offset=0&limit=5000&filter=status='active'/courses?filter=dateLastModified>'{deltaDateTime}' |
| GetAllDemographics | /Демография | status | dateLastModified | /demographics?offset=0&limit=5000&filter=status='active'/demographics?filter=dateLastModified>'{deltaDateTime}' |