Método de consulta que retorna informações IBGE de um município.
Chamada
GET [URLAPI]/EnderecosAPIConectorDadosGlobaisAPI/api/v1Enderecos/codigo-ibge
Informações para Requisição (Request Information)
Parâmetros URI (URI Parameters)
Nome (Name) | Descrição (Description) | Tipo (Type) | Informações Adicionais (Adittional Information) |
Município | Nome ou Identificador IBGE do município que deseja buscar. | string | Obrigatório. |
UF | UF ou Identificador IBGE da UF - Algumas UFs possuem municípios com nomes iguais, nesse caso, se a UF for nula serão retornados todos os municípios do filtro. | string | Não há. |
Parâmetros do Corpo (Body Parameters)
Não há.
Informações para Resposta (Response Information)
Códigos do Recurso (Response Codes)
Formatos de Resposta (Response Formats)
application/json, text/json
CODE 200 - SUCCESS
[ {
"ibgeMunicipio": 3543402,
"municipio": "Ribeirão Preto",
"uf": "SP",
"ibgeuf": 35
}
] |
application/json, text/json
CODE 400 - BAD
{
"code" : "string" ,
"message" : "string" ,
"detailedMessage" : "string" ,
"helpUrl" : "string" ,
"details" : [
{
"guid" : "3fa85f64-5717-4562-b3fc-2c963f66afa6" ,
"notificationType" : 0 ,
"code" : "string" ,
"message" : "string" ,
"detailedMessage" : "string" ,
"status" : 0
}
]
}
|