Skip to content

Lista os setores (organograma) de uma cidade

Request

Lista todos os setores de uma cidade — o organograma da prefeitura —, não apenas os setores de um usuário.

Identifique a cidade por cityId ou por cidade + uf. Quando os dois vierem, cityId vence. Chaves API do tipo tenant leem sempre a própria cidade: cityId, cidade e uf informados são ignorados.

Dois identificadores saem por setor e não são intercambiáveis:

  • tag — identificador estável do setor. É o valor que vai em templateOptions.addressee.values[].value de um campo de destinatário (next-destinatario).
  • id — ObjectId do setor. É o que a tramitação (config.form_tramites) e o fluxograma guardam.

Setor apagado (soft-delete) não aparece. Setor bloqueado aparece com blocked: true: ele continua no organograma e ainda recebe processo antigo, mas não deve ser escolhido como destinatário de um formulário novo.

Use q para filtrar por nome, sigla ou tag — em cidade grande o organograma inteiro é pesado (a de implantação tem 614 setores). O filtro é substring, sem acento e sem caixa: fiscalizacao casa Fiscalização de Obras.

total: 0 com city preenchido e sem filteredBy significa organograma ainda não montado naquela cidade — é resposta, não erro. Já total: 0 com filteredBy significa que o seu filtro não casou, e a cidade tem cityTotal setores: são conclusões opostas. Cidade inexistente devolve 400, e cidade duplicada no mesmo UF também: nesse caso a mensagem traz os índices candidatos, para você repetir a chamada com cityId.

Atenção à diferença para /hub-api/type/find e /hub-api/process/find-by-np, que nessa mesma situação respondem 200 com ambiguous e candidates. Lá a lista parcial ainda é útil e a escolha fica com você; aqui devolver o organograma de uma das candidatas seria devolver o de outra prefeitura, sem nada na resposta denunciar — por isso esta rota recusa e pede o cityId.

Security
InternalAuth
Query
cityIdinteger

Índice numérico da cidade (o mesmo city.index devolvido por /hub-api/type/find). Vence cidade/uf.

Example:cityId=246
cidadestring

Nome da cidade. Exige uf. Ignorado quando cityId é informado.

Example:cidade=Barueri
ufstring

UF de 2 letras. Exige cidade.

Example:uf=SP
qstring

Filtra por nome, sigla ou tag do setor (substring, case-insensitive e sem acento). Vazio ou só espaços = sem filtro.

Example:q=protocolo
GET
/hub-api/sector/list
curl -i -X GET \
  'https://api.producao.aprova.com.br/hub-api/sector/list?cityId=246&cidade=Barueri&uf=SP&q=protocolo' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Setores da cidade

Bodyapplication/json
cityobject or null

Cidade consultada. cidade/estado só vêm quando a cidade foi resolvida por nome.

totalinteger

Quantidade de setores retornados (sem os apagados e já filtrados por q, quando houver)

Example:54
cityTotalinteger

Só quando há q — quantos setores a cidade tem no total. É o que distingue "o filtro não casou" de "a cidade não tem organograma"

Example:614
filteredBystring

Só quando há q — o termo aplicado, ecoado

Example:"protocolo"
sectorsArray of objects
Response
{
  "city": {
    "index": 246,
    "cidade": "Barueri",
    "estado": "SP"
  },
  "total": 2,
  "sectors": [
    { … },
    { … }
  ]
}