Saltar al contenido

Avalia a aula (1 a 5 estrelas, com comentário opcional)

PUT/api/courses/lesson/{lessonId}/rating

Auth
Requiere token
Quién puede:
owner
admin
moderator
Clave de API:
courses:write
X-CommunityId
X-CommunityId Envía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.

Aluno **matriculado** (`enrolled` ou `completed`) com papel owner, admin, moderador ou membro, numa aula **liberada** para ele (aula travada pela sequência ou pela data, **409** com o motivo; a equipe passa as travas). Sem matrícula, 403; aula de outra comunidade ou excluída, 404.

**Uma avaliação por pessoa e aula, editável:** a primeira responde **201**; chamar de novo substitui as estrelas (200). `comment` é texto puro de até 500 caracteres: ausente, o comentário não muda; `null` ou vazio, apaga.

Quem avalia vê só a própria avaliação (`userRating` em cada aula de `GET /api/courses/{identifier}`). A equipe vê média, número e distribuição em `GET /api/courses/{courseId}/ratings` e os comentários em `GET /api/courses/lesson/{lessonId}/ratings`. Com `lessonRatingsPublic` ligado no curso, os alunos também veem a média e o número de cada aula (`ratingSummary`).

Parámetros

NombreDóndeTipoDescripción
lessonIdobligatoriopathstring (uuid)

Headers

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

Cuerpo de la solicitud application/json

NombreTipoDescripción
ratingobligatoriointeger≥ 1, ≤ 5
commentopcionalstringmax 500

Respuestas

CódigoDescripción
200Avaliação gravada (201 na primeira, 200 ao editar).
201Avaliação gravada (201 na primeira, 200 ao editar).
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.
409Aula travada pela sequência ou pela data do módulo.
500Erro interno do servidor.

Ejemplo con curl

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