POST Consultar Cidade

Introdução 

 Retorna os dados de uma determinada cidade/UF informada. 

 

 Rota 

 /Endereco/Cidade 

 Authorization 

 É necessário um token de autorização do tipo  Bearer Token . O token deve ser fornecido da seguinte forma: 

 

 

 

 Token 

 eyJ... 

 

 

 

 Headers Request 

 

 

 

 Accept: 

 application/json 

 

 

 Content-Type 

 application/json 

 

 

 

 Detalhes da API 

 Campos obrigatórios e seus respectivos tipos 

 

 Campos 

 

 

 

 Campo 

 Tipo 

 Obrigatorio 

 Descrição 

 

 

 

 

 nomeCidade 

 string 

 Sim 

 Nome da cidade a ser consultada. 

 

 

 uf 

 string 

 Sim 

 Unidade Federativa (sigla do estado). 

 

 

 

 Campos Opcionais 

 

 

 

 Campo 

 Tipo 

 Descrição 

 

 

 

 

 Nenhum 

                                  - 

 Não existem campos opcionais. 

 

 

 

 Exemplo de Requisição e Resposta 

 

 Body da Requisição 

 

 body 

 {

 "nomeCidade": "São Paulo",

 "uf": "SP"

} 

 

 Ex emplo de Request 

 

 curl 

 curl --location 'https://app2-crefaz-api-external-stag.azurewebsites.net/api/Endereco/Cidade' \

--header 'Accept: application/json' \

--header 'Content-Type: application/json' \

--data '{

 "nomeCidade": "São Paulo",

 "uf": "SP"

}' 

 

 Exemplo de Response 

 

 sucesso 

 {

 "success": true,

 "data": [

 {

 "cidadeId": 5320,

 "cidadeNome": "São Paulo",

 "codigoIBGE": 3550308,

 "ufId": 25,

 "uf": "SP"

 }

 ],

 "errors": null

} 

 

 

 erro 

 {

 "success": false,

 "data": null,

 "errors": [

 "Nenhum registro encontrado!"

 ]

} 

 

 Headers de Response (5) 

 

 

 

 Key 

 Value 

 

 

 

 

 

 Content-Type 

 

 application/json; charset=utf-8 

 

 

 Date 

 

 Fri, 04 Oct 2024 17:56:31 GMT 

 

 

 

 

 Server 

 

 Kestrel 

 

 

 Transfer-Encoding 

 chunked 

 

 

 Request-Context 

 appId=cid-v1:d0033e30-cc70-4961-9727-b7389fb39348