Aller au contenu

Sai do curso

POST/api/courses/{courseId}/leave

Auth
Jeton requis
Clé d’API:
courses:delete
X-CommunityId
X-CommunityId Envoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.

O aluno matriculado (`enrolled`) sai do curso: a matrícula vira `cancelled`, o conteúdo volta a ser só o sumário e o **progresso é mantido** (`POST /api/courses/{courseId}/enroll` reabre a mesma matrícula e ele continua de onde parou). Sair não remove pontos nem revoga certificado.

- Quem **concluiu** o curso (`completed`) não sai: **409**. - Sair de novo, ou duas chamadas ao mesmo tempo, responde 200 igual e não altera mais nada. - Sem matrícula, 404. Papéis: owner, admin, moderador, membro e financeiro (a equipe em pré-visualização não tem matrícula). - Corrida com a conclusão da última aula: só uma vence. Se a conclusão ganha, a saída responde 409; se a saída ganha, a matrícula fica `cancelled`, não há conclusão nem certificado e `POST .../progress` responde 409.

Paramètres

NomEmplacementTypeDescription
courseIdobligatoirepathstring (uuid)

En-têtes

NomTypeDescription
X-CommunityIdfacultatifstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Corps de la requête application/json

La spécification ne déclare pas les champs de ce corps (un envoi multipart, par exemple). Consultez le guide du thème.

Réponses

StatutDescription
200Saiu do curso (ou já tinha saído).
401Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`).
403Autenticado, mas sem permissão para esta operação.
404Recurso não encontrado.
409O curso já foi concluído; quem concluiu não sai.
500Erro interno do servidor.

Exemple curl

curl -X POST "https://api.memberfy.net/api/courses/<courseId>/leave" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'