由學校數據同步存取的 OneRoster API 數據
重要事項
藉由連線並讓機構數據可供學校數據同步使用，您會確認您有權與 Microsoft 共用此數據，並認可遵守貴組織的數據控管標準。
OneRoster API (應用程式開發介面) 是業界標準格式，來自 1EdTech (先前的 IMS 全域) ，用於交換學生資訊系統 (SIS) /學生管理系統 (SMS) 數據。 使用此同步處理方法，您可以使用 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=status='active'/academicSessions？filter=dateLastModified>'{deltaDateTime}' |
| GetAllOrgs | /orgs | 狀態 | dateLastModified | /orgs？offset=0&limit=5000&filter=status='active'/orgs？filter=dateLastModified>'{deltaDateTime}' |
| GetAllUsers | /使用者 | 狀態 | dateLastModified | /users？offset=0&limit=5000&filter=status='active'/users？filter=dateLastModified>'{deltaDateTime}' |
| GetAllClasses | /類 | 狀態 | dateLastModified | /classes？offset=0&limit=5000&filter=status='active'/classes？filter=dateLastModified>'{deltaDateTime}' |
| GetAllEnrollments | /入學 人數 | 狀態 | dateLastModified | /enrollments？offset=0&limit=5000&filter=status='active'/enrollments？filter=dateLastModified>'{deltaDateTime}' |
學校數據同步的選擇性 API 端點
注意事項
針對人口統計、學生聯繫人關係和學生使用者旗標的選擇性數據片段，您包含此數據或不包含此數據的能力，將會以 SIS/SMS OneRoster 提供者設定檔中支援的選用數據功能為基礎。 如果 SIS/SMS 提供者也支援此資料，您會看到切換 (預設) 選取 [ 開啟 ] 以包含其他數據。 您可以視需要選取要關閉的切換開關。 如果切換無法使用、顯示但關閉，且無法進行互動，這表示提供者的配置檔目前不支援提供該數據。
注意事項
如果提供者的配置檔將人口統計、聯繫人或使用者人口統計旗標顯示為無法使用，而且您希望他們支援該功能，請 連絡您的提供者並要求新增支援 以啟用 SDS 來內嵌數據，並讓您啟用數據支援的案例和體驗。
| 動作 | URL | 必要的篩選屬性 | 選擇性/建議的篩選 | 範例 |
|---|---|---|---|---|
| GetAllCourses | /課程 | 狀態 | dateLastModified | /courses？offset=0&limit=5000&filter=status='active'/courses？filter=dateLastModified>'{deltaDateTime}' |
| GetAllDemographics | /人口 | 狀態 | dateLastModified | /demographics？offset=0&limit=5000&filter=status='active'/demographics？filter=dateLastModified>'{deltaDateTime}' |