Navigation:  Integration via SOAP web services > Published web services > Document >

downloadEletronicFile

Previous  Top  Next

This method enables to download an electronic file. To use it, it is necessary to follow the standard documented below:

 

Java class

Request

web/wwwroot/ws/java/document/DownloadEletronicFileRequestType.java

Return

web/wwwroot/ws/java/document/DownloadEletronicFileResponseType.java

 

Request

ID #

Required

Description

IDDOCUMENT

X

Document ID #.

IDREVISION

 

Revision ID #.

IDUSER

 

Starting with version 2.0, this parameter became obsolete. During the import, leave it blank.

FGCONVERTOPDF

 

Enter 1 to download the file in pdf, if it exists; otherwise, downloads the original file.

IDCATEGORY

 

Document category ID #.

FGWATERMARK

 

Enter the value 1 to download the file with watermark.

Note: Only for PDF files.

NMFILE

 

File name with extension.

FGFILELINK

 

Enter 1 to return the link instead of the file.

 

Return

ID #

Description

return

SUCCESS: returns a vector with the metadata:

NMFILE: String; File name.

BINFILE: Byte[]; File content1.

FAILURE: returns a vector with the metadata:

ERROR: String; 0: Message with error.

 

1 - Content of the electronic file converted to Base64. If you are testing the use through web service data source, we suggest converting a small text using a website of your choosing.