Consultar locais de agenda

O local de agenda é o local em que o atendimento é agendado: uma sala, um consultório, um equipamento ou uma unidade de atendimento. É um dos seis campos obrigatórios de um agendamento, pelo idLocalAgenda.

Clínicas com mais de uma agenda utilizam este cadastro para separá-las.

Operação	Finalidade
GET /local-agenda/lista	Listar os locais e seus identificadores (idLocalAgenda)
GET /local-agenda/{id}	Obter nome, status e cor de um local

Listar

curl -G "https://api.clinicanasnuvens.com.br/local-agenda/lista" \
  -H "Authorization: Basic <CREDENCIAIS_EM_BASE64>" \
  -H "clinicaNasNuvens-cid: <TOKEN_DA_CLINICA>" \
  --data-urlencode "somenteAtivos=true"

Por padrão, somenteAtivos é false e a listagem retorna também os locais inativos. Com somenteAtivos=true, a listagem retorna apenas os locais ativos, que são os aceitos na criação do agendamento.

Buscar pelo identificador

A resposta contém o nome, o status e a cor, que é a mesma utilizada na agenda do sistema. A cor pode ser utilizada para manter a correspondência visual com a agenda da clínica.

A busca por identificador retorna o local independentemente do status.

Veja na Referência

Os detalhes de cada operação, campo a campo, estão em Referência › Locais de agenda.