Aller au contenu

Cria um locker

POST/api/parcels/spaces/{spaceId}/lockers

Auth
Jeton requis
Qui peut l’appeler:
owner
admin
Clé d’API:
parcels:write
X-CommunityId
X-CommunityId Envoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.

Só owner e admin. O nome é obrigatório (até 60 caracteres) e único entre os lockers do space, sem diferenciar maiúsculas (409 se já existe). `position` vai para o fim se omitido; `active` é `true` se omitido. Cria: `201`.

Paramètres

NomEmplacementTypeDescription
spaceIdobligatoirepathstring (uuid)

En-têtes

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

Corps de la requête application/json

NomTypeDescription
nameobligatoirestringmax 60
activefacultatifboolean
positionfacultatifinteger≥ 0

Réponses

StatutDescription
201Locker criado.
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.
409Conflito com o estado atual do recurso.
500Erro interno do servidor.

Exemple curl

curl -X POST "https://api.memberfy.net/api/parcels/spaces/<spaceId>/lockers" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{"name":"string"}'