GetArticleItemsByQuery

Returns all article items which match a particular query.

Tags: GetArticleItemsByQuery, Query, SpecialFilters, GetArticleItemsByQueryResponse, GetArticleItemsByQueryResult, ArticleItemInfo, ArticleInfo

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/GetArticleItemsByQuery"

<?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>
    <GetArticleItemsByQuery xmlns="http://ongoingsystems.se/Automation">
      <UserName>string</UserName>
      <Password>string</Password>
      <Query>
        <Locations>
          <string>string</string>
          <string>string</string>
        </Locations>
        <GoodsOwnerId>int</GoodsOwnerId>
        <ArticleItemId>int</ArticleItemId>
        <ArticleDefId>int</ArticleDefId>
        <SpecialFilters>
          <OnlyGetArticleItemsInLocationsToBeHandled>boolean</OnlyGetArticleItemsInLocationsToBeHandled>
        </SpecialFilters>
      </Query>
    </GetArticleItemsByQuery>
  </soap:Body>
</soap:Envelope>

Request specification

GetArticleItemsByQuery
UserName	str(50)	Req.	Your username.
Password	str(50)	Req.	Your password.
Query	object	Req.	A Query object

Query
Locations	str[]	Filter for article items in these locations
GoodsOwnerId	int	Filter for article items belonging to this goodsowner
ArticleItemId	int	Filter for this particular article item
ArticleDefId	int	Filter for this particular article
SpecialFilters	object	A SpecialFilters object

SpecialFilters
OnlyGetArticleItemsInLocationsToBeHandled	bool		Filter for article items which have been marked as "to be handled" by ArticleItemInLocationHandled

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>
    <GetArticleItemsByQueryResponse xmlns="http://ongoingsystems.se/Automation">
      <GetArticleItemsByQueryResult>
        <Success>boolean</Success>
        <Message>string</Message>
        <ArticleItems>
          <ArticleItemInfo>
            <Article>
              <ArticleName>string</ArticleName>
              <ArticleNumber>string</ArticleNumber>
              <ArticleDefId>int</ArticleDefId>
              <GoodsOwnerName>string</GoodsOwnerName>
              <GoodsOwnerId>int</GoodsOwnerId>
              <ArticleGroupCode>string</ArticleGroupCode>
              <ProductCode>string</ProductCode>
              <BarCode>string</BarCode>
            </Article>
            <Serial>string</Serial>
            <Batch>string</Batch>
            <NumberOfItems>decimal</NumberOfItems>
            <ArticleItemId>int</ArticleItemId>
            <ArticleItemInLocationId>int</ArticleItemInLocationId>
            <Location>string</Location>
            <OriginalArticleItemId>int</OriginalArticleItemId>
          </ArticleItemInfo>
          <ArticleItemInfo>
            <Article>
              <ArticleName>string</ArticleName>
              <ArticleNumber>string</ArticleNumber>
              <ArticleDefId>int</ArticleDefId>
              <GoodsOwnerName>string</GoodsOwnerName>
              <GoodsOwnerId>int</GoodsOwnerId>
              <ArticleGroupCode>string</ArticleGroupCode>
              <ProductCode>string</ProductCode>
              <BarCode>string</BarCode>
            </Article>
            <Serial>string</Serial>
            <Batch>string</Batch>
            <NumberOfItems>decimal</NumberOfItems>
            <ArticleItemId>int</ArticleItemId>
            <ArticleItemInLocationId>int</ArticleItemInLocationId>
            <Location>string</Location>
            <OriginalArticleItemId>int</OriginalArticleItemId>
          </ArticleItemInfo>
        </ArticleItems>
      </GetArticleItemsByQueryResult>
    </GetArticleItemsByQueryResponse>
  </soap:Body>
</soap:Envelope>

Response specification

GetArticleItemsByQueryResponse
GetArticleItemsByQueryResult	obj	A GetArticleItemsByQueryResult object

GetArticleItemsByQueryResult
Success	bool	True if the call succeeded, false otherwise
Message	str	If the call failed, this field contains the error message
ArticleItems	ArticleItemInfo[]	The article items which matched the filter, as a list of ArticleItemInfo objects

ArticleItemInfo
Article	object	An ArticleInfo object, containing information about the article definition
Serial	str(128)	The serial number of the article item
Batch	str(50)	The batch number of the article item
NumberOfItems	dec	The quantity
ArticleItemId	int	The internal system id of the article item
ArticleItemInLocationId	int	The internal id of the last move transaction of the article item id
Location	str(50)	Name of the current location where the article item is placed
OriginalArticleItemId	int	The original article item id of this item. If an article item has been created by splitting a previously existing article item, this field will tell you the id of the original article item.

ArticleInfo
ArticleName	str(200)	The article name
ArticleNumber	str(100)	The article number
ArticleDefId	int	The internal system id of the article
GoodsOwnerName	str(400)	The name of the goodsowner to which the article belongs
GoodsOwnerId	int	The internal system id of the goodsowner to which the article belongs
ArticleGroupCode	str(100)	The code of the group to which the article belongs
ProductCode	str(200)	Product code
BarCode	str(100)	The barcode/EAN of the article