Ausências

Para manipulação de ausências no sistema

Cadastrar ausências para um profissional

POST https://escala.med.br/api/v2/partner/absence

Para criar uma nova ausência de um profissional em uma escala.

Parâmetros

Nome	Tipo	Descrição
employee_email	string	O e-mail do profissional ao qual será adicionada a ausência
schedule_name	string	O nome exato da escala ao qual a ausência será adicionada
start_date	string	A data de início da ausência, no formato YYYY-mm-dd
end_date	string	A data de término da ausência, no formato YYYY-mm-dd
description	string	A descrição desta ausência, por exemplo: 'férias', 'licença'. É apenas descritivo e não impacta no resultado.

Chamada

curl --location 'https://escala.med.br/api/v2/partner/absence' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer F1D46BFA29256EA6CBA75F826E2082916C06285DE8FA18FE2AEB5B46A4CBBABB' \
--header 'Cookie: XDEBUG_SESSION=PHPSTORM; laravel_session=eyJpdiI6IlQ3a2wzRE5kQ3RKVWhUS1JwVjd4Snc9PSIsInZhbHVlIjoiVitxdmcvZ2EvTEJUeVpsSndZTzQ2clh4RlZkYUNOL2thUWlyeUtVKzNJemg2b3pOMWZ6a0dUQlE0K1ZyTURRaG9kd2F2aUh5VjcyL1VqWU9IUVA3Q2tEZkZYcFNtMlI5dE43TWlJZzVadkpKNmVocGlqY0RacWszRklYQ2R4a20iLCJtYWMiOiJhZjMzMjhjYzFmYjE5YmJlYzFlMGZmMDU1MzdkYTYxMWIzNDhhN2M2OTgxMzU3MjE0MGU3YWUxM2RjMDViZmJhIiwidGFnIjoiIn0%3D' \
--data-raw '{
    "employee_email": "[e-mail]",
    "start_date": "2024-07-01",
    "end_date": "2024-07-05",
    "description": "férias",
    "schedule_name": "Escala Teste"
}
'

Resposta

200 A ausência cadastrada, com seu identificador registrado na nossa base de dados. O atributo "id" representa o identificador da ausência e "department_id" representa o identificador da escala.

{
  "id": 1,
  "start_date": "2024-07-01",
  "end_date": "2024-07-05",
  "description": "férias",
  "department_id": 1
}

---

Recuperar ausências de um profissional

GET https://escala.med.br/api/v2/partner/absence

Resgata as ausências cadastradas de um profissional

Request Body

Name	Type	Description
employee_email*	string	O e-mail do profissional consultado.

Chamada

curl --location 'https://escala.med.br/api/v2/partner/absence?employee_email=<EMPOLOYEE_EMAIL>' \
--header 'Authorization: Bearer <API_TOKEN>' \

Resposta

200 Um array de ausências do profissional. Os atributos "department_id" e "department_name" se referem à escala a qual a ausência está aplicada.

[
  {
    "vacation_id": 1,
    "vacation_start_date": "2021-09-01",
    "vacation_end_date": "2021-09-15",
    "vacation_description": "férias",
    "department_id": 1,
    "department_name": "Neonatal",
    "employee_name": "Rômulo Silva"
  }
]

---

Remover ausência cadastrada de um profissional

DELETE https://escala.med.br/api/v2/partner/absence

Para apagar uma ausência de um profissional

Parâmetros

Nome	Tipo	Descrição
vacation_id	string	O identificador da ausência a ser removida. Este pode ser resgatado via GET /partner/absence
employee_email	string	O e-mail cadastrado do profissional

Chamada

curl --location --request DELETE 'https://escala.med.br/api/v2/partner/absence' \
--header 'Content-Type: application/json' \
--data-raw '{
    "employee_email":"[e-mail]",
    "vacation_id": 1
}'

Resposta

Retorno apenas com status code 200