Dados da API OneRoster acessados pelo School Data Sync

Importante

Ao conectar e disponibilizar os dados da instituição com o School Data Sync, você reconhece que está autorizado a compartilhar esses dados com a Microsoft e se compromete a aderir aos padrões de governança de dados da sua organização.

OneRoster API (Application Programming Interfaces) é um formato Industry Standard, da 1EdTech (anteriormente IMS Global), para troca de dados do Sistema de Informação do Aluno (SIS) / Sistemas de Gerenciamento de Alunos (SMS). Usando esse método de sincronização, você pode se conectar diretamente ao SIS/SMS usando as APIs do OneRoster 1.1 baseadas em REST desenvolvidas pelo seu provedor de SIS/SMS. O suporte à API permite que você sincronize dados diretamente em vez de usar arquivos CSV (Comma Separated Value).

A lista a seguir é fornecida para ajudá-lo a entender melhor quais dados estão sendo acessados ao se conectar ao seu SIS/SMS por meio da API do OneRoster.

Pontos de extremidade necessários da API OneRoster 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	/registros	status	dateLastModified	/enrollments?offset=0&limit=5000&filter=status='active'/enrollments?filter=dateLastModified>'{deltaDateTime}'

Pontos de extremidade de API opcionais para School Data Sync

Observação

Para os dados opcionais para dados demográficos, relacionamentos de contato de alunos e sinalizadores de usuários de alunos, a capacidade de incluir ou não esses dados é baseada nos recursos de dados opcionais com suporte do seu perfil de provedor OneRoster do SIS/SMS. Se o provedor SIS/SMS também oferecer suporte a esses dados, você verá o botão de alternância (padrão) selecionado para incluir dados adicionais. Você pode selecionar o botão de alternância para desativar, se desejar. Se a alternância estiver indisponível, mostrada, mas desativada e não disponível para interação, isso significa que o perfil do provedor atualmente não dá suporte ao fornecimento desses dados.

Observação

Se o perfil do provedor mostrar dados demográficos, contatos ou sinalizadores demográficos do usuário como indisponíveis e você quiser que eles ofereçam suporte a esse recurso, entre em contato com seu provedor e solicite a adição de suporte para habilitar o SDS a ingerir os dados e permitir que você habilite os cenários e experiências que os dados suportam. 

Ação	URL	Propriedades de Filtro Necessárias	Filtro Opcional/Recomendado	Exemplos
GetAllCourses	/cursos	status	dateLastModified	/cursos?offset=0&limit=5000&filter=status='active'/courses?filter=dateLastModified>'{deltaDateTime}'
GetAllDemographics	/demografia	status	dateLastModified	/demografia?offset=0&limit=5000&filter=status='active'/demographics?filter=dateLastModified>'{deltaDateTime}'