Skip to content

Lista os formulários de uma cidade por nome e UF

Request

Lista os formulários (types) de uma cidade a partir do NOME + UF, opcionalmente filtrando pelo título. Resolve a cidade por collation (ignora acento e caixa — Chapeco corresponde a Chapecó). Use para descobrir o ObjectId de um formulário a partir da cidade e do nome, sem consultar o MongoDB diretamente.

O filtro titulo é contains case-insensitive, porém sensível a acento — envie o termo com o acento correto (Alvará, não Alvara). Sem titulo, retorna todos os formulários da cidade.

No caso raro de cidade duplicada no mesmo UF com formulários em mais de uma candidata, a resposta traz ambiguous: true e a lista candidates, sem escolher automaticamente.

Security
InternalAuth
Query
cidadestringrequired

Nome da cidade (acento e caixa são ignorados via collation)

Example:cidade=Chapecó
ufstringrequired

UF de 2 letras

Example:uf=SC
titulostring

Filtro opcional pelo título (contains, case-insensitive, sensível a acento)

Example:titulo=Habite
GET
/hub-api/type/find
curl -i -X GET \
  'https://api.producao.aprova.com.br/hub-api/type/find?cidade=Chapec%C3%B3&uf=SC&titulo=Habite' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Lista de formulários da cidade

Bodyapplication/json
cityobject or null

Cidade resolvida, ou null quando não encontrada

totalinteger

Quantidade de formulários retornados

Example:2
formsArray of objects

Formulários da cidade (filtrados por titulo quando informado)

ambiguousboolean

Presente e true quando há mais de uma cidade candidata com formulários

Example:true
candidatesArray of objects

Candidatas quando ambiguous é true (a escolha fica a cargo do consumidor)

Response
{
  "city": {
    "index": 145,
    "cidade": "Chapecó",
    "estado": "SC"
  },
  "total": 2,
  "forms": [
    { … },
    { … }
  ]
}