servicos materiais

Webservices Módulo Controle de Materiais

Materiais


  1. Webservices Módulo Controle de Materiais
    1. Link base
      1. Descrição do serviço
      2. Documentação do serviço
      3. Instrução de consumo e desenvolvimento por terceiros
    2. /requisicao/criarRequisicao
      1. Descrição do serviço
      2. Documentação do serviço
      3. Instrução de consumo e desenvolvimento por terceiros
    3. /requisicao/consultarRequisicao
      1. Descrição do serviço
      2. Documentação do serviço
      3. Instrução de consumo e desenvolvimento por terceiros
    4. /inventario/estadoDoBem
      1. Descrição do serviço
      2. Documentação do serviço
      3. Instrução de consumo e desenvolvimento por terceiros
    5. /inventario/situacaoDoBem
      1. Descrição do serviço
      2. Documentação do serviço
      3. Instrução de consumo e desenvolvimento por terceiros

Link base

Descrição do serviço

Webservice disponibilizados para a integração com a Solução de materiais

Documentação do serviço

O acesso a este serviço é realizado utilizando o endereço {GRP}/service/materiais .

Para todos os serviços abaixo deve ser encaminhado a chave de autenticação, que deve ser obtida no serviço Autenticação.

Instrução de consumo e desenvolvimento por terceiros




/requisicao/criarRequisicao

Descrição do serviço

Cria uma requisição e itens via WebServices.
Para a criação de uma nova requisição devem ser informados os seguintes atributos:

Requisição
administracao Código da administração onde será criada a requisição. Formato: Numérico.
almoxarifado Identificação do almoxarifado na Solução de Origem das informações. Formato: Texto.
data Data de criação da requisição. Formato: Data.
documento Identificação do documento da requisição. Formato: Texto.
finalidade Finalidade da requisição na Solução de Origem das informações. Formato: Texto.
identificador Identificador único da requisição na Solução de Origem das informações. Formato: Texto.
itens Lista dos itens, conforme estrutura abaixo.
local Identificação do local solicitante na Solução de Origem das informações. Formato: Texto.
observacao Observação da requisição. Formato: Texto.
origem Identificação da origem da integração. Formato: Texto.
requisitante Nome do requisitante. Formato: Texto.
Itens
codigo Identificação do produto na Solução de Origem das informações. Formato: Texto.
quantidadeAtendida Quantidade atendida/entregue do item na requisição. Formato: Numérico.
quantidadeSolicitada Identificação da origem da Integração. Formato: Numérico.
Como resultado, são retornados as seguintes informações:

Retorno
seguenciaRequisicao Identificador único da requisição criada na Solução GRP. Formato: Numérico.
exercicio Exercício da requisição criada na Solução GRP. Formato: Texto.
numero Número da requisição criada na Solução GRP. Formato: Numérico.

Documentação do serviço

Nesse serviço o método de chamada é o POST.
O consumo deve ser com codificação UTF-8 e o tipo de Midia consumida é APPLICATION_JSON.
O retorno é codificação UTF-8 e o tipo de Midia retornada é APPLICATION_JSON.

Header: 
  key:Authorization  value:{   "token": "eyJhbGciOiJIU...QBeZXH1amEhHl" }
JSON Body REQUEST: 
 {
     "administracao": 1,
     "almoxarifado": "141",
     "data": "2015-05-08",
     "documento": "DOCUMENTO DE TESTE",
     "finalidade": "FINALIDADE DE TESTE",
     "identificador": "12345",
     "itens": [
                {
                    "codigo": "1009510095",
                    "quantidadeAtendida": 0.0,
                    "quantidadeSolicitada": 8.0
                }, {
                    "codigo": "100100",
                    "quantidadeAtendida": 0.0,
                    "quantidadeSolicitada": 2.0
                }, {
                    "codigo": "1003610036",
                    "quantidadeAtendida": 0.0,
                    "quantidadeSolicitada": 4.0
     }],
     "local": "454545",
     "observacao": "OBSERVACAO DE TESTE",
     "origem": "INTEGRADOR",
     "requisitante": "JOAO DA SILVA"
   }

JSON Body RESPONSE: 
 {
     "seguenciaRequisicao": 2683,
     "exercicio":"2015",
     "numero":254
  }

Instrução de consumo e desenvolvimento por terceiros




/requisicao/consultarRequisicao

Descrição do serviço

Consultar os dados da requisição e seus itens via WebServices.
Para realizar a consulta devem ser informados os seguintes atributos:

Requisição
origem Identificação da origem da integração. Formato: Texto.
administracao Código da administração da requisição. Formato: Numérico.
sequenciaRequisicao Identificador único da requisição criada na Solução GRP. Formato: Numérico.
Como resultado, são retornados as seguintes informações:

