Zum Inhalt springen

Define o raio permitido (cerca virtual) do espaço de ponto

PUT/api/time-tracking/spaces/{spaceId}/geofence

Auth
Token erforderlich
API-Schlüssel:
Kein API-Schlüssel möglich
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.

Owner e admin (os demais, 403 `geofenceDenied`); o espaço precisa estar ligado a um estabelecimento (409 `noEstablishment`). Um ponto (latitude e longitude; `address` é só o rótulo digitado), o raio em metros (10 a 50.000) e o modo: `BLOCK` recusa a marcação fora do raio ou sem localização (422 com `errors`, e a tentativa fica registrada para a gestão, sem virar marcação nem consumir NSR); `FLAG` grava a marcação com o selo "fora do raio" e a distância, visíveis no espelho e no CSV (nunca no AFD nem no AEJ). Sem cerca, tudo como antes: nada recusa a marcação. A responsabilidade pela regra é da empresa.

Parameter

NameOrtTypBeschreibung
spaceIdPflichtpathstring (uuid)

Header

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

Request-Body application/json

NameTypBeschreibung
latitudePflichtnumber≥ -90, ≤ 90
longitudePflichtnumber≥ -180, ≤ 180
radiusMetersPflichtinteger≥ 10, ≤ 50000
modePflichtBLOCK | FLAG
addressoptionalstringmax 255

Antworten

StatusBeschreibung
200O espaço, com `geofence`.
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`).
403Só a gestão do ponto (owner, admin, financeiro): `timeTracking.errors.managementOnly`; quem não tem cadastro de empregado: `notEmployee`; sessão de suporte do SuperAdmin: `supportSession`.
404Recurso não encontrado.
409Conflito com o estado atual do recurso.
422Dado inválido (CPF ou CNPJ com dígito errado, dia, período, campo obrigatório, pessoa sem acesso ao espaço, CPF do responsável ausente).

curl-Beispiel

curl -X PUT "https://api.memberfy.net/api/time-tracking/spaces/<spaceId>/geofence" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{"latitude":10,"longitude":10,"radiusMeters":10,"mode":"BLOCK"}'