GET_cities.md

Cidades

GET api/v2/cities

Descrição

Retorna todos os cadastros, paginados em 50 registros

---

Autenticação

JWT

---

Parâmetros

• filter[search] - Filtra cadastros de cidades. Suporta pesquisa pelo nome:

  GET /api/v2/tasks?filter[search]=Amer

---

Formato de retorno

Veja formato completo

---

Exemplo

Requisição (Auth: JWT)

GET https://web.monde.com.br/api/v2/cities?filter[search]=Amer

Resposta

Status de retorno

200 - Ok

{
  "data": [
    {
      "id": "0884d127-80bf-466f-a0a9-3f0a9f351576",
      "type": "cities",
      "links": {
        "self": "http://web.monde.com.br/api/v2/cities/0884d127-80bf-466f-a0a9-3f0a9f351576"
      },
      "attributes": {
        "name": "Americana",
        "state-acronym": "SP"
      },
      "relationships": {
        "people": {
          "links": {
            "self": "http://web.monde.com.br/api/v2/cities/0884d127-80bf-466f-a0a9-3f0a9f351576/relationships/people",
            "related": "http://web.monde.com.br/api/v2/cities/0884d127-80bf-466f-a0a9-3f0a9f351576/people"
          }
        }
      }
    }
  ],
  "links": {
    "first": "http://web.monde.com.br/api/v2/cities?filter%5Bsearch%5D=Amer&page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://web.monde.com.br/api/v2/cities?filter%5Bsearch%5D=Amer&page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}

---

Erros

Os erros possuem um status code específico, geralmente com alguma mensagem de erro no formato:

{
  "errors": [
    {
      "title": "Erro de autenticação",
      "detail": "O token de autenticação fornecido está expirado ou é inválido",
      "code": "401",
      "status": "401"
    }
  ]
}