◼️4. Documento

4.1.PUT/api/Documento/Put

O objetivo deste método é permitir que o usuário altere os dados de um documento.

A alteração é feita apenas nos dados dos campos indexadores (campos customizados e/ou lista).

Entrada

Neste serviço o usuário deve informar o id da unidade, id do cliente, id da árvore organizacional, id do documento e o JSON com os metadados que deseja alterar.

• idUnidade

• idCliente

• idArvoreOrganizacional

• idDocumento

• JSON com os dados do documento informado que serão alterados.

O usuário pode informar um ou mais campos que serão alterados.

Request boby

[
    {
        "valor": "string",//novo valor para o campo que está sendo alterado
        "campo": "string",//nome do campo que está sendo alterado
        "nomeLista": "string"//nome da lista, se o campo pertencer a uma lista
    }
]

Validações

O sistema valida:

• A permissão do usuário autenticado.

• Se o Id do documento existe e se pertence ao cliente informado.

• Se o Id do documento está vinculado ao id da árvore informado.

• Se os campos indexadores pertencem a árvore organizacional informada.

• Para indexadores de lista, o sistema valida se a árvore possui a configuração da lista.

1. Para Lista de Autocomplete ou Consolidação (Permitir a inclusão durante a alteração)

O sistema permite a inclusão de novos dados na lista. Os campos chaves, bem como os campos de importação obrigatória, devem ser informados.

Ao informar um campo chave que não existe na lista, o sistema inclui um novo item e associa ao documento que está sendo alterado.
Ao informar um campo chave que existe na lista, o sistema associa o item na lista e ao documento que está sendo alterado.

2. Para lista de Consolidação (Não Permitir a inclusão durante a alteração)

O sistema não permite a inclusão de novos dados na lista. Ou seja, deve-se realizar a importação da lista antes de iniciar o processo de cadastro de documentos.

Ao informar um campo chave que não existe na lista, o sistema não permite alterar o documento.
Ao informar um campo chave que existe na lista, o sistema associa o item na lista e ao documento que está sendo alterado.

Saída/Retorno

O sistema retorna a mensagem de registro alterado com sucesso.

Code: 200 - OK

Response

"Registro alterado com sucesso."

4.2.POST/api/Documento/Post

O objetivo deste método é permitir que o usuário cadastre documentos em determinado nível de árvore. O usuário pode incluir no documento um ou mais arquivos.

Entrada

Neste serviço o usuário deve informar o id da unidade, o id do cliente, o id da árvore organizacional e o JSON com os dados do documento.

• idUnidade

• idCliente

• idArvoreOrganizacional

• JSON com os dados do documento.

Quando documento eletrônico, informar o valor null no parâmetro codigoCaixa.
Quando documento Guarda Interna ou Guarda Terceirizada, informar o código da caixa que o documento será armazenado no parâmetro codigoCaixa.
O usuário deve informar os campos customizados e/ou de listas que estão configurados no idArvoreOrganizacional informado.
O documento que será criado pode ou não ter um ou mais arquivos anexados.

Request body

