Saltar para o conteúdo principal
GET
Devolve os horários de início disponíveis para reserva numa única localização ao longo do período pedido. Os horários são gerados a partir de open_hours da localização, ignorando datas bloqueadas globais / por localização e subtraindo as marcações Aniva já reservadas, para que o resultado reflita o que os teus pacientes podem realmente reservar do lado do cliente. Requer o scope appointments_schedule. A localização também tem de estar abrangida pelo contexto de acesso de grupo de localizações da tua chave de API.
Usa este endpoint em vez de deduzires a disponibilidade a partir do open_hours estático devolvido por Listar localizações — apenas este endpoint tem em conta reservas em tempo real, exceções de horário por data e o aviso prévio mínimo de 12 horas nas localizações geridas pela Aniva. Todos os horários devolvidos aqui podem ser reservados tal como estão.
As respostas incluem Cache-Control: private, max-age=30, stale-while-revalidate=60, pelo que um navegador pode servir uma resposta em cache durante até ~30 segundos — um horário reservado nesse intervalo pode continuar a aparecer como disponível até à atualização seguinte. Apresenta também os conflitos no momento da marcação.

Parâmetros de caminho

string
obrigatório
Identificador da localização (UUID). Usa o id obtido em Listar localizações.

Parâmetros de consulta

string
Início inclusivo do período em YYYY-MM-DD (interpretado em timezone). Opcional. Por predefinição é hoje quando nenhuma data é fornecida, ou end_date − 30 days quando apenas end_date é fornecida. Datas passadas são silenciosamente ajustadas para hoje.
string
Fim inclusivo do período em YYYY-MM-DD (interpretado em timezone). Opcional. Por predefinição é hoje + 30 dias quando nenhuma data é fornecida, ou start_date + 30 days quando apenas start_date é fornecida. Tem de ser igual ou posterior a start_date e dentro de 90 dias a partir de hoje.
string
Fuso horário IANA (por ex., Europe/Berlin) usado para interpretar start_date / end_date e para agrupar horários por data de calendário. Opcional — usa por predefinição o fuso horário da própria localização. As horas de início dos horários em si são sempre devolvidas como instantes UTC (Z) e nunca mudam com este parâmetro — a grelha de horários é sempre projetada a partir do fuso horário da própria localização; o parâmetro apenas afeta em que dia de calendário cada horário é agrupado. As entradas de dias na resposta cobrem exatamente start_date..end_date como dias de calendário neste fuso horário. Omite-o, a menos que apresentes o seletor noutro fuso horário.

Resposta

Em caso de sucesso, a API devolve 200 OK com um único objeto de disponibilidade.
string
obrigatório
Identificador da localização repetido.
string
obrigatório
Fuso horário IANA em que a resposta é apresentada (por ex., Europe/Berlin) — repete o parâmetro de consulta timezone quando fornecido, caso contrário o fuso horário da própria localização.
integer
Intervalo em minutos entre inícios consecutivos de horários disponíveis para reserva. O passo da grelha configurado pela localização — todos os horários em availability seguem esta grelha. null apenas quando a localização não tem configuração de agendamento. Não é uma janela de duração da marcação: reservas sobrepostas com inícios diferentes não entram em conflito; apenas colisões no mesmo início exato contam para a concorrência.
array
obrigatório
Horários disponíveis para reserva por dia. Os dias sem horários disponíveis são omitidos para manter o payload leve. Cada entrada tem:

Respostas de erro