GetFile

This function lets you retrieve information about a file from Ongoing WMS. Stored files might be e.g. reports in PDF or Excel format.

Tags: GetFile, GetFileResponse, File

Request XML

POST /xxx/Automation.asmx HTTP/1.1
Host: api.ongoingsystems.se
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ongoingsystems.se/Automation/GetFile"

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetFile xmlns="http://ongoingsystems.se/Automation">
      <UserName>string</UserName>
      <Password>string</Password>
      <FileId>int</FileId>
    </GetFile>
  </soap:Body>
</soap:Envelope>

Request specification

GetFile
UserName	string(50)	Req.	Your username
Password	string(50)	Req.	Your password
FileId	int	Req.	The id of the file. If you don't know it, use GetFileList to find it.

Response XML

<?xml version="1.0" encoding="utf-8" ?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetFileResponse xmlns="http://ongoingsystems.se/Automation">
      <GetFileResult>
        <FileName>string</FileName>
        <FileBytes>base64Binary</FileBytes>
        <MimeType>string</MimeType>
        <FileId>int</FileId>
        <FileWillBeDeletedAt>dateTime</FileWillBeDeletedAt>
      </GetFileResult>
    </GetFileResponse>
  </soap:Body>
</soap:Envelope>

Response specification

GetFileResponse
GetFileResult	File

File
FileName	string(300)	The filename.
FileBytes	base64Binary	The contents of the file, encoded using Base64.
MimeType	string(50)	The MIME type of the file, specifying what kind of file it is.
FileId	int	Ongoing WMS' public internal id for the file.
FileWillBeDeletedAt	dateTime	The date when the file will be deleted (may be null).