Pular para o conteúdo principal

Grupos

Grupos organizam os bens do patrimônio em categorias. Cada bem pertence a um grupo. Corresponde à tela Grupos, do módulo Controle patrimonial.

Endpoints​

MétodoCaminhoDescrição
GET/equity-controls/groupsLista os grupos
POST/equity-controls/groupsCadastra um grupo
GET/equity-controls/groups/{id}Consulta um grupo
PUT/equity-controls/groups/{id}Altera um grupo
DELETE/equity-controls/groups/{id}Apaga um grupo

GET /equity-controls/groups​

Lista os grupos de bens da empresa cliente, ordenados pelo nome.

Parâmetros de URL

ParâmetroDescrição
searchTexto para buscar pelo nome do grupo
per_pageQuantidade de registros por página. Com ele, a resposta é paginada
pageNúmero da página, quando per_page é informado

Resposta (200): lista de grupos com id, group, type, updated_at e os nomes de quem criou e de quem alterou por último.

POST /equity-controls/groups​

Cadastra um grupo.

Corpo

CampoObrigatórioTipoDescrição
groupSimTextoNome do grupo

Resposta (201): o grupo criado, com id e group.

curl -X POST https://api.pedagogo.app/equity-controls/groups \
-H "Authorization: Bearer <token-de-sessao>" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{"group": "Notebooks"}'

Consultar, alterar e apagar​

  • GET /equity-controls/groups/{id}: devolve o grupo. Resposta (200).
  • PUT /equity-controls/groups/{id}: altera o nome. Corpo: group (Sim, texto). Resposta (200): o grupo alterado.
  • DELETE /equity-controls/groups/{id}: apaga o grupo (exclusão lógica). Resposta (200): lista de grupos da empresa cliente.