{
    "codigoCaixa": null,//null ou código da caixa
    "valoresCampos": [
        {
            "nomeLista": "string",//nome da lista se for campo de lista.
            "label": "string",//nome do campo
            "valorCampo": "string",//Valor do campo        
        },
        {
            "nomeLista": "string",
            "label": " string ",
            "valorCampo": " string "
        },
        {
            "nomeLista": "string",
            "label": " string ",
            "valorCampo": " string "
        }
    ],
    "arquivos": [//Arquivos que serão anexados ao documento criado
        {
            "arquivo": "bytes",//bytes do arquivo
            "contentType": "application/extensão",[//tipo do arquivo
            "extensao": "string",[//extensão do arquivo
            "nomeAmigavel": "string"[//nome do arquivo
        },
        {
            "arquivo": "bytes",
            "contentType": "application/extensão",
            "extensao": "string",
            "nomeAmigavel": "string"
        }
    ]
}

Validações

O sistema valida:

• A permissão do usuário autenticado.

• O código da caixa informado.

• Se o Id da arvore organizacional existe e se pertence ao cliente informado.

• Os campos indexadores informados.

Saída/Retorno

O sistema retorna o id e o código do documento cadastrado.

Code: 201 - Created

Response

[
    "Registro adicionado com sucesso.",
    "IdDocumento: 4298ca74-82ac-4fc2-95b3-33c176ff4323",
    "CodigoDocumento: 106609146"
]

4.3.GET/api/Documento/Get

O objetivo deste método é permitir que o usuário pesquise os documentos cadastrados em determinado nível de árvore. Além disso, permite filtrar as buscas informando mais parâmetros como campos indexadores, código do documento, código da caixa, e data cadastro.

Entrada

Neste serviço o usuário deve informar o id do cliente e pode informar alguns parâmetros para filtrar a busca por um ou mais documentos.

O usuário pode buscar um documento informando um ou mais campos indexadores. Para buscar por campos indexadores o usuário deve informar o nome e o valor do campo do campo.

Exemplo:

ValoresCampos[0].Label=nome do campo 1

ValoresCampos[0].ValorCampo=valor do campo 1

ValoresCampos1].Label=nome do campo 2

ValoresCampos[1].ValorCampo=valor do campo 2

Parâmetro

Descrição

Validações

O sistema valida:

• A permissão do usuário autenticado.

• Se informado, o sistema valida o código da caixa pertence ao cliente informado.

• Se informado, o sistema valida o código do documento pertence ao cliente informado.

• Se o Id da árvore organizacional existe e se pertence ao cliente informado.

• Os campos indexadores informados.

Saída/Retorno

O sistema retorna os documentos conforme os filtros de busca.

Code: 200 – OK

O parâmetro MetaDados é cada documento retornado na consulta com seus respectivos dados.

Somente serão retomados valores nos campos "LabelPaginas", "QtdDocumentos" e "TotalPaginas se o usuário informar o parâmetro “BuscarQtdPaginasDocumento”.

Response

{
    "LabelPaginas": "1/1",//página da consulta
    "QtdDocumentos": 1, //quantidade de documento retornados
    "TotalPaginas": 1, //quantidade de páginas da consulta
    "Metadados": [//dados do documento
        {
            "MetaDados": [
                {
                    "Label": "Id",
                    "Valor": "guid"//id do documento
                },
                {
                    "Label": "ArvoreDocumental",
                    "Valor": "string"//caminho completo arvore organizacional
                },
                {
                    "Label": "string",//label campo indexador 1
                    "Valor": "string"//valor campo indexador 1
                }
                {
                    "Label": "Código do Documento",
                    "Valor": "string"//código do documento
                },
                {
                    "Label": "Status",
                    "Valor": "string"//status do documento
                },
                {
                    "Label": "Total de Arquivos",
                    "Valor": "string" //total de arquivos do documento
                },
                {
                    "Label": "Nº Caixa",
                    "Valor": "string"//código da caixa , se houver
                },
                {
                    "Label": "Nº Provisório",
                    "Valor": ""
                },
                {
                    "Label": "Nº SubCaixa",
                    "Valor": ""
                },
                {
                    "Label": "Nº SubCaixa Provisório",
                    "Valor": ""
                },
                {
                    "Label": "Tipo de Guarda",
                    "Valor": "string"//tipo de guarda
                },
                {
                    "Label": "Icone_Reserva",
                    "Valor": ""
                },
                {
                    "Label": "Vencimento TTD",
                    "Valor": "14/08/2021"//vencimento do documento, se houver
                }
            ]
        }
    ]
}

Caixa: Ao informar este campo, o sistema retorna os documentos cadastrados no idArvoreOrganizacional e na caixa informada.

Documento: Ao informar este campo, o sistema retorna o documento informado.

DataCadastroInicial: Ao informar este campo, o sistema retorna os documentos cadastrados no idArvoreOrganizacional, a partir da Data cadastro informada.

DataCadastroFinal: Ao informar este campo, o sistema retorna os documentos cadastrados no idArvoreOrganizacional, até a Data cadastro informada.

DataVencimento: Ao informar este campo, o sistema retorna os documentos cadastrados no idArvoreOrganizacional, com vencimento na Data vencimento informada.

IdUsuarioIndexador: Ao informar este campo, o sistema retorna os documentos cadastrados no idArvoreOrganizacional pelo usuário indexador informado.

IdDocumentoStatus: Ao informar este campo, o sistema retorna os documentos cadastrados no idArvoreOrganizacional com status informado.

IdCaixaTipo: Ao informar este campo, o sistema retorna os documentos cadastrados no idArvoreOrganizacional e armazenados em caixas do tipo informado.

ValoresCampos: Ao informar estes campos, o sistema retorna os documentos cadastrados no idArvoreOrganizacional que contém os dados dos campos indexadores (campos customizados e/ou de lista) informados.

Pagina: Ao informar este campo, o sistema retorna os documentos cadastrados no idArvoreOrganizacional que estão na página informada. A consulta é paginada.

BuscarQtdPaginasDocumento (true ou false): Ao informar este campo, o sistema retorna os documentos cadastrados no idArvoreOrganizacional exibindo a quantidade documentos retornados.

4.4.DELETE/api/Documento/Delete

O objetivo deste método é permitir que o usuário exclua um documento.

Entrada

Neste serviço o usuário deve informar o id da unidade, o id do cliente, id da árvore organizacional e o id do documento que será excluído.

• idUnidade

• idCliente

• idArvoreOrganizacional

• idDocumento

Validações

O sistema valida:

• O sistema valida a permissão do usuário autenticado.

• O sistema valida o id do documento pertence ao cliente informado.

• O sistema valida se o Id da arvore organizacional existe e se pertence ao cliente informado.

Saída/Retorno

O sistema retorna a mensagem de exclusão com sucesso.

Code: 200 - OK

Response

"Documento excluído com sucesso!"

Anterior3. Billing Siguiente5. Lista

Última actualización hace 5 días