Mudanças entre as edições de "Manuais:DANFEView/IntegracaoERP/XMLRequisicao"
| Linha 14: | Linha 14: | ||
=== Formato do XML de requisição === | === Formato do XML de requisição === | ||
| − | |||
| − | |||
<pre> | <pre> | ||
<?xml version="1.0" encoding="ISO-8859-1" ?> | <?xml version="1.0" encoding="ISO-8859-1" ?> | ||
| Linha 30: | Linha 28: | ||
</requisicao> | </requisicao> | ||
</pre> | </pre> | ||
| + | |||
| + | O atributo "encoding" pode conter "ISO-8859-1" (default) ou "UTF-8". Ele indica qual o conjunto de caracteres foi usado na geração do XML de requisição. A resposta será gerada utilizando-se do mesmo conjunto. | ||
| + | |||
| + | Há três grupos de TAGS no corpo do XML de requisição: "parametros", "filtros" e "filtros_avancados", onde cada qual pode conter as tags respectivas com os atributos "campo" e "valor". | ||
| + | |||
| + | Nenhum dos grupos de TAGS é obrigatório. Caso nenhum valor seja definido nesses grupos o DANFE View retornará todos os documento memorizados que tenham sido emitidos nos últimos 7 dias sem aplicar nenhum filtro, não extrairá os arquivos XML da base de dados e não gerará os PDF´s dos documentos. | ||
| + | |||
| + | Eis o que significa cada um desses grupos de TAGs: | ||
* <parametros> - Parâmetros adicionais que informam ao DANFE View que informações ele deve extrair da base de dados. | * <parametros> - Parâmetros adicionais que informam ao DANFE View que informações ele deve extrair da base de dados. | ||
Edição das 14h41min de 21 de outubro de 2019
XML de requisição
O envio de requisição de informações ao DANFE View se dá através de um arquivo XML que deve ser gerado na pasta tmp\integracao. Aconselha-se que cada arquivo de requisição tenha sempre um nome exclusivo para evitar confusões entre requisições e respostas antigas, bem como confusão entre requisições simultâneas nas diversas estações da rede. Por exemplo, pode-se incluir a data e a hora da requisição no nome do XML, ou algum número randômico. O desenvolvedor tem toda a liberdade para criar os nomes de acordo com os recursos disponíveis em sua linguagem de programação.
Após ser lido o arquivo XML da requisição é automaticamente removido pelo DANFE View, e um arquivo de resposta gerado na pasta tmp\integracao\res, com o mesmo nome do XML de requisição, apenas acrescentando o prefixo "ret-" ao seu nome.
- Exemplo:
- Se o XML de requisição for: C:\DANFEView\tmp\integracao\consulta-20191020-13h00m00s.xml
- O XML de resposta será: C:\DANFEView\tmp\integracao\res\ret-consulta-20191020-13h00m00s.xml
- Exemplo:
Formato do XML de requisição
<?xml version="1.0" encoding="ISO-8859-1" ?>
<requisicao>
<parametros>
<parametro campo="xxxxx" valor="yyyyyy" />
</parametros>
<filtros>
<filtro campo="xxxxx" valor="yyyyyy" />
</filtros>
<filtros_avancados>
<filtro campo="xxxxx" valor="yyyyyy" />
</filtros_avancados>
</requisicao>
O atributo "encoding" pode conter "ISO-8859-1" (default) ou "UTF-8". Ele indica qual o conjunto de caracteres foi usado na geração do XML de requisição. A resposta será gerada utilizando-se do mesmo conjunto.
Há três grupos de TAGS no corpo do XML de requisição: "parametros", "filtros" e "filtros_avancados", onde cada qual pode conter as tags respectivas com os atributos "campo" e "valor".
Nenhum dos grupos de TAGS é obrigatório. Caso nenhum valor seja definido nesses grupos o DANFE View retornará todos os documento memorizados que tenham sido emitidos nos últimos 7 dias sem aplicar nenhum filtro, não extrairá os arquivos XML da base de dados e não gerará os PDF´s dos documentos.
Eis o que significa cada um desses grupos de TAGs:
- <parametros> - Parâmetros adicionais que informam ao DANFE View que informações ele deve extrair da base de dados.
- <filtros> - Filtros simples para a pesquisa dos documentos. Equivalem aos filtros presentes na tela de pesquisa do DANFE View.
- <filtros_avancados> - Filtros avançados para a pesquisa dos documentos. Equivalem aos filtros avançados na tela de pesquisa do DANFE View.
