# Como carregar a interface de consulta de documentos via API

## Visão geral

Confira abaixo o modelo de estrutura XML para a Consulta de documentos:

| 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="smlwebsearch" />                                                                                                                                                        | <p><br>Sim</p>                         | <p>Informações do módulo de entrada.<br>Atributo(s):<br><em>name</em> (obrigatório) - nome do módulo.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| <p><br>      \<application code=" " /></p>                                                                                                                                             | <p><br>Sim</p>                         | <p>Identificação da aplicação.<br>Atributo(s):<br><em>code</em> (obrigatório) - código da aplicação.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| \<userToken />                                                                                                                                                                         | Sim                                    | Token de identificação do usuário para SilentLogin. Disponibilizada interface para geração do token através de web service.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| <p><br>      \<access limit=" " expireDate=" " /></p>                                                                                                                                  | <p><br><br>Sim</p>                     | <p>Validade do acesso, podendo ser pela quantidade de acessos e pela data de expiração, valendo o que ocorrer primeiro.<br>Atributo(s):<br><em>limit</em> (obrigatório) - quantidade de execuções do token.<br><em>expireDate</em> (opcional) - data de validade do token.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| \<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>                                                                                                                                                                              | Não                                    | Estrutura contendo configurações sobre os módulos que serão acessados.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| \<event name="smlwebsearch">                                                                                                                                                           | <p><br>Sim</p>                         | <p>Campo que fará a chamada do módulo de Consulta.<br>Atributo(s):<br><em>name</em> (obrigatório) - nome do módulo que será aplicado um conjunto de configurações e regras</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| <p><br><br><br>            \<option showHeader=" " showFloatMenu=" " openHeader=" " openFloat=" " fullscreen=" " viewerTarget=" " parentUrl=" " /></p>                                 | <p><br><br><br><br><br>Não</p>         | <p>Dentro de <em>"option"</em> é feita a configuração da exibição da interface do módulo.<br>Atributo(s):<br><em>showHeader</em> (opcional) - exibir o cabeçalho da página - true/false<br><em>showFloatMenu</em> (opcional) - exibir o painel (menu) lateral esquerdo - true/false.<br><em>openHeader</em> (opcional) - manter o painel superior da página visível - true/false.<br><em>openFloat</em> (opcional) - manter o painel (menu) lateral esquerdo visível - true/false.<br><em>fullscreen</em> (opcional) - forçar a abertura da janela ocupando toda a tela - true/false.<br><em>viewerTarget</em> (opcional) - nome do frame. Possibilita configurar o frame em que os documentos abertos para visualização ou edição devem ser carregados.<br>Ex: \_blank.<br><em>parentUrl</em> (opcional) - url da página que fez a chamada e que tem o iframe nomeado no atributo "viewerTarget".</p>                                                                                                                                                                                                                                                                                                                                                                                                                       |
| <p><br>               \<content type=" "></p>                                                                                                                                          | <p><br>Sim</p>                         | <p>Identificação do conteúdo onde serão aplicadas as parametrizações.<br>Atributo(s):<br><em>type</em> (obrigatório) - 'basic' ou 'advanced'.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| \<fields>                                                                                                                                                                              | -                                      | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| <p><br><br><br><br><br>                     \<field name=" " visible=" " enabled=" " required=" " defaultValue=" " defaultValueEnd=" " defaultDescription=" " commandOrName=" " /></p> | <p><br><br><br><br><br><br><br>Não</p> | <p>Identificação do campo da aplicação.<br>Atributo(s):<br><em>name</em> (opcional) - nome do campo atribuído à aplicação. Para filtro por intervalo, informar o início no atributo "defaultValue" e o fim no atributo "defaultValueEnd". Observações: campo deve estar configurado para aceitar busca por intervalo.<br><em>visible</em> (opcional) - visibilidade do campo - true/false.<br><em>enabled</em> (opcional) - campo habilitado para edição - true/false.<br><em>required</em> (opcional) - preenchimento obrigatório - true/false.<br><em>defaultValue</em> (opcional) - texto ou valor padrão atribuído ao campo<br><em>defaultDescription</em> (opcional) - utilizado somente para atribuição de descrição padrão em campo do tipo Fonte de dados.<br><em>commandOrName</em> (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. <strong>Caso seja informado o defaultValue, o atributo commandOrName não será considerado.</strong></p> |
| \</ fields>                                                                                                                                                                            | -                                      | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| \<results itemsPerPage=" " showDeleted=" ">                                                                                                                                            | <p><br>Não</p>                         | <p>Forma de apresentação do resultado da busca em tela.<br>Atributo(s):<br><em>itemsPerPage</em> (opcional) - quantidade de registros exibidos por página no grid.<br><em>showDeleted</em> (opcional) - exibir registros excluídos logicamente - true/false.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
| <p><br><br>                     \<column name=" " sortable=" " group=" " visible=" " /></p>                                                                                            | <p><br><br>Não</p>                     | <p>Identificação da coluna do grid.<br>Atributo(s):<br><em>name</em> (opcional) - nome da coluna atribuída à aplicação.<br><em>sortable</em> (opcional) - permite a ordenação dos registros pela coluna - true/false.<br><em>group</em> (opcional) - permite o agrupamento de registros pela coluna - true/false.<br><em>visible</em> (opcional) - visibilidade do campo - true/false.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| \</ results>                                                                                                                                                                           | -                                      | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| \</ content>                                                                                                                                                                           | -                                      | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| <p><br>               \<action name=" " /></p>                                                                                                                                         | <p><br>Não</p>                         | <p>Executa a ação dos botões.<br>Atributo(s):<br><em>name</em> (opcional) - nome do botão.<br>Ex: search.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| \</ event>                                                                                                                                                                             | -                                      | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| \</ events>                                                                                                                                                                            | -                                      | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| \</structure>                                                                                                                                                                          | -                                      | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| \</eContent >                                                                                                                                                                          | -                                      | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |

Efetue o download do modelo de XML:

{% file src="/files/HPCgR9tO44qlIs2eWq44" %}

**Observação:** para ser possível abrir o documento selecionado em um iFrame os atributos "viewerTarget" e "parentUrl" devem estar preenchidos. Também é necessário a implementação de um código javascript na página que realizou a chamada, esse código permite trocar mensagens entre páginas mesmo em domínios diferentes. Segue abaixo código javascript:

`function setUrlViewer(event) {`

&#x20;    `//Nome (ID) do iFrame que será utilizado para abrir o documento`\
&#x20;    `var iFrameName = event.data.split('|')[ 0 ]`\
&#x20;    `//Url do documento para abertura no iFrame`\
&#x20;    `var url = event.data.split('|')[ 1 ]`\
&#x20;    `//Passando url para o iFrame`<br>

&#x20;    `document.getElementById(iFrameName).src = url;`

`}`

Além de incluir a função acima é necessário incluir um EventListener na página que fará a chamada para os iFrames, segue código:

`window.addEventListener("message", setUrlViewer, false);`


---

# 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-carregar-uma-interface-do-zeev-docs-em-outras-ferramentas-via-api/como-carregar-a-interface-de-consulta-de-documentos-via-api.md?ask=<question>
```

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.
