1. Exemplo do json:
Code Block |
---|
[ { "codigo": 123, "descricao": "BASICA", "categoria": "B", "codigo_externo": "12", "ativo": "S" } ] |
Campos:
codigo: Código do registro no banco de dados do CRM
descricao: Descrição da categoria;
categoria: Abreviação da categoria
codigo_externo: Código da categoria no sistema integrado;
ativo: Campo para indicar se a categoria está ativa (S) ou inativa (N)
...
2.1 - Buscar Categoria pelo código
Endpoint: /semente-categoria
Tipo: get
Parâmetros:
codigoInterno: Tipo: Inteiro. Código da categoria no banco de dados do CRM.
codigoExterno:Tipo: String.Código da categoria no banco de dados do sistema integrado
...
2.2 - Buscar todas as categorias
Endpoint: /semente-categoria/todos
Tipo: get
Resposta: Status 200 - Retorna a lista das categorias no formato documentado na sessão Exemplo do json
2.3 - Cadastrar ou editar categoria
Endpoint:/semente-categoria
Tipo: post
Notas:
Informe no corpo da requisição o json conforme exemplo na sessão 1.
Para cadastrar uma nova categoria não informe o campo “codigo”;
Para editar uma categoria já existente informe o campo “codigo” com o código da categoria que deseja editar;
...
Não é possível deletar uma categoria, apenas inativar, pois a categoria pode ter vinculo com pedidos e produtos. Nesse caso, a categoria continua no banco de dados porém com o status inativo.
Endpoint:/semente-categoria
Tipo: delete
Parâmetros:
codigoInterno: Tipo: Inteiro. Código da categoria no banco de dados do CRM.
codigoExterno:Tipo: String.Código da categoria no banco de dados do sistema integrado, caso existir.
...
2.5 - Retornar os metadados da categoria
Endpoint: /semente-categoria/metadados
Tipo: get
Descrição: Retorna os campos do json, com as informações de tipo, tamanho máximo, se o campo é requerido, filtrável e/ou ordenável
Resposta: Status 200 - Retorna um json com as informações dos campos da categoria
2.6 - Pesquisar
Endpoint: /semente-categoria/pesquisa
Tipo: post
Notas:
Esse endpointretorna as categorias baseado nos filtros e na ordenação informados;
Exemplo do corpo da requisição:
...