Matricular uma pessoa num curso gratuito (equipe)
POST/api/courses/{id}/enrollments
- Auth
- Richiede un token
- Chiave API:
- courses:write
- X-CommunityId
X-CommunityIdInvia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.
A equipe (owner, admin, moderador) matricula alguém da comunidade num curso publicado que não cobra dessa pessoa, com as regras do `POST /api/courses/{id}/enroll` dela: idempotente (matricular de novo devolve a matrícula que já existe, sem pontos a mais), quem cancelou recomeça, vagas (409). Curso pago para a pessoa: 403 `actions.paidItem` (só gratuito). Curso não publicado: 403 `actions.itemNotAvailable`. É a ação `course.enroll` do nó "Ação da plataforma" dos workflows.
Parametri
| Nome | Dove | Tipo | Descrizione |
|---|---|---|---|
idobbligatorio | path | string (uuid) |
Header
| Nome | Tipo | Descrizione |
|---|---|---|
X-CommunityIdfacoltativo | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corpo della richiesta application/json
| Nome | Tipo | Descrizione |
|---|---|---|
memberIdobbligatorio | string (uuid) | A pessoa da comunidade. |
Risposte
| Codice | Descrizione |
|---|---|
200 | Matriculada (`created` true na primeira vez). |
400 | Requisição inválida — falha de validação. |
401 | Token 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`). |
403 | Sem o papel, curso pago para a pessoa (`actions.paidItem`) ou não publicado (`actions.itemNotAvailable`). |
404 | Recurso não encontrado. |
409 | Sem vagas. |
500 | Erro interno do servidor. |
Esempio con curl
curl -X POST "https://api.memberfy.net/api/courses/<id>/enrollments" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{"memberId":"00000000-0000-0000-0000-000000000000"}'