Pular para o conteúdo principal

Estados

Consulte os estados (UF) disponíveis no sistema.

Endpoint​

GET /catalog/state
GET /catalog/state/{id}

Método​

GET

Autenticação​

Este endpoint requer autenticação via JWT. Inclua o token no header:

Authorization: Bearer {access_token}

Exemplo de Resposta​

Lista de Estados​

Status Code: 200 OK

[
  {
    "id": 1,
    "name": "São Paulo",
    "abbreviation": "SP"
  },
  {
    "id": 2,
    "name": "Rio de Janeiro",
    "abbreviation": "RJ"
  },
  {
    "id": 3,
    "name": "Minas Gerais",
    "abbreviation": "MG"
  },
  {
    "id": 4,
    "name": "Rio Grande do Sul",
    "abbreviation": "RS"
  }
]

Detalhe de um Estado​

Status Code: 200 OK

{
  "id": 1,
  "name": "São Paulo",
  "abbreviation": "SP"
}

Estrutura de Dados​

A resposta é um array de objetos (lista) ou um objeto único (detalhe), onde cada objeto contém:

CampoTipoDescrição
idintegerIdentificador único do estado
namestringNome completo do estado
abbreviationstringSigla do estado (UF)

Possíveis Retornos de Erro​

401 Unauthorized​

Retornado quando o token de autenticação não foi fornecido ou é inválido.

{
  "detail": "As credenciais de autenticação não foram fornecidas."
}

ou

{
  "detail": "Token inválido ou expirado."
}

403 Forbidden​

Retornado quando o usuário autenticado não tem permissão para acessar este recurso.

{
  "detail": "Você não tem permissão para executar essa ação."
}

404 Not Found​

Retornado quando um estado específico não é encontrado (ao acessar /catalog/state/{id}).

{
  "detail": "Não encontrado."
}

405 Method Not Allowed​

Retornado quando um método HTTP não permitido é utilizado (ex: DELETE, POST, PUT, PATCH).

{
  "detail": "Método \"DELETE\" não é permitido."
}