Aller au contenu

Renomeia, reordena ou agenda um módulo do curso

PUT/api/courses/module/{moduleId}

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.

Owner ou admin da comunidade do `X-CommunityId`. O módulo precisa ser de um curso dessa comunidade; de outra, 404. Só muda o que vier no corpo. **Liberação:** `availableAt` (data fixa) **ou** `availableAfterDays` (0 a 3650, dias após a primeira matrícula), as mesmas regras de `POST /api/courses/module`. Enviar um com valor limpa o outro (trocar de modo); `null` limpa o enviado; os dois com valor, 400. Aula já concluída continua aberta, e as demais recalculam na leitura seguinte.

Paramètres

NomEmplacementTypeDescription
moduleIdobligatoirepathstring (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

NomTypeDescription
titlefacultatifstringmax 255
orderfacultatifinteger≥ 0
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. · ≥ 0, ≤ 3650

Réponses

StatutDescription
200Módulo atualizado.
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.
404Recurso não encontrado.
500Erro interno do servidor.

Exemple curl

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