Turnos/Plantões

Busca por turnos:

Recuperar os plantões de um período.

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

Recupera os plantões disponíveis no período solicitado.

Exemplo de requisição

curl --location 'https://escala.med.br/api/v2/partner/timetables?fromDate=2024-08-01&toDate=2024-08-31' \
--header 'Authorization: Bearer <API_TOKEN>' \

Query Parameters

Name	Type	Description
fromDate	string	Data do início da consulta. No formato YYYY-MM-DD
toDate	string	Data limite da consulta. No formato YYYY-MM-DD
displayPlanned	boolean	Para mostrar turnos de trabalho que ainda não foram publicados.
page_size	integer	Máximo de resultados por consulta. Caso não seja passado o seu valor é 500. O valor máximo é 1000.
page	integer	Indica a página da consulta está sendo acessada.
unit_tag_filter	string	Filtra equipes que contenham exatamente o texto passado, ou parcial usando %.
schedule_tag_filter	string	Filtra escalas que contenham exatamente o texto passado, ou o parcial usando %
timetable_tag_filter	string	Filtra turnos que contenham exatamente o texto passado, ou o parcial usando %
schedule_name_filter	string	Filtra por escalas que contenham exatamente o nome passado no campo.
employee_id_filter	string	Filtra pelo id do usuário.
employee_custom_id_filter	string	Busca apenas por usuários com o mesmo id interno (internal_id). Precisa ser exatamente igual

Resposta

200

{
   "total":1066,
   "per_page":"1",
   "current_page":1,
   "last_page":1066,
   "next_page_url":"https://escala.med.br/api/v2/partner/timetables?fromDate=2018-05-01&page_size=1&toDate=2018-05-31&page=2",
   "prev_page_url":null,
   "from":1,
   "to":1,
   "data":[
      {
         "employee_id":1,
         "employee_custom_id":null,
         "employee_name":"Nathalia de Sa",
         "employee_email":“[e-mail]",
         "employee_phone":"",
         "employee_cpf":"111.111.111-11",
         "employee_tags": null,
         "schedule_id":1,
         "schedule_name":"Emergencista I",
         "team_id":400,
         "team_name":"Manhã",
         "team_tags": null,
         "shift_id":1,
         "shift_tags": null,
         "shift_planned_start":"2018-05-03 07:00:00",
         "shift_planned_end":"2018-05-03 13:00:00",
         "shift_actual_start":"2018-05-03 07:00:00",
         "shift_actual_end":"2018-05-03 13:00:00",
         "shift_published":1,
         "shift_checkin": null,
         "shift_checkout": null,
         "original_employee_id":1,
         "original_employee_name":"Nathalia Cristina De Oliveira Sa",
         "original_employee_email": "[e-mail]",
         "original_employee_phone":"",
         "origin":"allocation",
         "created_by_name": "Rodrigo Silva",
         "updated_by_name": "Sandra Oliveira Soares"
      }
   ]
}

Caso algum parâmetro seja passado de forma errada a API retorna um HTTP Code 400 dizendo qual é o problema.

Campos presentes na resposta:

• employee_id: identificador único do sistema do colaborador

• employee_custom_id: identificador único definido pelo cliente do colaborador

• employee_name : Nome do colaborador

• employee_email: e-mail do colaborador

• employee_phone: telefone do colaborador

• employee_cpf: cpf do colaborador

• employee_tags: marcadores que possam ter sido atribuídos ao colaborador

• schedule_id: identificador único do sistema da escala

• schedule_name:nome da escala

• team_id: identificador único do sistema da equipe

• team_name: nome da equipe

• team_tags: marcadores que possam ter sido atribuídos à equipe

• shift_id: identificador único do sistema do plantão

• shift_planned_start: horário inicial do plantão no momento da publicação da escala

• shift_planned_end: horário final do plantão no momento da publicação da escala

• shift_actual_start: horário do plantão no momento da chamada à API

• shift_actual_end: horário final do plantão no momento da chamada à API

• shift_published: se o turno de trabalho foi publicado.

• shift_tags: marcadores que possam ter sido atribuídos ao turno.

• shift_checkin: horário de check-in no turno, caso exista

• shift_checkout: horário de check-out no turno, caso exista.

• original_employee_id: identificador único do colaborador que estava no momento da publicação da escala (caso haja uma mudança)

• original_employee_name:nome do colaborador que estava no momento da publicação da escala (caso haja uma mudança)

• original_employee_phone: telefone do colaborador no momento da publicação da escala (caso haja uma mudança)

• original_employee_email: e-mail do colaborador no momento da publicação da escala (caso haja uma mudança)

• origin:se o plantão veio via alocação/troca, etc. Nulo quando não houve mudança após a publicação.

• created_by_name: o nome do usuário que criou originalmente o turno de trabalho.

• updated_by_name: o nome do usuário que fez a última atualização no turno de trabalho. Não contém o agregado de todos que fizeram atualizações no turno. Caso não hajam atualizações no turno, o nome será o mesmo do created_by_name.