Ongoing Warehouse logo

Ongoing Warehouse Developer

GetFileList

This function allows you to retrieve a list of files. In the system, files are generally attached either to orders or to articles. There are filters in this function which makes it possible to request the files which are attached to a specific order or article.

Each file has a unique FileId. After you have received the response from this function, you can take the FileId and use GetFile to retrieve the file itself.

Tags: GetFileList, FileSearchValues, GetFileListResponse, FilesInfoList, FileInfo

Request XML

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

<?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>
    <GetFileList xmlns="http://ongoingsystems.se/WSI">
      <UserName>string</UserName>
      <Password>string</Password>
      <FileSearchValues>
        <GoodsOwnerId>int</GoodsOwnerId>
        <GoodsOwnerCode>string</GoodsOwnerCode>
        <ArticleNo>string</ArticleNo>
        <ArticleName>string</ArticleName>
        <OrderNumber>string</OrderNumber>
        <OrderId>int</OrderId>
        <ArticleSystemId>int</ArticleSystemId>
      </FileSearchValues>
    </GetFileList>
  </soap:Body>
</soap:Envelope>
+

Request specification

GetFileList
UserName str(50) Req. Your username
Password str(50) Req. Your password
FileSearchValues object Req. An element of type FileSearchValues
FileSearchValues
GoodsOwnerId int Req.* The ID of your client. You must specify either GoodsOwnerId or GoodsOwnerCode.
GoodsOwnerCode str(400) Req.* The code of your client. You must specify either GoodsOwnerId or GoodsOwnerCode.
ArticleNo str(100) Only return files belonging to this article number.
ArticleName str(200) Only return files belonging to this article name.
OrderNumber str(50) Only return files belonging to this order number.
OrderId int Only return files belonging to this internal order id.
ArticleSystemId int Only return files belonging to this article system id. The article system id is Ongoing's internal id for an article.

Response XML

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?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>
    <GetFileListResponse xmlns="http://ongoingsystems.se/WSI">
      <GetFileListResult>
        <FilesInfoList>
          <FileInfo>
            <FileId>int</FileId>
            <FileName>string</FileName>
            <MimeType>string</MimeType>
            <GoodsOwnerId>int</GoodsOwnerId>
            <GoodsOwnerCode>string</GoodsOwnerCode>
            <ArticleNo>string</ArticleNo>
            <ArticleName>string</ArticleName>
            <OrderNumber>string</OrderNumber>
            <OrderId>int</OrderId>
            <ArticleSystemId>int</ArticleSystemId>
          </FileInfo>
          <FileInfo>
            <FileId>int</FileId>
            <FileName>string</FileName>
            <MimeType>string</MimeType>
            <GoodsOwnerId>int</GoodsOwnerId>
            <GoodsOwnerCode>string</GoodsOwnerCode>
            <ArticleNo>string</ArticleNo>
            <ArticleName>string</ArticleName>
            <OrderNumber>string</OrderNumber>
            <OrderId>int</OrderId>
            <ArticleSystemId>int</ArticleSystemId>
          </FileInfo>
        </FilesInfoList>
      </GetFileListResult>
    </GetFileListResponse>
  </soap:Body>
</soap:Envelope>
+

Response specification

GetFileListResponse
GetFileListResult object Contains a FilesInfoList
FilesInfoList
FileInfo object Contains elements of FileInfo
FileInfo
FileId int Ongoing's internal id for the file.
FileName str(300) The filename.
MimeType str(50) The MIME type of the file, specifying what kind of file it is.
GoodsOwnerId int The id the client which the file belongs to.
GoodsOwnerCode str(400) The code the client which the file belongs to.
ArticleNo str(100) The article number which the file belongs to.
ArticleName str(200) The article name which the file belongs to.
OrderNumber str(50) The order number which the file belongs to.
OrderId int The internal order id which the file belongs to.
ArticleSystemId int The article system id which the file belongs to.