Zum Inhalt springen

Prévia do prazo de guarda (Presença e Encomendas)

GET/api/spaces/{id}/retention-preview

Auth
Token erforderlich
Wer darf:
owner
admin
API-Schlüssel:
community:read
X-CommunityId
X-CommunityId Sende die X-CommunityId der Community, in der die Operation stattfindet.
Die Beschreibungen der Endpoints stammen aus der API-Spezifikation und sind vorerst auf Portugiesisch. Die Oberfläche drumherum ist übersetzt.

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.

Parameter

NameOrtTypBeschreibung
idPflichtpathstring (uuid)
monthsoptionalqueryintegerPrazo proposto, de 6 a 60 meses. Sem ele, o prazo configurado.

Header

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

Antworten

StatusBeschreibung
200A prévia.
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.
500Erro interno do servidor.

curl-Beispiel

curl -X GET "https://api.memberfy.net/api/spaces/<id>/retention-preview" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"