POST Consultar Cidade

Endpoint

/api/Endereco/Cidade

Resumo

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:

Headers Request

Detalhes da API

Campos obrigatórios e seus respectivos tipos

Campos Obrigatórios

Campos Opcionais

Exemplo de Requisição e Resposta

Body da Requisição

{
  "nomeCidade": "São Paulo",
  "uf": "SP"
}

ExemploExemplo de Request

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

{
  "success": true,
  "data": [
    {
      "cidadeId": 5320,
      "cidadeNome": "São Paulo",
      "codigoIBGE": 3550308,
      "ufId": 25,
      "uf": "SP"
    }
  ],
  "errors": null
}

Headers de Response (5)