Como obter arquivo(s) de um documento

Visão geral

O Zeev docs permite que seja localizado e realizado o download do(s) arquivo(s) de um documento localizado pelo método de consulta de documentos. Para isso, é necessário submeter um XML semi-estruturado contento os identificadores do documento e do arquivo que deseja obter. Essa operação será descrita no procedimento abaixo:

  • Criação de um XML semiestruturado contendo os identificadores do documento e do(s) arquivo(s):

    • Consulta de arquivos.

  • Submeter XML para obtenção do arquivo serializado do documento. A instrução XML submetida é processada imediatamente pelo Zeev docs, retornando um XML semiestruturado.

    • Serviço Web: https://<servidor do Zeev docs>/services/silentLogin.svc

    • Método: GetDocumentFile(string xml), retorno string.

Estrutura modelo do XML de consulta de arquivos de um documento

Confira abaixo o modelo de estrutura XML para a Consulta de documento (GetDocumentFile):

Estrutura do XML
Requerido
Descrição

<?xml version="1.0" encoding="UTF-8"?>

Sim

-

<eContent>

Sim

Raiz.

<header>

Sim

Cabeçalho de identificação pelo Zeev docs.

<module name="SILENTLOGINGETDOCUMENT" />

Sim

Informações do módulo de entrada. Atributo(s): name (obrigatório) - nome do módulo.

<application code=" " />

Sim

Identificação da aplicação. Atributo(s): code (obrigatório) - código da aplicação.

<userToken />

Sim

Token de identificação do usuário para SilentLogin. Disponibilizada interface para geração do token através de web service.

<identification />

Não

Campo para ser utilizado na integração caso necessite registrar algum código de identificação do sistema que gerou o XML de SilentLogin.

<adHocUser />

Não

Usuário que será gravado o log de acesso e ação.

</ header>

-

-

<structure>

-

-

<events>

-

-

<event>

-

-

<content>

-

-

<paginate packageSize=" " packageIndex=" " />

Sim

Paginação, usado para dividir o retorno do arquivo serializado em pacotes. Atributo(s): packageSize (obrigatório) - tamanho do pacote do arquivo em bytes. packageIndex (obrigatório) - índice do pacote do arquivo que deseja obter (sempre inicia na posição 0).

<documentFile id=" " fileId=" " />

Sim

Dados do documento e arquivo. Atributo(s): id (obrigatório) - identificação do documento (IND_ID). fileId (obrigatório) - identificação do arquivo (IDXIMG).

</ content>

-

-

</ event>

-

-

</ events>

-

-

</structure>

-

-

</eContent >

-

-

Efetue o download do modelo de XML:

Estrutura modelo do XML de retorno da consulta de arquivos de um documento

Confira abaixo o modelo de estrutura XML para o retorno da Consulta de arquivos do documento (GetDocumentFile):

Estrutura do XML
Requerido
Descrição

<?xml version="1.0" encoding="UTF-8"?>

Sim

-

<eContent>

Sim

Raiz.

<document>

Sim

Cabeçalho de identificação pelo Zeev docs.

<files totalPackage=" " >

Sim

Arquivos. Atributo(s): totalPackage - total de pacotes necessários para retornar o arquivo completo.

<file id=" " address=" " size=" " order=" " fileAlias=" " sourceId=" " sourceAlias=" ">

Sim

File retorna o arquivo serializado. Atributo(s): id (obrigatório) - identificação do arquivo (IDXIMG_ID). address (obrigatório) - retorna o caminho físico do arquivo. size (obrigatório) - tamanho do arquivo em bytes. order (obrigatório) - ordem do arquivo dentro do documento. fileAlias (obrigatório) - alias do arquivo. sourceId (obrigatório) - identificação da origem do arquivo. sourceAlias (obrigatório) - alias da origem do arquivo.

</ file>

-

-

</ files>

-

-

</ document>

-

-

</ eContent >

-

-

Efetue o download do modelo de XML: