Help Center

Menu

SOAP API File Retrieval Service

Last Updated: 22 May 2017

The SOAP API File Retrieval Service asset manages the file asset functions of the SOAP Server including uploading and downloading files.

To add a SOAP API File Retrieval Service, go to Web Services -> SOAP API File Retrieval Service. For the API to work, it must be created under a SOAP Server within the Web Services folder. The API will then be available to enable on the Details screen of the SOAP Server.

You can configure the settings of the SOAP API File Retrieval Service on its associated asset screens. The majority of these screens are the same or similar to those for a Standard Page and are described in the Asset Screens manual. In this chapter we will describe the Details screen, which is different for a SOAP API File Retrieval Service.

Bookmarks to the headings on this page:

  1. Details Screen
  2. Operations

Details Screen

The Details screen allows you to configure the interface functions for the SOAP API File Retrieval Service. For more information about the Status, Future Status, Thumbnail and Details sections, refer to the Details Screen chapter in the Asset Screens manual.

Interface Settings

This section allows you to control which functions the SOAP API File Retrieval Service will be able to provide when enabled on a SOAP Server.

In the Function List, select Enabled for the functions you want to make available on the API. For a full explanation of these functions, see the Operations section below.

Operations

The operations that are managed by the SOAP API File Retrieval Service are as follows:

See the sections below for more information on each of the operations available on this API.

Download
  Elements -
Parameter [Param Type]		 Min Occurs Max Occurs Type
DownloadSoapInput
Download		 AssetID [string] 1 1 simple
DownloadSoapOutput
DownloadResponse		 FileName [string]
FileType [string]
FileSize [string]
LastModified [string]
FileContentBase64 [string]		 0
0
0
0
0		 1
1
1
1
1		 simple
simple
simple
simple
simple

The Download operation will download a file asset, such as an Image or Text File, from the system. The parameters available for this operation are as follows:

  • AssetID: the asset ID of the file asset to download. This parameter is mandatory.
Example Request
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:Download>
      <AssetID>100</AssetID>
    </ns1:Download>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Example Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:DownloadResponse>
      <FileName>File.txt</FileName>
      <FileType>txt</FileType>
      <FileSize>6</FileSize>
      <LastModified>21-03-2011 13:09:52</LastModified>
      <FileContentBase64>VGhpcyBpcyBhIHRlc3QgZmlsZQ==</FileContentBase64>
    </ns1:DownloadResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope> 
Upload
  Elements -
Parameter [Param Type]		 Min Occurs Max Occurs Type
UploadSoapInput
Upload		 AssetID [string]
FileName [string]
FileContentBase64 [string]   		 1
1
1		 1
1
1		 simple
simple
simple

UploadSoapOutput


UploadResponse

 UploadResult [string]    0 1 simple

The Upload operation will upload to an existing file asset within the system. The parameters available for this operation are as follows:

  • AssetID: the asset ID of the file asset to upload to. This parameter is mandatory.
  • FileName: the name of the file to upload. The file name should include the file extension, for example myhouse.jpg. This parameter is mandatory.
  • FileContentBase64: the file data of the file to upload in binary form. This parameter is mandatory.
Example Request
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:Upload>
      <AssetID>150</AssetID>
      <FileName>file.txt</FileName>
      <FileContentBase64>VGhpcyBpcyBhIHRlc3QgZmlsZQ==</FileContentBase64>
    </ns1:Upload>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Example Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:UploadResponse>
      <UploadResult>1</UploadResult>
    </ns1:UploadResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
GetFileInformation
  Elements -
Parameter [Param Type]		 Min Occurs Max Occurs Type
GetFileInformationSoapInput
GetFileInformation		 AssetID [string] 1 1 simple
GetFileInformationSoapOutput
GetFileInformationResponse		 FileName [string]
FileType [string]
FileSize [string]
LastModified [string]
FileSha1Hash [string] 		0
0
0
0
1		 1
1
1
1
1		 simple
simple
simple
simple
simple

The GetFileInformation operation will return information from a specified file asset. The parameters available for this operation are as follows:

  • AssetID: the asset ID of the file asset to return information from. This parameter is mandatory.
Example Request
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:GetFileInformation>
      <AssetID>100</AssetID>
     </ns1:GetFileInformation>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>
Example Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:GetFileInformationResponse>
      <FileName>File.txt</FileName>
      <FileType>txt</FileType>
      <FileSize>6</FileSize>
      <LastModified>21-03-2011 13:09:52</LastModified>
      <FileSha1Hash>bdbb0cca75ec3a652bf3f20b01f5f12cfe020122</FileSha1Hash>     
    </ns1:GetFileInformationResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope> 
GetImageInformation
  Elements -
Parameter [Param Type]		 Min Occurs Max Occurs Type
GetImageInformationSoapInput
GetImageInformation		 AssetID [string] 1 1 simple
GetImageInformationSoapOutput
GetImageInformationResponse		 FileName [string]
FileTitle [string]
FileType [string]
FileSize [string]
MimeType [string]
ImageWidth [string]
ImageHeight [string
LastModified [string]		 0
0
0
0
0
0
0
0		 1
1
1
1
1
1
1
1		 simple
simple
simple
simple
simple
simple
simple 
simple

The GetImageInformation operation will return information from a specified Image asset. The parameters available for this operation are as follows:

  • AssetID: the asset ID of the Image asset to return information from. This parameter is mandatory.
Example Request
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:GetImageInformation>
      <AssetID>160</AssetID>
    </ns1:GetImageInformation>
  </SOAP-ENV:Body>
 </SOAP-ENV:Envelope>
Example Response
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://SYSTEM_ROOT_URL/_web_services/soap-server">
  <SOAP-ENV:Body>
    <ns1:GetImageInformationResponse>
      <FileName>Image.jpg</FileName>
      <FileTitle>Pic</FileTitle>
      <FileType>image</FileType>
      <FileSize>43037</FileSize>
      <MimeType>image/jpeg</MimeType>
      <ImageWidth>553</ImageWidth>
      <ImageHeight>208</ImageHeight>
      <LastModified>01-05-2011 10:23:56</LastModified>    
    </ns1:GetImageInformationResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Previous Chapter Next Chapter