Aller au contenu

Comenta no curso ou numa aula

POST/api/courses/{courseId}/comments

Auth
Jeton requis
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.

Sem `lessonId`, comenta na **conversa do curso**; com `lessonId`, na da aula. O comentário aparece na hora (sem aprovação). Com `parentId`, responde a um comentário de topo da **mesma conversa**; responder a uma resposta é **400**.

- Texto de 1 a 2000 caracteres; vazio, em branco ou só tags (`<script>`), 400 em `content`. Nenhuma tag é guardada. - **Quem escreve:** a equipe (owner, admin, moderador, financeiro) e o aluno matriculado (a equipe em pré-visualização pode, sem pontos). O financeiro escreve como o moderador. Quem não está matriculado ou saiu, 403. - Curso em rascunho ou arquivado: **409**, ninguém escreve. - Pontos `COMMENT_POST` (resposta: `REPLY_COMMENT`) ao aluno, uma vez por comentário. Nenhum e-mail ou notificação sai. - `lessonId` de outro curso, ou curso de outra comunidade: 404.

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

NomTypeDescription
contentobligatoirestringmin 1, max 2000
lessonIdfacultatifstring (uuid)Ausente ou `null` = conversa do curso.
parentIdfacultatifstring (uuid)Comentário de topo a que responde.

Réponses

StatutDescription
201Comentário criado.
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.
409O curso está em rascunho ou arquivado.
500Erro interno do servidor.

Exemple curl

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