Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
Importante
Ao ligar e disponibilizar dados da instituição ao School Data Sync, reconhece que está autorizado a partilhar estes dados com a Microsoft e a comprometer-se a cumprir os padrões de governação de dados da sua organização.
A API oneRoster (Application Programming Interfaces) é um formato de Standard da Indústria, da 1EdTech (anteriormente IMS Global), para troca de dados do Sistema de Informação de Estudantes (SIS)/Sistemas de Gestão de Estudantes (SMS). Com este método de sincronização, pode ligar-se diretamente ao seu SIS/SMS através das APIs oneRoster 1.1 baseadas em REST desenvolvidas pelo seu fornecedor de SIS/SMS. O suporte da API permite-lhe sincronizar dados diretamente em vez de utilizar ficheiros CSV (Valores Separados por Vírgulas).
A lista seguinte é fornecida para o ajudar a compreender melhor que dados estão a ser acedidos ao ligar ao seu SIS/SMS através da API OneRoster.
Pontos Finais da API do OneRoster Necessários para Dados Escolares
| Ação | URL | Propriedades de Filtro Necessárias | Filtro Opcional/Recomendado | Exemplos |
|---|---|---|---|---|
| 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 | /users | status | dateLastModified | /users?offset=0&limit=5000&filter=status='active'/users?filter=dateLastModified>'{deltaDateTime}' |
| GetAllClasses | /classes | status | dateLastModified | /classes?offset=0&limit=5000&filter=status='active'/classes?filter=dateLastModified>'{deltaDateTime}' |
| GetAllEnrollments | /enrollments | status | dateLastModified | /enrollments?offset=0&limit=5000&filter=status='active'/enrollments?filter=dateLastModified>'{deltaDateTime}' |
Pontos Finais de API Opcionais para o School Data Sync
Observação
Para os dados opcionais para dados demográficos, relações de contacto de estudantes e sinalizadores de utilizadores de estudantes, a capacidade de incluir ou não estes dados baseia-se nas capacidades de dados opcionais suportadas do perfil de fornecedor do OneRoster SIS/SMS. Se o Fornecedor de SIS/SMS também suportar estes dados, verá o botão de alternar (predefinição ) selecionado Ativado para incluir dados adicionais. Pode selecionar o botão de alternar para desativar, se assim o desejar. Se o botão de alternar estiver indisponível, apresentado mas desativado e não estiver disponível para interação, significa que o perfil do fornecedor não suporta atualmente a disponibilização dos mesmos.
Observação
Se o perfil do fornecedor mostrar os sinalizadores demográficos demográficos, contactos ou utilizadores como indisponíveis e quiser que suportem essa funcionalidade, contacte o seu fornecedor e peça suporte para permitir que o SDS ingira os dados e permita que ative os cenários e experiências suportadas.
| Ação | URL | Propriedades de Filtro Necessárias | Filtro Opcional/Recomendado | Exemplos |
|---|---|---|---|---|
| GetAllCourses | /courses | status | dateLastModified | /courses?offset=0&limit=5000&filter=status='active'/courses?filter=dateLastModified>'{deltaDateTime}' |
| GetAllDemographics | /demographics | status | dateLastModified | /demographics?offset=0&limit=5000&filter=status='active'/demographics?filter=dateLastModified>'{deltaDateTime}' |