API Depósito de Insumo

Atributos da chave primária simples

codigoDeposito.

Premissa para que a API esteja disponível e funcional

Possuir ativado controle de digitação de depósito de insumo no apontamento de insumos. Esta informação é identificada pelo parâmetro da seção ATRC_INS e entrada FG_DIG_DEP_INS estando com valor 1, que é responsável por disponibilizar a opção de menu contendo o cadastro no módulo Totvs Agro Bioenergia Configuração Central(CFGCEN.EXE). Caso contrário a API retornará a seguinte mensagem: 

"message": "Opção não disponível para parametrização atual".

GET

http:127.0.0.1:8080/entity/v1/depositoInsumos?page=1&pagesize=20

{
    "hasNext": false,
    "items": [
        {
            "codigoDeposito": 1,
            "descricaoDeposito": "Novo depósito fazenda São Geraldo",
            "codigoDepositoERP": "CODERP789012345",
            "codigoOrganizacaoERP": "ORGERP78912345",
            "codigoEmpresaERP": "EMPERP789012345",
            "codigoLocalizacaoERP": null,
            "rowversion": 1
        },
        {
            "codigoDeposito": 2,
            "descricaoDeposito": "Novo depósito fazenda São Lucas",
            "codigoDepositoERP": "123456789",
            "codigoOrganizacaoERP": "ORG_ERP",
            "codigoEmpresaERP": "EMP_ERP",
            "codigoLocalizacaoERP": null,
            "rowversion": 1
        },
        {
            "codigoDeposito": 3,
            "descricaoDeposito": "Novo depósito fazenda São  II",
            "codigoDepositoERP": "CODERP78901II",
            "codigoOrganizacaoERP": "ORGERP789II",
            "codigoEmpresaERP": "EMPERP7890OO",
            "codigoLocalizacaoERP": null,
            "rowversion": 1
        }
    ]
}

Parâmetros

• page: Número da página.
• pagesize: Quantidade máxima de registros por página.

Observações

- Todos os atributos podem ser usados como parâmetro para a busca. Ponto de atenção é o atributo codigoLocalizacaoERP que  se estiver com valor vazio(null) então a pesquisa não retornará resultado.

POST

http:127.0.0.1:8080/entity/v1/depositoInsumos→ cadastra um objeto

http:127.0.0.1:8080/entity/v1/depositoInsumos/batch  → cadastra uma lista do objeto.

Estrutura de dados para envio:

{
    "descricaoDeposito": "Novo depósito fazenda São Geraldo",
    "codigoDepositoERP": "CODERP789012345",
    "codigoOrganizacaoERP": "ORGERP78912345",
    "codigoEmpresaERP": "EMPERP789012345"
} ou uma lista 
[{
    "descricaoDeposito": "Novo depósito fazenda São Geraldo",
    "codigoDepositoERP": "CODERP789012345",
    "codigoOrganizacaoERP": "ORGERP78912345",
    "codigoEmpresaERP": "EMPERP789012345"
}, {
    "descricaoDeposito": "Novo depósito fazenda São Lucas",
    "codigoDepositoERP": "123456789",
    "codigoOrganizacaoERP": "ORG_ERP",
    "codigoEmpresaERP": "EMP_ERP"
}]

Estrutura de dados retorno:

{
    "codigoDeposito": "3",
    "descricaoDeposito": "Novo depósito fazenda São  II",
    "codigoDepositoERP": "CODERP78901II",
    "codigoOrganizacaoERP": "ORGERP789II",
    "codigoEmpresaERP": "EMPERP7890OO",
    "rowversion": 1
} ou uma lista   {
    "status": "COMPLETED",
    "totalRecords": 2,
    "processedRecords": 2,
    "failRecords": 0,
    "result": [
        {
            "recordId": {
                "codigoDeposito": "1"
            },
            "status": "SUCCESS",
            "message": null
        },
        {
            "recordId": {
                "codigoDeposito": "2"
            },
            "status": "SUCCESS",
            "message": null
        }
    ]
}

Observações

O atributo codigoDeposito terá seu valor ignorado caso seja enviado pois: 

- A geração do código do depósito é controlada pelo parâmetro da seção INT_ERP e entrada FG_GERCOD_DEPOSITO que possui dois, e somente dois, valores válidos: 1-Mesmo código ERP/2-Sequencial(último do banco+1).

    Para uso do valor 1(Mesmo código ERP) há duas restrições: o código do ERP deve possuir no máximo 8 caracteres e ser composto somente por dígitos numéricos pois o código do depósito Bioenergia é do tipo numérico e tamanho máximo de 8. As mensagens de validação a seguir poderão aparecer caso sejam necessárias:

      a) "Inserção não permitida pois o código de depósito ERP excedeu o tamanho de 8 caracteres impossibilitando seu uso como código do depósito, tamanho atual XXX", onde no lugar de XXX será demonstrada a quantidade de caracteres que o código de depósito ERP enviado possui.

      b) "Inserção não permitida pois o código de depósito ERP necessita possuir somente dígitos numéricos em sua composição, impossibilitando seu uso como código do depósito".

      Desta forma indicamos avaliar se o valor 1 de controle da geração de código é adequada no momento da implantação e do uso da API. 

     Para uso do valor 2(Sequencial(último do banco+1)) não há restrições pois a API gerenciará a busca do código adequado liberando assim o atributo código de depósito no ERP para ter sua capacidade total de 15 caracteres.

    Caso o parâmetro da seção INT_ERP e entrada FG_GERCOD_DEPOSITO não exista na base de dados do Bioenergia ou estiver com valor numérico menor que 1 ou maior que 2, será adotado pela API o valor padrão 1-Mesmo código ERP para a geração do código de depósito no Bioenergia.

- O atributo codigoLocalizacaoERP não é obrigatório enviar.

- O retorno do cadastro em lista é uma lista com a pk do objeto, status e mensagem. Em caso de erro é registrado no status e na mensagem o ocorrido.

- Caso seja enviado valor maior que o tamanho máximo dos atributos, estes terão seus conteúdos recortados não impedindo a conclusão da ação.

PUT

http:127.0.0.1:8080/entity/v1/depositoInsumos→ atualiza um objeto

http:127.0.0.1:8080/entity/v1/depositoInsumos/batch  → atualiza uma lista de objeto.

Observações

- É obrigatório informar o atributo codigoDepositoERP filtrando único valor.

- O atributo codigoDeposito terá seu valor ignorado caso seja enviado pois será recuperado automaticamente de acordo com o atributo obrigatório codigoDepositoERP.

- O retorno do update em lista é uma lista com a pk do objeto, status e mensagem. Em caso de erro é registrado no status e na mensagem o ocorrido.

- Caso seja enviado valor maior que o tamanho máximo dos atributos, estes terão seus conteúdos recortados não impedindo a conclusão da ação.

DELETE

http:127.0.0.1:8080/entity/v1/depositoInsumos

Observações

- É obrigatório informar o atributo codigoDepositoERP filtrando único valor ou o atributo codigoDeposito filtrando único valor. 

- O atributo codigoDeposito tem precedência para efetuar a deleção caso os dois atributos obrigatórios sejam informados simultâneamente.

- Demais campos que forem informados serão desprezados.