Prévia do prazo de guarda (Presença e Encomendas)
GET/api/spaces/{id}/retention-preview
- Auth
- Richiede un token
- Chi può:
- owner
- admin
- Chiave API:
- community:read
- X-CommunityId
X-CommunityIdInvia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.
Quantos registros do space a rotina diária de retenção anonimizaria com o prazo proposto (`months`), sem mudar nada: para a confirmação antes de salvar `moduleConfig.<módulo>.retentionMonths`. Só owner e admin, no space da comunidade do `X-CommunityId`; space de outro módulo, removido ou de outra comunidade: 404. Presença conta visitas de visitantes (`guestVisits`) e pré-cadastros (`visitorInvitations`); Encomendas conta encomendas fechadas (`parcels`), suas fotos e registros do histórico. A contagem é a de hoje; um prazo **menor** que o em vigor (`currentMonths`) só passa a valer em `effectiveAt` (7 dias depois de salvo), e até lá vale o anterior.
Parametri
| Nome | Dove | Tipo | Descrizione |
|---|---|---|---|
idobbligatorio | path | string (uuid) | |
monthsfacoltativo | query | integer | Prazo proposto, de 6 a 60 meses. Sem ele, o prazo configurado. |
Header
| Nome | Tipo | Descrizione |
|---|---|---|
X-CommunityIdfacoltativo | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Risposte
| Codice | Descrizione |
|---|---|
200 | A prévia. |
400 | Requisição inválida — falha de validaçã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. |
500 | Erro interno do servidor. |
Esempio con curl
curl -X GET "https://api.memberfy.net/api/spaces/<id>/retention-preview" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"