학교 데이터 동기화를 통해 액세스되는 OneRoster API 데이터
중요
학교 데이터 동기화를 사용하여 기관 데이터를 연결하고 사용할 수 있도록 하면 이 데이터를 Microsoft와 공유하고 organization 데이터 거버넌스 표준을 준수할 권한이 있음을 인정합니다.
OneRoster API(애플리케이션 프로그래밍 인터페이스)는 SIS(학생 정보 시스템) /SMS(학생 관리 시스템) 데이터를 교환하기 위해 1EdTech(이전 IMS Global)의 산업 표준 형식입니다. 이 동기화 방법을 사용하면 SIS/SMS 공급자가 개발한 REST 기반 OneRoster 1.1 API를 사용하여 SIS/SMS에 직접 연결할 수 있습니다. API 지원을 사용하면 CSV(쉼표로 구분된 값) 파일을 사용하는 대신 데이터를 직접 동기화할 수 있습니다.
OneRoster API를 통해 SIS/SMS에 연결할 때 액세스되는 데이터를 더 잘 이해할 수 있도록 다음 목록이 제공됩니다.
학교 데이터에 필요한 OneRoster API 엔드포인트
작업 | URL | 필수 필터 속성 | 선택적/권장 필터 | 예제 |
---|---|---|---|---|
GetAllAcademicSessions | /academicSessions | 상태 | dateLastModified | /academicSessions?offset=0&limit=5000&filter=상태='active'/academicSessions?filter=dateLastModified>'{deltaDateTime}' |
GetAllOrgs | /orgs | 상태 | dateLastModified | /orgs?offset=0&limit=5000&filter=상태='active'/orgs?filter=dateLastModified>'{deltaDateTime}' |
GetAllUsers | /사용자 | 상태 | dateLastModified | /users?offset=0&limit=5000&filter=상태='active'/users?filter=dateLastModified>'{deltaDateTime}' |
GetAllClasses | /클래스 | 상태 | dateLastModified | /classes?offset=0&limit=5000&filter=상태='active'/classes?filter=dateLastModified>'{deltaDateTime}' |
GetAllEnrollments | /등록 | 상태 | dateLastModified | /enrollments?offset=0&limit=5000&filter=상태='active'/enrollments?filter=dateLastModified>'{deltaDateTime}' |
학교 데이터 동기화에 대한 선택적 API 엔드포인트
참고
인구 통계, 학생 연락처 관계 및 학생 사용자 플래그에 대한 선택적 데이터 조각의 경우 이 데이터를 포함하거나 포함하지 않는 기능은 SIS/SMS OneRoster 공급자 프로필에서 지원되는 선택적 데이터 기능을 기반으로 합니다. SIS/SMS 공급자가 이 데이터도 지원하는 경우 추가 데이터를 포함하기 위해 토글(기본값)이 켜 기로 선택됩니다. 원하는 경우 해제할 토글을 선택할 수 있습니다. 토글을 사용할 수 없는 경우 표시되었지만 꺼져 있고 상호 작용에 사용할 수 없는 경우 공급자의 프로필이 현재 해당 데이터 제공을 지원하지 않습니다.
참고
공급자의 프로필에 인구 통계, 연락처 또는 사용자 인구 통계 플래그를 사용할 수 없음으로 표시하고 해당 기능을 지원하려는 경우 공급자에게 문의하고 SDS 가 데이터를 수집할 수 있도록 지원 추가를 요청하고 데이터가 지원하는 시나리오 및 환경을 사용하도록 설정할 수 있습니다.
작업 | URL | 필수 필터 속성 | 선택적/권장 필터 | 예제 |
---|---|---|---|---|
GetAllCourses | /코스 | 상태 | dateLastModified | /courses?offset=0&limit=5000&filter=상태='active'/courses?filter=dateLastModified>'{deltaDateTime}' |
GetAllDemographics | /인구 통계 | 상태 | dateLastModified | /demographics?offset=0&limit=5000&filter=상태='active'/demographics?filter=dateLastModified>'{deltaDateTime}' |