Pular para o conteúdo principal
Versão: 2.2.3

downloadEletronicFile

Este método possibilita fazer o download de um arquivo eletrônico. Para utilizá-lo, é necessário seguir o padrão abaixo documentado.

Classe Java
Requisiçãoweb/wwwroot/ws/java/document/DownloadEletronicFileRequestType.java
Retornoweb/wwwroot/ws/java/document/DownloadEletronicFileResponseType.java

Requisição:

IdentificadorRequeridoDescrição
IDDOCUMENTXIdentificador do documento.
IDREVISIONIdentificador da revisão.
IDUSERA partir da 2.0 este parâmetro tornou-se obsoleto. Na importação, deixe-o em branco.
FGCONVERTOPDFInformar 1 para baixar o arquivo em pdf, se existir, senão baixa o original.
IDCATEGORYIdentificador da categoria do documento.
FGWATERMARKInformar o valor 1 para baixar o arquivo com marca d’água.
Obs.: Somente para arquivos PDF.
NMFILENome do arquivo com a extensão.
FGFILELINKInformar 1 para retornar o link ao invés do arquivo.

Estrutura da requisição:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:document">
<soapenv:Header/>
<soapenv:Body>
<urn:downloadEletronicFile>
<!--You may enter the following 8 items in any order-->
<urn:iddocument>?</urn:iddocument>
<urn:idrevision>?</urn:idrevision>
<urn:iduser>?</urn:iduser>
<urn:fgconverttopdf>?</urn:fgconverttopdf>
<urn:idcategory>?</urn:idcategory>
<urn:fgwatermark>?</urn:fgwatermark>
<urn:nmfile>?</urn:nmfile>
<urn:fgfilelink>?</urn:fgfilelink>
</urn:downloadEletronicFile>
</soapenv:Body>
</soapenv:Envelope>

Retorno:

IdentificadorDescrição
returnSUCESSO: retorna um vetor com os metadados:
▪ NMFILE: String; Nome do arquivo.
▪ BINFILE: Byte[]; Conteúdo do arquivo.
FALHA: retorna um vetor com os metadados:
▪ ERROR: String; 0: Mensagem com o erro ocorrido.