Skip to main content

GET Verificar se Agendamento é Encaixe

Verifica se um agendamento seria classificado como encaixe.

Autenticação necessária

Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.


Endpoint​

GET https://api-dev.imagemais.com.br/api/appointments/check-encaixe

Parâmetros de Query​

NomeTipoObrigatórioDescrição
doctorIdnumber✅ID do médico
datestring✅Data do agendamento no formato YYYY-MM-DD
startTimestring✅Horário de início no formato HH:mm
Encoding do horário

O caractere : do startTime é codificado como %3A na URL. Exemplo: 10:31 → 10%3A31. A maioria dos clientes HTTP faz isso automaticamente.


Requisição​

curl -X 'GET' \
'https://api-dev.imagemais.com.br/api/appointments/check-encaixe?doctorId=22&date=2026-05-16&startTime=10%3A31' \
-H 'accept: */*' \
-H 'Authorization: Bearer {accessToken}'

Respostas​

200 Sucesso​

{
"isFit": true,
"reason": "same_shift"
}
CampoTipoDescrição
isFitbooleantrue se o horário é classificado como encaixe, false caso contrário
reasonstring | nullMotivo da classificação. null quando isFit é false

Valores possíveis de reason​

ValorDescrição
same_shiftA data é hoje e o horário informado está no mesmo turno do horário atual (manhã 06–12h, tarde 12–18h, noite 18–06h)
no_free_slotsTodos os horários da agenda do médico naquele dia já estão ocupados (desconsidera Cancelado e Faltou)
nullNão se aplica — retornado quando isFit é false

400 Bad Request​

Retornado quando date ou startTime não são enviados.

{
"message": "Parâmetros date e startTime são obrigatórios",
"error": "Bad Request",
"statusCode": 400
}

Retornado quando doctorId está ausente ou não é numérico.

{
"message": "Validation failed (numeric string is expected)",
"error": "Bad Request",
"statusCode": 400
}

404 Não Encontrado​

Retornado quando o médico não existe na conta.

{
"message": "Médico não encontrado",
"error": "Not Found",
"statusCode": 404
}