Consultar executores

O executor de agenda é quem ocupa um horário. Pode ser um profissional de saúde, como um médico, um dentista ou um fisioterapeuta, ou um cliente e fornecedor, caso de uma sala ou de um equipamento que precisa ser reservado.

Operação	Finalidade
GET /executor-agenda/lista	Listar os executores que podem receber agendamentos
GET /executor-agenda/{id}	Obter o detalhe de um executor, com contato e especialidades

Os horários disponíveis estão em Consultar disponibilidade.

Listar

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

Filtro	Restringe a
nomeContem	Executores com o trecho no nome, em qualquer posição
somenteAtivos	Executores ativos. Padrão false, então os inativos também são retornados
somenteProfissionaisSaude	Profissionais de saúde, sem os do tipo cliente e fornecedor
somenteAtivosNaWeb	Executores disponíveis para agendamento pela web externa
idEspecialidade	Executores que atendem a especialidade informada
idTipoConvenio	Executores que atendem o convênio informado

Os filtros podem ser combinados; o executor só é retornado quando atende a todos os filtros informados.

Resposta:

{
  "lista": [
    { "id": 1, "idpessoa": 42, "nome": "Dr. Silva", "ativo": true, "tipoExecutor": "PROFISSIONAL" }
  ],
  "pagina": 0,
  "totalPaginas": 1
}

Identificadores do executor

Cada executor possui dois identificadores, utilizados em campos diferentes:

Campo da resposta	Utilizado em	Operações
id	idExecutorAgenda, codExecutorAgenda	Consulta de disponibilidade, busca por id, filtro de convênios
idpessoa	idPessoaExecutor	Criação e alteração de agendamento

A relação completa, incluindo a lista de espera, está em Identificadores.

Buscar pelo identificador

O {id} do caminho recebe o id do executor.

A resposta contém o contato e, quando o executor é um profissional de saúde, um bloco profissionalSaude com registro profissional, código CBO e as especialidades atendidas. Para executores do tipo cliente e fornecedor, esse bloco é retornado como nulo.

No bloco profissionalSaude, o campo clinicas é retornado como texto, com os nomes separados por vírgula.

Veja na Referência

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