Compartilhar via

Dados da API do OneRoster acessados pela sincronização de dados escolares

  • Artigo

Importante

Ao conectar e disponibilizar dados da instituição com a Sincronização de Dados Escolares, você reconhece que está autorizado a compartilhar esses dados com a Microsoft e se comprometer a seguir os padrões de governança de dados da sua organização.

A API do OneRoster (Interfaces de Programação de Aplicativo) é um formato do Industry Standard, da 1EdTech (anteriormente IMS Global), para troca de dados do SIS (Sistema de Informações estudantis) / Sistemas de Gerenciamento de Alunos (SMS). Usando esse método de sincronização, você pode se conectar diretamente ao SIS/SMS usando as APIs oneRoster 1.1 baseadas em REST desenvolvidas pelo provedor SIS/SMS. O suporte à API permite sincronizar dados diretamente em vez de usar arquivos CSV (Valor Separado por Vírgula).

A lista a seguir é fornecida para ajudar você a entender melhor quais dados estão sendo acessados ao se conectar ao SIS/SMS por meio da API do OneRoster.

Pontos de extremidade de 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 /Usuários 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 /Inscrições status Datelastmodified /enrollments?offset=0&limit=5000&filter=status='active'/enrollments?filter=dateLastModified>'{deltaDateTime}'

Pontos de extremidade de API opcionais para sincronização de dados escolares

Observação

Para os dados opcionais para a demografia, as relações de contato do aluno e os sinalizadores de usuário do aluno, a capacidade de você incluir esses dados ou não será baseada nos recursos de dados opcionais compatíveis do seu perfil de provedor SIS/SMS OneRoster. Se o provedor SIS/SMS também der suporte a esses dados, você verá o alternância (padrão) selecionado em para incluir dados adicionais. Você pode selecionar o alternância para desativar, se desejar. Se a alternância não estiver disponível, mostrada, mas desativada e não estiver disponível para interação, isso significa que o perfil do provedor não dá suporte atualmente ao fornecimento dos dados.

Observação

Se o perfil do provedor mostrar a demografia, contatos ou sinalizadores demográficos do usuário como indisponíveis e você quiser que eles dêem suporte a esse recurso, entre em contato com seu provedor e solicite suporte para permitir que o SDS ingera os dados e permita que você habilite os cenários e experimente os suportes de dados. 

Ação URL Propriedades de filtro necessárias Filtro opcional/recomendado Exemplos
GetAllCourses /Cursos status Datelastmodified /courses?offset=0&limit=5000&filter=status='active'/courses?filter=dateLastModified>'{deltaDateTime}'
GetAllDemographics /Demografia status Datelastmodified /demographics?offset=0&limit=5000&filter=status='active'/demographics?filter=dateLastModified>'{deltaDateTime}'