A integração de repasse de notas (GPB) do Instructure OneRoster suporta as configurações de endpoint GPB padrão ou modificada. Isso porque segue mais rigorosamente o OneRoster.especificações de configuração do endpointRecomenda-se a configuração GPB padrão.
Além disso, para melhorar o desempenho, inclua um endpoint de desempenho na sua configuração GPB.
Saiba mais sobre o OneRosterconformidade do endpoint do livro de notas.
Observação:A Instructure é uma consumidora do OneRoster. Para obter as definições de consumidor e provedor do OneRoster, consulte oIntrodução ao OneRoster.
Retorno de Grau Padrão
O endpoint de integração GPB padrão inclui o sourcedId da atribuição ao sincronizar os dados do livro de notas do Canvas para o seu SIS.
Chamada de serviço | Ponto final | Verbo HTTP | Obrigatório |
|---|
obterTodasAsCategorias | /categorias | PEGAR | ✓ |
obterTodosOsItensDeLinha | /itens de linha | PEGAR | ✓ |
obterResultadosParaClasse | /classes/{class_id}/resultados | PEGAR | ✓ |
obterItensDeLinhaParaClasse | /classes/{class_id}/lineItems | PEGAR | ✓ |
obterResultadosParaItemDeLinhaParaClasse | /classes/{class_id}/lineItems/{li_id}/resultados | PEGAR | ✓ |
getResultsForStudentForTurma | /classes/{class_id}/students/{student_id}/results | PEGAR | ✓ |
colocarCategoria | /categories/{id} | COLOCAR | X |
colocarItemDeLinha | /lineItems/{id} | COLOCAR | ✓ |
putResult | /resultados/{id} | COLOCAR | ✓ |
Repasse de notas modificado
O endpoint GPB modificado omite o sourcedId da atribuição ao sincronizar os dados do livro de notas do Canvas para o seu SIS.
Na resposta à solicitação PUT de novos registros, o sourcedId deve ser retornado pelo provedor OneRoster. A integração armazena esses dados para uso futuro em chamadas de API.
Chamada de serviço | Ponto final | Verbo HTTP | Obrigatório |
|---|
obterTodasAsCategorias | /categorias | PEGAR | ✓ |
obterTodosOsItensDeLinha | /itens de linha | PEGAR | ✓ |
obterResultadosParaClasse | /classes/{class_id}/resultados | PEGAR | ✓ |
obterItensDeLinhaParaClasse | /classes/{class_id}/lineItems | PEGAR | ✓ |
obterResultadosParaItemDeLinhaParaClasse | /classes/{class_id}/lineItems/{li_id}/resultados | PEGAR | ✓ |
getResultsForStudentForTurma | /classes/{class_id}/students/{student_id}/results | PEGAR | ✓ |
colocarCategoria | /categories/{id} | COLOCAR | X |
colocarItemDeLinha | /lineItems/{id} | COLOCAR | ✓ |
putResult | /resultados/{id} | COLOCAR | ✓ |
colocarCategoria* | /categorias* | COLOCAR | X |
colocarItemDeLinha* | /itens_de_linha* | COLOCAR | ✓ |
putResult* | /resultados* | COLOCAR | ✓ |
*sourcedId omitido dessas chamadas de API
Pontos finais de retorno de classificação de desempenho
Pelo menos um dos seguintes métodos de endpoint de integração Performance Grade Passback deve ser implementado.
Chamada de serviço | Ponto final | Verbo HTTP | Obrigatório |
|---|
obterCategoriaClasseFiltrada | /categories?filter=metadata.classId='{class_id}' | PEGAR | X* |
obterCategoriasParaClasse | /classes/{class_id}/categories | PEGAR | ✓** |
*Embora não seja estritamente necessário, a implementação deste filtro evita a necessidade de buscar e armazenar em cache todas as categorias.
**Se você não implementar a categoria**metadados.classidEssa implementação é necessária. Ela permite que as classes se associem a uma categoria.