Como consultar documentos ou obter dados de um documento
Visão geral
O Zeev docs permite a localização de documentos e obtenção de dados de seus documentos e arquivos. Para localizar documentos ou um documento em específico, é necessário a submissão de XML semi-estruturando contendo os dados (campos) que serão utilizados para localização de um ou mais documentos, assim como os dados (campos) a serem retornados no caso de localização do documento, conforme descrito nesse procedimento.
Criação de XML semiestruturado contendo as instruções de acesso conforme o módulo desejado:
Consulta de documento;
Submeter XML para obtenção da relação de documentos retornados conforme busca. 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: GetDocument(string xml), retorno string.
Estrutura modelo do XML de consulta
Confira abaixo o modelo de estrutura XML para a Consulta de documento (GetDocument):
<?xml version="1.0" encoding="UTF-8"?>
Sim
-
<eContent>
Sim
Raiz.
<header>
Sim
Cabeçalho de identificação pelo Zeev docs.
<module name="SILENTLOGINSEARCH" />
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 e/ou usuários legados.
<adHocUser />
Não
Usuário que será gravado o log de acesso e ação.
</ header>
-
-
<structure>
-
-
<events>
-
-
<event>
-
-
<content>
-
-
<paginate pageSize="2" pageIndex="0" returnFile=" " returnBarcode=" " orderByField=" "orderBy=" " />
Sim
Paginação. Atributo(s): pageSize (obrigatório) - quantidade de registros que devem ser retornados por página consultada. pageIndex (opcional) - índice da página que deseja obter (sempre se inicia na posição 0). returnFile (obrigatório) - deve retornar o endereço físico do arquivo - true/false. returnBarcode (opcional) - retorna o XML com informações sobre o(s) código(s) de barras encontrados nos arquivos digitalizados. Caso não seja informado, será considerado false - true/false. orderByField (opcional) - campo pelo qual o resultado será ordenado. orderBy (opcional) (ASC ou DESC) - direção da ordenação.
<fields>
-
-
<field name=" " value=" " commandOrName=" " />
Não
Campos dos documentos. Atributo(s): name (obrigatório) - nome do campo da aplicação pela qual se deseja filtrar os documentos. value (obrigatório) - valor pelo qual o campo deve ser filtrado. commandOrName (opcional) - esse atributo só é válido para os campos de sistema DOCTYPE_ID, IDXQUEUE_ID, IDXSITDOC_ID e PNDRSN_ID. Ao utilizar o DOCTYPE_ID, o atributo commandOrName deve ser preenchido com o mesmo valor do campo "Comando" do tipo de documento que deseja realizar a busca. Para os demais, o atributo commandOrName deve ser preenchido com o mesmo valor do campo "Nome" da fila, situação e/ou pendência. Caso seja informado o defaultValue, o atributo commandOrName não será considerado. Caso a consulta seja realizada por um intervalo de valores, adicione duas vezes o elemento field, onde o nome do campo deverá ser composto por _A e _B em seu final (ex: "dataInclusao_A" e "dataInclusao_B"). Além disso, o valor preenchido na primeira linha deverá ser menor do que o valor preenchido na segunda linha.
</ fields>
-
-
<result>
Não
-
<columns>
Não
-
<column name="IND_ID" />
Não
Campos do documento que serão retornados no resultado. Atributo(s): name (opcional) - nome do campo da aplicação.
</ columns>
-
-
</ results>
-
-
</ content>
-
-
</ event>
-
-
</ events>
-
-
</structure>
-
-
</eContent >
-
-
Efetue o download do modelo de XML:
Estrutura modelo do XML de retorno da consulta
Confira abaixo o modelo de estrutura XML para o retorno da Consulta de documento (GetDocument):
<eContent>
Sim
Raiz.
<documents>
Sim
Cabeçalho de identificação pelo Zeev docs.
<document>
-
-
<field name=" " value=" " />
Sim
Identificação do campo da aplicação. Atributo(s): name (obrigatório) - nome do campo atribuído à aplicação. value (obrigatório) - valor pelo qual o campo.
<files>
Não
-
<file id=" " address=" " size=" " order=" " sourceId=" " sourceAlias=" " fileAlias=" ">
Não
File retorna o dados do arquivo. Atributo(s): id (opcional) - identificação do arquivo (IDXIMG_ID). address (opcional) - retorna o caminho físico do arquivo. size (opcional) - tamanho do arquivo em bytes. order (opcional) - ordem do arquivo dentro do documento. sorceId (opcional) - identificação da origem do arquivo. sourceAlias (opcional) - apelido da origem do arquivo. fileAlias (opcional) - apelido do arquivo
<barcodes>
Não
Contém todos os códigos de barras encontrados na imagem.
<barcode format=" " x1=" " y1=" " x2=" " y2=" " exception=" " canBreak=" ">
Não
Retorna o valor encontrado no código de barras. Atributo(s): format - tipo do código de barras x1, y1, x2 e y2 - posicionamento do código de barras reconhecido dentro da imagem; exception - identifica se esse código de barras é usado para descarte dos arquivos; canBreak - identifica se o código de barras foi usado para quebra de documentos dentro do lote.
</ barcode>
-
-
</ barcodes>
-
-
</ file>
-
-
</ files>
-
-
</ document>
-
-
</ documents>
-
-
</ eContent >
-
-
Efetue o download do modelo de XML: