GetFileList

This function lets list files in Ongoing WMS. Files can be filtered by goods owner, article and order.

Tags: GetFileList, FileSearchValues, GetFileListResponse, FileList, FileInfo

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/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/Automation">
      <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>
        <InOrderId>int</InOrderId>
        <ShipmentId>int</ShipmentId>
        <FileNameBeginsWith>string</FileNameBeginsWith>
        <FileNameEndsWith>string</FileNameEndsWith>
      </FileSearchValues>
    </GetFileList>
  </soap:Body>
</soap:Envelope>

Request specification

GetFileList
UserName string(50) Req. Your username
Password string(50) Req. Your password
FileSearchValues FileSearchValues Req. An element of type FileSearchValues
FileSearchValues
GoodsOwnerId int Filter by goods owner id. Get files connected to goods owner.
GoodsOwnerCode string(400) Filter by goods owner code/name. Get files connected to goods owner.
ArticleNo string(100) Only return files belonging to this article number.
ArticleName string(200) Only return files belonging to this article name.
OrderNumber string(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 WMS' internal id for an article.
InOrderId int Only return files belonging to this inorder id.
ShipmentId int Only return files belonging to this shipment id.
FileNameBeginsWith string Only return files whose file names begins with this argument..
FileNameEndsWith string Only return files whose file names ends with this argument..

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>
    <GetFileListResponse xmlns="http://ongoingsystems.se/Automation">
      <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>
            <InOrderId>int</InOrderId>
          </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>
            <InOrderId>int</InOrderId>
          </FileInfo>
        </FilesInfoList>
      </GetFileListResult>
    </GetFileListResponse>
  </soap:Body>
</soap:Envelope>

Response specification

GetFileListResponse
GetFileListResult FileList
FileList
FilesInfoList FileInfo[] List of files.
FileInfo
FileId int Ongoing WMS' internal id for the file.
FileName string(300) The filename.
MimeType string(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 string(400) The code the client which the file belongs to.
ArticleNo string(100) The article number which the file belongs to.
ArticleName string(200) The article name which the file belongs to.
OrderNumber string(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.
InOrderId int The inorder id which the file belongs to.