Requisição
administracao Código da administração onde será criada a requisição. Formato: Numérico.
almoxarifado Identificação do almoxarifado na Solução de Origem das informações. Formato: Texto.
data Data de criação da requisição. Formato: Data.
documento Identificação do documento da requisição. Formato: Texto.
finalidade Finalidade da requisição na Solução de Origem das informações. Formato: Texto.
identificador Identificador único da requisição na Solução de Origem das informações. Formato: Texto.
itens Lista dos itens, conforme estrutura abaixo.
local Identificação do local solicitante na Solução de Origem das informações. Formato: Texto.
observacao Observação da requisição. Formato: Texto.
origem Identificação da origem da integração. Formato: Texto.
requisitante Nome do requisitante. Formato: Texto.
Itens
codigo Identificação do produto na Solução de Origem das informações. Formato: Texto.
quantidadeAtendida Quantidade atendida/entregue do item na requisição. Formato: Numérico.
quantidadeSolicitada Identificação da origem da Integração. Formato: Numérico.
Lotes
codigo Identificação do produto na Solução de Origem das informações. Formato: Texto.
quantidadeAtendida Quantidade atendida/entregue do item na requisição. Formato: Numérico.
quantidadeSolicitada Identificação da origem da Integração. Formato: Numérico.

Documentação do serviço

Nesse serviço o método de chamada é o POST.
O retorno é codificação UTF-8 e o tipo de Midia retornada é APPLICATION_JSON.
O retorno é um objeto da classe RetornoConsultaRequisicao.

Header: 
  key:Authorization  value:{ "token": "eyJhbGciOiJIU...QBeZXH1amEhHl" }
JSON Body REQUEST: 
 {
     "origem": "PRONTO",
     "administracao": ##,
     "sequenciaRequisicao": ##
   }

JSON Body RESPONSE: 
 {
   "exercicio": "2015",
   "numero": 111,
   "identificador": 123456,
   "documento": "DOCUMENTO",
   "almoxarifado": "141",
   "data": "2015-05-08",
   "dataRequisicao": "2015-05-19",
   "dataAtendimento": null,
   "dataEstorno": null,
   "local": "454545",
   "situacao": "Digitada",
   "observacao": "OBS",
   "finalidade": "FINALIDADE",
   "requisitante": "EU DE NOVO - MAIS UMA VEZ",
   "itens": [
     {
       "sequencia": 62484,
       "codigo": "100100",
       "quantidadeSolicitada": 1,
       "quantidadeAtendida": 0,
       "motivo": null,
       "lotes": null
     },
     {
       "sequencia": 62482,
       "codigo": "150150",
       "quantidadeSolicitada": 2,
       "quantidadeAtendida": 0,
       "motivo": null,
       "lotes": null
     },
     {
       "sequencia": 62483,
       "codigo": "1009510095",
       "quantidadeSolicitada": 3,
       "quantidadeAtendida": 0,
       "motivo": null,
       "lotes": null
     }
   ]
  }

Instrução de consumo e desenvolvimento por terceiros




/inventario/estadoDoBem

Descrição do serviço

Consultar os tipos de estados de conservação dos bens via WebServices.
Esta consulta não recebe atributos, somente retorna a listagem completa das opções.

Como resultado, são retornados as seguintes informações:

Lista de Estados de Conservação
codigo Código do estado de conservação. Formato: Numérico.
descricao Descrição do estado de conservação. Formato: Texto.

Documentação do serviço

Nesse serviço o método de chamada é o GET.
O retorno é codificação UTF-8 e o tipo de Midia retornada é APPLICATION_JSON.

Header: 
  key:Authorization  value:{   "token": "eyJhbGciOiJIU...QBeZXH1amEhHl" }

JSON Body RESPONSE: 
[
    {
        "codigo": 1,
        "descricao": "Bom"
    },
    {
        "codigo": 2,
        "descricao": "Danificado"
    },
    ...,
    {
        "codigo": 99,
        "descricao": "Inservível"
    }
]

Instrução de consumo e desenvolvimento por terceiros




/inventario/situacaoDoBem

Descrição do serviço

Consultar as situações dos bens no inventário via WebServices.
Esta consulta não recebe atributos, somente retorna a listagem completa das opções.

Como resultado, são retornados as seguintes informações:

Lista de Situações
codigo Código do estado de conservação. Formato: Numérico.
nome Descrição do estado de conservação. Formato: Texto.
encontrado Indicativo de pendente ('P'), encontrado ('S') ou não encontrado ('N'). Formato: Texto.

Documentação do serviço

Nesse serviço o método de chamada é o GET.
O retorno é codificação UTF-8 e o tipo de Midia retornada é APPLICATION_JSON.

Header: 
  key:Authorization  value:{   "token": "eyJhbGciOiJIU...QBeZXH1amEhHl" }

JSON Body RESPONSE: 
[
    {
        "codigo": "1",
        "nome": "Pendente",
        "encontrado": "P"
    },
    {
        "codigo": "2",
        "nome": "Atualizado",
        "encontrado": "S"
    },
    ...,
    {
        "codigo": "7",
        "nome": "Encontrado em Outro Local",
        "encontrado": "N"
    }
]

Instrução de consumo e desenvolvimento por terceiros