Versão: Next

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ção	web/wwwroot/ws/java/document/DownloadEletronicFileRequestType.java
Retorno	web/wwwroot/ws/java/document/DownloadEletronicFileResponseType.java

Requisição:

Identificador	Requerido	Descrição
IDDOCUMENT	X	Identificador do documento.
IDREVISION		Identificador da revisão.
IDUSER		A partir da 2.0 este parâmetro tornou-se obsoleto. Na importação, deixe-o em branco.
FGCONVERTOPDF		Informar 1 para baixar o arquivo em pdf, se existir, senão baixa o original.
IDCATEGORY		Identificador da categoria do documento.
FGWATERMARK		Informar o valor 1 para baixar o arquivo com marca d’água. Obs.: Somente para arquivos PDF.
NMFILE		Nome do arquivo com a extensão.
FGFILELINK		Informar 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:

Identificador	Descrição
return	SUCESSO: 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.