Detalhes de uma unidade

Request

Retorna uma unidade específica.

Security

BasicAuth

Path

idstringrequired

ID da unidade.

curl -i -X GET \
  -u '<username>:<password>' \
  'https://api-docs.tiquetaque.app/_mock/openapi/sites/{id}'

Responses

Unidade encontrado.

Bodyapplication/json

_idstring

Identificador único do recurso, gerado internamente.

_createdstring(IsoDateTimeTzModel)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}[+-][0-2]\d:[0-...

Example:"2024-09-29T08:00-03:00"

_updatedstring(IsoDateTimeTzModel)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}[+-][0-2]\d:[0-...

Example:"2024-09-29T08:00-03:00"

_etagstring(EtagModel)

Hash a ser usado como conteúdo do header If-Match para realizar atualização e remoções de documentos

namestring

Nome da unidade.

Example:"Loja Matriz"

geofence_locationobject

Cerca virtual. Ponto lng/lat em conjunto com um raio define uma área onde é permitido o registro de ponto para funcionários vinculados à esta unidade.

timezonestring(TimezoneModel)

Fuso Horário utilizado para controle do horário de registro de ponto.

Enum:"America/Araguaina""America/Bahia""America/Belem""America/Boa_Vista""America/Campo_Grande""America/Cuiaba""America/Eirunepe""America/Noronha""America/Fortaleza""America/Maceio"

Example:"America/Sao_Paulo"

employeesArray of strings

Lista de IDs de funcionários. Vincula os funcionários à esta unidade para todos efeitos.

Example:

[
  "5f5bc225b511a6edec2891f7",
  "0c5bc225b511a6edec289199"
]

Response

{
  "_id": "string",
  "_created": "2024-09-29T08:00-03:00",
  "_updated": "2024-09-29T08:00-03:00",
  "_etag": "string",
  "name": "Loja Matriz",
  "geofence_location": {
    "radius_meters": 30,
    "location": [ … ]
  },
  "timezone": "America/Sao_Paulo",
  "employees": [
    "5f5bc225b511a6edec2891f7",
    "0c5bc225b511a6edec289199"
  ]
}