Aller au contenu
memberfy
FR

Cria um módulo

POST/api/courses/module

Auth
Jeton requis
Qui peut l’appeler:
owner
admin
Clé d’API:
courses:write
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.

Só owner e admin. O módulo entra no fim do curso (`order` seguinte). Título vazio ou só espaços, 400 com `param = title`; curso de outra comunidade, 404.

**Liberação, opcional, só um dos dois:** `availableAt` (data fixa; ISO 8601 com `Z` ou deslocamento = aquele instante; sem deslocamento = hora de parede no fuso da comunidade; data passada vale e abre na hora) **ou** `availableAfterDays` (inteiro de 0 a 3650: abre à 00:00 no fuso da comunidade do dia que fica N dias depois da **primeira** matrícula de cada aluno). Os dois com valor, data inválida, N negativo, fracionário ou acima de 3650: 400 com `errors[]`. Sem nenhum dos dois, o módulo abre na hora. Para renomear use `PUT /api/courses/module/{moduleId}`; para reordenar todos de uma vez, `PUT /api/courses/{courseId}/modules/order`.

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

NomTypeDescription
courseIdobligatoirestring (uuid)Valid course ID is required
titleobligatoirestringTitle is required
availableAtfacultatifstring (date-time)Data fixa de abertura. Exclusivo com `availableAfterDays`.
availableAfterDaysfacultatifintegerAbre N dias após a primeira matrícula, às 00:00 no fuso da comunidade. Exclusivo com `availableAt`. · ≥ 0, ≤ 3650

Réponses

StatutDescription
201Operação realizada com sucesso.
400Requisição inválida — falha de validação.
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.
500Erro interno do servidor.

Exemple curl

curl -X POST "https://api.memberfy.net/api/courses/module" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{"courseId":"00000000-0000-0000-0000-000000000000","title":"string"}'