Ausência temporária

Como ativar/desativar ausência temporária para uma pessoa utilizando API?

Para ativar o modo ausência temporária para uma pessoa utilizando API, siga os passos abaixo:

Autenticação: Primeiro obtenha um token de autenticação com permissão de realizar essa operação;
Obtenha o userid: Obtenha código do usuário. É possível obter este identificador na página Acesso > Pessoas ou utilizando consulta de API's como nos exemplos que estão disponíveis em Listar pessoas;
Para ativar o modo ausência temporária: Defina o período de ausência e utilize o endpoint Ausência temporária (troque seu_endereco.do.zeev pelo endereço que você usa para acessar o Zeev);
Para desativar o modo ausência temporária: Utilize o endpoint Ausência temporária(troque seu_endereco.do.zeev pelo endereço que você usa para acessar o Zeev);

Definir pessoa como em ausência temporária por código (Auth)

patch

Autorizações

AuthorizationstringObrigatório

Utilize um token válido de usuário para realizar a requisição

Parâmetros de rota

userIdinteger · int32Obrigatório

Código identificador da pessoa

Corpo

absenceStartDatestring · date-timeOpcional

Data de início da ausencia temporária

absenceEndDatestring · date-timeOpcional

Data de término da ausencia temporária

Respostas

200

Sucesso.

400

Solicitação ou dados da solicitação são inválidas

401

Pessoa não autorizada

403

Pessoa não tem permissão de executar essa operação

404

O registro não foi encontrado

429

Muitas requisições em um determinado período de tempo

500

Ocorreu algum erro interno no servidor

patch

/api/2/users/{userid}/absent/enter

PATCH /api/2/users/{userid}/absent/enter HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 91

{
  "absenceStartDate": "2025-12-15T13:39:26.937Z",
  "absenceEndDate": "2025-12-15T13:39:26.937Z"
}

{
  "success": true,
  "userId": 1,
  "username": "text",
  "isAbsent": true
}

Exemplo de requisição para ativar ausência temporária

let userId = 486;
let absenceBegin = "2024-01-02T18:00:00.000Z"
let absenceEnd = "2024-02-01T09:00:00.000Z"

const myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Accept", "application/json");
myHeaders.append("Authorization", "Bearer TOKEN_DO_USUARIO");

const raw = JSON.stringify({
  "absenceStartDate": abscenceBegin,
  "absenceEndDate": abscenceEnd
});

const requestOptions = {
  method: "PATCH",
  headers: myHeaders,
  body: raw
};

try {
  const response = await fetch(`https://seu_endereco.do.zeev/api/2/users/${userId}/absent/enter`, requestOptions);
  const result = await response.json();
  console.log(result)
} catch (error) {
  console.error(error);
};

Tirar uma pessoa de ausência temporária por código (Auth)

patch

Autorizações

AuthorizationstringObrigatório

Utilize um token válido de usuário para realizar a requisição

Parâmetros de rota

userIdinteger · int32Obrigatório

Código identificador da pessoa

Respostas

200

Sucesso.

400

Solicitação ou dados da solicitação são inválidas

401

Pessoa não autorizada

403

Pessoa não tem permissão de executar essa operação

404

O registro não foi encontrado

429

Muitas requisições em um determinado período de tempo

500

Ocorreu algum erro interno no servidor

patch

/api/2/users/{userid}/absent/leave

PATCH /api/2/users/{userid}/absent/leave HTTP/1.1
Host: seu_endereco.do.zeev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "userId": 1,
  "username": "text",
  "isAbsent": true
}

Exemplo de requisição para desativar ausência temporária

let userId = 486;

const myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Authorization", "Bearer TOKEN_DO_USUARIO");

const requestOptions = {
  method: "PATCH",
  headers: myHeaders
};

try {
  const response = await fetch(`https://seu_endereco.do.zeev/api/2/users/${userId}/absent/leave`, requestOptions);
  const result = await response.text();
  console.log(result)
} catch (error) {
  console.error(error);
};

Links relacionados:

AnteriorAcessos PróximoGrupos de manutenção

Atualizado há 1 ano