Skip to content

Cria uma nova unidade

Request

Cria uma nova unidade. Unidades agrupam funcionários e podem ser utilizadas para vincular funcionários aos aparelhos TiqueTaque

Security
BasicAuth
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"
]
curl -i -X POST \
  -u '<username>:<password>' \
  https://api-docs.tiquetaque.app/_mock/openapi/sites \
  -H 'Content-Type: application/json' \
  -d '{
    "_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": [
        -23.550513,
        -46.633309
      ]
    },
    "timezone": "America/Sao_Paulo",
    "employees": [
      "5f5bc225b511a6edec2891f7",
      "0c5bc225b511a6edec289199"
    ]
  }'

Responses

Dados atualizados com sucesso.

Bodyapplication/json
_idstring
_createdstring(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

_statusstring
Example:"OK"
Response
{
  "_id": "string",
  "_created": "2024-09-29T08:00-03:00",
  "_etag": "string",
  "_status": "OK"
}