O que esse endpoint de API faz

A API de Inscrições do Curso inscreve ou cancela a inscrição de um usuário ou grupo em um curso. Quando usado, os administradores veem o usuário ou grupo adicionado ou removido da guia relevante na página de detalhes do curso. Os alunos veem o curso adicionado ou removido da guia Atribuído a mim.

• Pontos finais
• Grupo de todos
• Inscrever usuário
• Grupo de inscrição
• Cancelar a inscrição do usuário
• Cancelar a inscrição do grupo

Pontos finais

• PUT /courses/{courseId}/users/{userId}- inscrever um único usuário em um curso
• PUT /courses/{courseId}/groups/{groupId}- inscrever um grupo de usuários em um curso
• DELETE /courses/{courseId}/users/{userId}- cancelar a inscrição de um único usuário em um curso
• DELETE /courses/{courseId}/groups/{groupId}- cancelar a inscrição de um grupo de usuários em um curso

Grupo de todos

Para inscrever o grupo Todos (ou seja, cada usuário em sua conta do Reach 360) em um curso, use everyone para o groupId

Inscrever usuário

PUT /courses/{courseId}/users/{userId}

Resposta de sucesso

204 “Sem conteúdo”

Códigos de erro específicos do endpoint

• course_not_found- não é possível inscrever o usuário no curso porque o curso não existe
• user_not_found- não é possível inscrever o usuário no curso porque o usuário não existe

Grupo de inscrição

PUT /courses/{courseId}/groups/{groupId}

Resposta de sucesso

204 “Sem conteúdo”

Códigos de erro específicos do endpoint

• course_not_found- não é possível inscrever o grupo no curso porque o curso não existe
• group_not_found- não é possível inscrever o grupo no curso porque o grupo não existe

Cancelar a inscrição do usuário

DELETE /courses/{courseId}/users/{userId}

Resposta de sucesso

204 “Sem conteúdo”

Códigos de erro específicos do endpoint

• course_not_found- não é possível cancelar a inscrição do usuário no curso porque o curso não existe
• user_not_found- não é possível cancelar a inscrição do usuário no curso porque o usuário não existe

Cancelar a inscrição do grupo

DELETE /courses/{courseId}/groups/{groupId}

Resposta de sucesso

204 “Sem conteúdo”

Códigos de erro específicos do endpoint

• course_not_found- não é possível cancelar a inscrição do grupo no curso porque o curso não existe
• group_not_found- não é possível cancelar a inscrição do grupo no curso porque o grupo não existe