Configuração do espaço de pesquisas
GET/api/surveys/spaces/{spaceId}
- Auth
- Exige token
- Chave de API:
- surveys:read
- X-CommunityId
X-CommunityIdEnvie o X-CommunityId da comunidade em que a operação acontece.
Qualquer papel com acesso ao espaço (as regras de visibilidade dele valem: sem acesso, 403). Devolve o modo (`single` = "Uma pesquisa", `multi` = "Várias pesquisas", o padrão) e `canManageSpace`. Em `single` traz a pesquisa do espaço em `data.survey`: para owner e admin, a visão da equipe (`Survey`, com a árvore); para os demais, o formulário (`SurveyForm`, com `alreadyResponded`) se já aberta e a pessoa estiver no público ou o link público estiver ligado, senão `null`. Sem pesquisa ainda, `null`. O modo também vai em `moduleConfig.mode` na criação e na edição do espaço.
Parâmetros
| Nome | Onde | Tipo | Descrição |
|---|---|---|---|
spaceIdobrigatório | path | string (uuid) |
Headers
| Nome | Tipo | Descrição |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Respostas
| Código | Descrição |
|---|---|
200 | A configuração. |
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 | O espaço não é do módulo `surveys`. |
500 | Erro interno do servidor. |
Exemplo com curl
curl -X GET "https://api.memberfy.net/api/surveys/spaces/<spaceId>" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"