# 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\://\/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): | Estrutura do XML | Requerido | Descrição | | ----------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | \ | Sim | - | | \ | Sim | Raiz. | | \
| Sim | Cabeçalho de identificação pelo Zeev docs. | | \ |


Sim

|

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

| |


\

|


Sim

|

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

| | \ | Sim | Token de identificação do usuário para SilentLogin. Disponibilizada interface para geração do token através de web service. | | \ | 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. | | \ | Não | Usuário que será gravado o log de acesso e ação. | | \ | - | - | | \ | - | - | | \ | - | - | | \ | - | - | | \ | - | - | |



\

|





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.

| | \ | - | - | |









\

|










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.

| | \ | - | - | | \ | Não | - | | \ | Não | - | | \ |


Não

|

Campos do documento que serão retornados no resultado.
Atributo(s):
name (opcional) - nome do campo da aplicação.

| | \ | - | - | | \ | - | - | | \ | - | - | | \ | - | - | | \ | - | - | | \ | - | - | | \ | - |

-

| Efetue o download do modelo de XML: {% file src="/files/T58SDE1fCMP58RGCMJQT" %} #### Estrutura modelo do XML de retorno da consulta Confira abaixo o modelo de estrutura XML para o retorno da Consulta de documento (GetDocument): | Estrutura do XML | Requerido | Descrição | | ---------------------------------------------------------------------------------------------------------------------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | \ | Sim | Raiz. | | \ | Sim | Cabeçalho de identificação pelo Zeev docs. | | \ | - | - | |


\

|


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.

| | \ | Não | - | |





\

|





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

| | \ | Não | Contém todos os códigos de barras encontrados na imagem. | |



\

|



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.

| | \ | - | - | | \ | - | - | | \ | - | - | | \ | - | - | | \ | - | - | | \ | - | - | | \ | - | - |
Efetue o download do modelo de XML: {% file src="/files/MX9Zcv7zhcJcGzgulPUr" %} --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://kb.stoque.com.br/zeevdocs/integracoes/como-integrar-outras-ferramentas-com-o-zeev-docs/como-consultar-documentos-ou-obter-dados-de-um-documento.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.