Pular para o conteúdo principal

Consultar cidades e nacionalidades

Buscar pelo identificador​

Obtém os dados a partir de um identificador já armazenado.

curl "https://api.clinicanasnuvens.com.br/cidade/1" \
  -H "Authorization: Basic <CREDENCIAIS_EM_BASE64>" \
  -H "clinicaNasNuvens-cid: <TOKEN_DA_CLINICA>"

A consulta de nacionalidade segue o mesmo formato, em GET /nacionalidade/{id}.

Pesquisar por nome​

curl -G "https://api.clinicanasnuvens.com.br/cidade/lista" \
  -H "Authorization: Basic <CREDENCIAIS_EM_BASE64>" \
  -H "clinicaNasNuvens-cid: <TOKEN_DA_CLINICA>" \
  --data-urlencode "nomeContem=Paulo" \
  --data-urlencode "registrosPorPagina=20"

O nomeContem localiza o texto em qualquer posição do nome. Por exemplo, Paulo retorna Sao Paulo, Paulo Afonso e Sao Paulo das Missoes. Quando o filtro é omitido ou enviado vazio, a operação retorna a lista completa, paginada.

A pesquisa é feita pelo nome e não diferencia maiúsculas de minúsculas. Cidades não possuem situação ativa ou inativa, portanto todos os registros são retornados.

Cidades da região da clínica​

A lista de cidades pode conter inúmeros registros. Na maioria das integrações, são utilizadas apenas as cidades da região onde a clínica atende; nesse caso, pesquise cada cidade pelo nome em vez de percorrer a lista completa. Por exemplo, uma clínica em Campinas pode pesquisar nomeContem=Campinas, nomeContem=Valinhos e nomeContem=Sumare.

A lista de nacionalidades ocupa poucas páginas.

Recomendação: guarde no seu sistema o id das cidades já consultadas, para reduzir chamadas e manter o consumo dentro do limite de requisições.

Onde esses identificadores são usados​

ListaCampo que ela alimenta
Cidadeendereco.idCidade, no paciente e no profissional de saúde escola
NacionalidadeidNacionalidade, no cadastro de paciente

Ver o guia de Paciente.

Veja na Referência​

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