Docs
Endpoints
Cidades

Cidades

Endpoint que retorna os dados das cidades.

Endereço:

GET

/cities

Retorno do endpoint:

{
  "msg": "Successfully returned cities",
  "msgCode": "success",
  "code": 200,
  "data": [
    {
      "id": "9d7b569c-b2f5-4a33-96ab-ceff5a572ca5",
      "name": "BELFORD ROXO",
      "state": {
        "id": "9d7b569c-b2f5-4ad0-8f2a-3706ec3bfc57",
        "name": "Rio de Janeiro"
      }
    },
    {
      "id": "9d7b569c-b2f5-4908-96ab-3706ec3bfc57",
      "name": "CACHOEIRAS DE MACACU",
      "state": {
        "id": "9d7b569c-b2f5-4ad0-8f2a-3706ec3bfc57",
        "name": "Rio de Janeiro"
      }
    }
  ]
}

Abaixo o que cada campo representa

CampoValor
idId do registro da cidade
nameNome da cidade
state.idId do registro do estado
state.nameNome do estado

Exemplos de uso

Filtrando por cidade:

https://api-service.fogocruzado.org.br/api/v2/cities?cityId=9d7b569c-b2f5-4a33-96ab-ceff5a572ca5 (opens in a new tab)

Filtrando por nome da cidade:

https://api-service.fogocruzado.org.br/api/v2/cities?cityName=NITERÓI (opens in a new tab)

Filtrando por estado:

https://api-service.fogocruzado.org.br/api/v2/cities?stateId=9d7b569c-b2f5-4ad0-8f2a-3706ec3bfc57 (opens in a new tab)

EstadosOcorrências