Categorias de abastecimento

Listar

GET /api/v1/supply_categories

Retorno

status	descrição
200	OK

Exemplo:

[
  {
    "id": 1,
    "created_at": "2023-09-23T18:23:17.000Z",
    "updated_at": "2023-09-23T18:23:17.000Z",
    "name": "Padrão",
    "default": true
  }
]

Ver

GET /api/v1/supply_categories/[id]

Parâmetros de URL:

parâmetro	descrição	obrigatório
id	id da categoria de abastecimento	sim

Retorno

status	descrição
200	OK

Exemplo:

{
  "id": 1,
  "created_at": "2023-09-23T18:23:17.000Z",
  "updated_at": "2023-09-23T18:23:17.000Z",
  "name": "Padrão",
  "default": true
}

Erros
-----

status	descrição	response body
404	máquina não encontrada	{ “status”: “404”, “error”: “Not Found” }

Criar

POST /api/v1/supply_categories

Request:

{
   "supply_category": {
     "name": "Bebidas"
   }
 }

---

Erros

status	descrição	response body
400	parâmetros faltando	{ “status”: “400”, “error”: “Bad Request” }
401	não autorizado	(vazio)
422	erro ao criar	ver exemplo abaixo

422 - erro ao criar

{
  "name": [
    "já está em uso"
  ]
}

------

Campos

Obrigatórios

• supply_category

  • name: Nome da categoria de abastecimento.

---

Retorno

status	descrição
201	Criado com sucesso

Exemplo:

{
  "id": 2,
  "created_at": "2023-05-16T12:32:34.083Z",
  "updated_at": "2023-05-16T12:32:34.083Z",
  "name": "Bebidas",
  "default": false
}

---

Erros

status	descrição	response body
400	parâmetros faltando	{ “status”: “400”, “error”: “Bad Request” }
401	não autorizado	(vazio)
422	erro ao criar	ver exemplo abaixo

422 - erro ao criar

{
  "name":
  "já está em uso"
}

Atualizar

PATCH /api/v1/supply_categories/[id]

Parâmetros de URL:

parâmetro	descrição	obrigatório
id	id da categoria de abastecimento	sim

Request:

{
  "supply_category": {
    "name": "Abastecimento 3 - Alterado"
  }
}

Campos

Ao menos um campo interno a supply_category deve ser passado.

Retorno

status	descrição
200	Atualizado com sucesso

Exemplo:

{
  "id": 3,
  "created_at": "2021-03-16T12:32:34.083Z",
  "updated_at": "2021-03-16T12:32:34.083Z",
  "name": "Abastecimento 3 - Alterado"
}

Erros

status	descrição	response body
400	parâmetros faltando	{ “status”: “400”, “error”: “Bad Request” }
401	não autorizado	(vazio)
404	categoria de abastecimento não encontrada	{ “status”: “404”, “error”: “Not Found” }
422	erro ao atualizar	ver exemplo abaixo

422 - erro ao atualizar

{
  "name": [
    "não pode ficar em branco"
  ]
}

Excluir

DELETE /api/v1/supply_categories/[id]

Parâmetros de URL:

parâmetro	descrição	obrigatório
id	id da categoria de abastecimento	sim

Retorno

status	descrição	response body
204	Excluído com sucesso	(vazio)

Erros

status	descrição	response body
404	categoria de abastecimento não encontrada	{ “status”: “404”, “error”: “Not Found” }