# Como obter a estrutura de campos da biblioteca

## Visão geral

É possível obter a estrutura de campos da aplicação e de sistema através do Serviço Web abaixo:

* **Serviço Web**: *https\://\<servidor do* Zeev doc&#x73;*>/services/silentLogin.svc*
* **Método**: GetXmlModel(string applicationCode), retorno string.

### Estrutura modelo do XML para retorno dos campos da biblioteca

Confira abaixo o modelo de estrutura XML para a Consulta de documentos: o retorno de campos da aplicação e de sistema (GetXmlModel):

| 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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| <p><br>      \<module name=" " /></p>                                                                                                                | <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><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>                                                                                                                                            | -                                  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| \<event name=" ">                                                                                                                                    | Não                                | Estrutura contendo configurações sobre os módulos que serão acessados.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| <p><br><br><br><br><br><br>            \<option showHeader=" " showFloatMenu=" " openHeader=" " openFloat=" " fullscreen=" " viewerTarget=" " /></p> | <p><br><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.</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'.</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| \<fields>                                                                                                                                            | -                                  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| <p><br><br><br>                     \<field name=" " visible=" " enabled=" " required=" " defaultValue=" "=" " defaultDescription=" " /></p>         | <p><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.<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.</p>                                                                                                                                                                                                  |
| \</ fields>                                                                                                                                          | -                                  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| \</ content>                                                                                                                                         | -                                  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| \</ event>                                                                                                                                           | -                                  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| \</ events>                                                                                                                                          | -                                  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| \</structure>                                                                                                                                        | -                                  | -                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            |
| \</eContent >                                                                                                                                        | -                                  | <p>-<br></p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |

Efetue o download do modelo de XML:

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


---

# 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-obter-a-estrutura-de-campos-da-biblioteca.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.
