Consulta Materiais
O módulo de materiais tem como objetivo disponibilizar para os usuários não autenticados informações sobre materiais cadastradas no sistema, em formato JSON.
Descrição do Caso de Uso
O caso de uso é acionado quando o usuário entra no link materiais-services/ É possível realizar duas consultas da unidade , sendo uma mais simples e outra mais complexa como descritas abaixo.
Quadro 01: Consulta Simples
| Parâmetro | Descrição | URL |
|---|---|---|
| Denominação Começando | Informa os caracteres inicial da denominação daquele material | materiais-services/comecando_por/{denominacao} |
| Denominação | Informa a denominação daquele material | materiais-services/denominacao/{denominacao} |
| Especificacão | Informa palavras que estão na especificação daquele material | materiais-services/especificacao/{especificacao} |
| Grupo do Material | Informa os 4 digítos iniciais do código do material desejado | materiais-services/codigo/{numero} |
Quadro 02:Descrição das informações retornadas na Consulta Simples em JSON
| Atributo | Tipo | Descricao |
|---|---|---|
| codigo | Númerico | Armazena o código que está associado aquele material |
| denominacao | Texto | Armazena a denominação do material buscado |
| especificacao | Texto | Armazena a descrição do material buscado |
Quadro 03:Busca Completa
| Parâmetro | Descrição | URL |
|---|---|---|
| codigo | Fornecido o código que está relacionado aquele material especifíco, é retornada mais informações sobre aquele material | materiaisservices/material_detalhado/{codigo} |
Quadro 04 :Descrição das informações da Busca Completa retornadas no JSON
| Atributo | Tipo | Descricao |
|---|---|---|
| codigo | Númerico | Armazena o código que está associado aquele material |
| denominacao | Texto | Armazena a descrição resumida do material buscado |
| especificacao | Texto | Armazena a descrição detalhada do material buscado |
| catMat | Númerico | Armazena o código do material no sistema do governo SIDEC |
| denominacaoGrupoMaterial | Texto | Armazena o nome do grupo no qual o material pertence |
| denominacaoUnidadeMaterial | Texto | Armazena a unidade de medida que pode ser usado como métrica do material selecionada |
| preco | Númerico | Armazena o preço última compra do material |
| dataUltimaCompra | Texto | Armazena a data da última compra no formato AAAA-MM-DD |
| ativo | Booleano | Armazena um booleano que indica se o material/serviço ainda está sendo utilizado para efetuar compras |
Principais Regras de Negócio
Não se Aplica
Resoluções/Legislações Associadas
Não se Aplica
Classes Persistentes e Tabelas Envolvidas
| Classe | Tabela |
|---|---|
| <Ex.:br.ufrn.materiaisservices.dto.MaterialDto> | <Ex.:sipac.comum.material> |
| <Ex.:br.ufrn.materiaisservices.dto.MaterialDetalhadoDto> | <sipac.comum.material, sipac.comum.grupo_material, sipac.comum.unidade_medida |
Plano de Teste
Sistema: Barramento-Serviços
Módulo: Materiais-Services
Link(s): materiais-services/
Usuário: Não se aplica