重要事項
藉由與學校資料同步連線並提供機構資料，即表示您確認您有權與 Microsoft 共用此資料，並承諾遵守貴組織的資料控管標準。
OneRoster API (應用程式介面) 是一種行業Standard格式，來自 1EdTech (以前稱為 IMS Global) ，用於交換學生資訊系統 (SIS) /學生管理系統 (SMS) 資料。 使用此同步處理方法，您可以使用 SIS/SMS 提供者所開發的 REST 型 OneRoster 1.1 API 直接連線到 SIS/SMS。 API支援可讓您直接同步資料，而不是使用CSV (逗號分隔值) 檔案。
下列清單可協助您進一步瞭解透過 OneRoster API 連線到 SIS/SMS 時所存取的資料。
學校資料所需的 OneRoster API 端點
| 動作 | URL | 必要的篩選屬性 | 可選/推薦過濾器 | 範例 |
|---|---|---|---|---|
| GetAll學術會議 | /學術會議 | 狀態 | 日期最後修改 | /academicSessions？offset=0&limit=5000&filter=status='active'/academicSessions？filter=dateLastModified>'{deltaDateTime}' |
| GetAllOrgs | /組織 | 狀態 | 日期最後修改 | /orgs？offset=0&limit=5000&filter=status='active'/orgs？filter=dateLastModified>'{deltaDateTime}' |
| 取得所有使用者 | /用戶 | 狀態 | 日期最後修改 | /users？offset=0&limit=5000&filter=status='active'/users？filter=dateLastModified>'{deltaDateTime}' |
| GetAll類別 | /班級 | 狀態 | 日期最後修改 | /classes？offset=0&limit=5000&filter=status='active'/classes？filter=dateLastModified>'{deltaDateTime}' |
| GetAllEnrollments | /註冊 | 狀態 | 日期最後修改 | /enrollments？offset=0&limit=5000&filter=status='active'/enrollments？filter=dateLastModified>'{deltaDateTime}' |
學校資料同步的選擇性 API 端點
注意事項
針對人口統計資料、學生連絡人關係和學生使用者旗標的選擇性資料片段，您是否能夠包含此資料，是根據 SIS/SMS OneRoster 提供者設定檔中支援的選擇性資料功能而定。 如果 SIS/SMS 提供者也支援此資料，您會看到切換 (預設 ) 選取 開啟 以包含其他資料。 如果您願意，您可以選擇切換開關以關閉。 如果切換不可用、顯示但關閉且無法進行互動，這表示提供者的設定檔目前不支援提供該資料。
注意事項
如果提供者的配置檔將人口統計、連絡人或使用者人口統計標誌顯示為無法使用，而且您想要它們支援該功能， 請連絡您的提供者並要求新增支援 ，以啟用 SDS 內嵌數據，並允許您啟用數據支援的案例和體驗。
| 動作 | URL | 必要的篩選屬性 | 可選/推薦過濾器 | 範例 |
|---|---|---|---|---|
| 取得所有課程 | /課程 | 狀態 | 日期最後修改 | /courses？offset=0&limit=5000&filter=status='active'/courses？filter=dateLastModified>'{deltaDateTime}' |
| GetAll人口統計 | /人口統計 | 狀態 | 日期最後修改 | /demographics？offset=0&limit=5000&filter=status='active'/demographics？filter=dateLastModified>'{deltaDateTime}' |