Pular para o conteúdo

Estimar o que um loteamento novo pede da cidade

POST
/v1/diagnosticos/{codigo}/crescimento
curl --request POST \
--url https://api.brasilsintetico.com/v1/diagnosticos/example/crescimento \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "versao": 1, "municipio": "2601201", "unidades": 200, "poligono": [ [ -37.06, -8.42 ], [ -37.05, -8.42 ], [ -37.05, -8.41 ], [ -37.06, -8.41 ] ] }'

O que um loteamento novo pede de uma cidade aberta: os moradores e as crianças que ele traz, por analogia com os cinco setores urbanos mais próximos (com a faixa que a medição sustenta), a escola mais próxima de cada etapa com as matrículas, a unidade de saúde mais próxima de cada grupo, o saneamento e a declividade dos setores de referência. Cada resposta tem um número, a base e uma frase; a que os dados não conseguem dar volta retida, com o motivo. As tabelas são as do diagnóstico da cidade na release que o projeto abriu (release, com release_mais_nova, como o diagnóstico as dá). Não gasta nada; as recusas trazem códigos growth_*.

codigo
obrigatório

O código IBGE do município

string
/^\d{7}$/

O código IBGE do município

Tipo de mídiaapplication/json
Um de:
Pedido de crescimento

O pedido de crescimento como a referência o mostra. Quem decide é o contrato: um pedido fora dele é recusado com um código growth_* e o campo culpado.

object
versao

A versão da calculadora

integer
Valor aceito: 1
municipio

O código IBGE do município, de 7 dígitos, o da rota

string
/^\d{7}$/
unidades

As unidades habitacionais do loteamento

integer
>= 1 <= 20000
poligono
obrigatório
Qualquer um de:
Array<array>
>= 3 itens <= 1001 itens
setores
Qualquer um de:
Array<string>
>= 1 itens

Resposta bem-sucedida

Tipo de mídiaapplication/json
object
key
propriedades adicionais
any

Exemplo gerado

{}

Erro de validação

Tipo de mídiaapplication/json
object
detail
Array<object>
object
loc
obrigatório
Local
Array
msg
obrigatório
Mensagem
string
type
obrigatório
Tipo do erro
string
input
ctx
Contexto
object

Exemplo gerado

{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}