Ler o diagnóstico de uma cidade

GET

/v1/diagnosticos/{codigo}

curl --request GET \
  --url https://api.brasilsintetico.com/v1/diagnosticos/example \
  --header 'Authorization: Bearer <token>'

O diagnóstico de uma cidade aberta, por setor censitário. Sem variavel, o resumo: as variáveis, os setores e quantos mantêm os números modelados abaixo do corte de erro. Com ela, aquela variável em listas por setor: o que o IBGE observou, ou as contagens da população sintética com o erro do setor (escondidas acima do corte de 0,50, com o motivo). Com variavel=escolas, a distância em linha reta de cada setor até a escola mais próxima de cada etapa, em metros, com o código INEP da escola e a parcela das escolas da cidade com coordenada. Os dois são lidos na release que o projeto abriu (release) e dizem a release mais nova em que a cidade pode ser aberta (release_mais_nova).

Autorizações

• projectKey

Parâmetros

Parâmetros de caminho

codigo

obrigatório

O código IBGE do município

string

/^\d{7}$/

O código IBGE do município

Parâmetros de consulta

variavel

Qualquer um de:

string

string

null

null

Uma variável do diagnóstico; sem ela, o resumo da cidade

Respostas

200

Resposta bem-sucedida

Tipo de mídiaapplication/json

object

key

propriedades adicionais

any

Exemplo ^gerado

{}

422

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": {}
    }
  ]
}