A tela de resposta (membro logado)
GET/api/surveys/{id}/form
- Auth
- Requiere token
- Clave de API:
- No acepta clave de API
- X-CommunityId
X-CommunityIdEnví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.
Qualquer papel da comunidade. Introdução, modo, seções e perguntas, e se a pessoa já respondeu. Rascunho é 404; agendada ou antes de `startsAt`, 422 `notYetOpen` ("esta pesquisa ainda não começou"); fora do público com o link público desligado, 403 ("esta pesquisa não é para você"); encerrada vem com `status: closed`. `responseMode` diz se é obrigatória. `spaceId`, `spaceSlug` e `sectionSlug` dizem onde a pesquisa mora, para montar o link `/{sectionSlug}/{spaceSlug}/{id}` sem procurar espaço por espaço; vêm nulos para quem responde pelo link público sem abrir o espaço (o app fica na tela do link).
Parámetros
| Nombre | Dónde | Tipo | Descripción |
|---|---|---|---|
idobligatorio | path | string (uuid) |
Headers
| Nombre | Tipo | Descripción |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Respuestas
| Código | Descripción |
|---|---|
200 | A tela. |
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 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
422 | Ainda não começou (agendada ou antes de `startsAt`). |
500 | Erro interno do servidor. |
Ejemplo con curl
curl -X GET "https://api.memberfy.net/api/surveys/<id>/form" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"