Endpoints - Unidade de medida

1. Exemplo do json:

Campos:

• codigo: Código do registro no banco de dados do CRM

• unidade: Abreviação da unidade

• descricao: Descrição da unidade

Observação: As unidades de medidas são padrões do sistema, não é possível cadastrar, atualizar ou deletar unidades de medida, apenas consulta-las.

2. Endpoints

2.1 - Buscar Unidade de medida pelo código

Endpoint: /unidade-medida

Tipo: get

Parâmetros:

• codigoInterno: Tipo: Inteiro. Código da unidade de medida no banco de dados do CRM.

Resposta: Status 200 - Retorna a unidade de medida no formato documentado na sessão Exemplo do json

2.2 - Buscar todas as unidade de medida

Endpoint: /unidade-medida/todos

Tipo: get

Resposta: Status 200 - Retorna a lista das unidades de medidas no formato documentado na sessão Exemplo do json

2.5 - Retornar os metadados da unidade de medida

Endpoint: /unidade-medida/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 unidade de medida

2.6 - Pesquisar

Endpoint: /unidade-medida/pesquisa

Tipo: post

Notas:

• Esse endpoint retorna as unidades de medida baseado nos filtros e na ordenação informados;

• Exemplo do corpo da requisição:

• { "pagina": 1, "quantidadeRegistros": 10, "filtros": [ { "campo": "unidade", "comparacao": "COMECA_COM", "valor": "K" } ], "ordenacao": [ { "campo": "descricao", "ordenacao": "ASC" } ] }

• Nesse exemplo, estamos filtrando todas as unidades de medida cuja unidade (abreviação) começa com a letra K;