GetMovementPalletItemsByQuery
Returns all movement pallet items that match a particular query.
Tags: GetMovementPalletItemsByQuery, GetMovementPalletItemsQuery, MovementPalletItemsSpecialFilters, MovementPalletItemsPaging, GetMovementPalletItemsByQueryResponse, GetMovementPalletItemsResult, MovementPalletItemInfo, MovementPalletItemTypeInfo, PalletItemInfo_GetMovementPalletItems, WorkOrderInfo_GetMovementPalletItems, LocationInfo_GetMovementPalletItems, GoodsOwnerInfo_GetMovementPalletItems, PalletTypeInfo_GetMovementPalletItems
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/GetMovementPalletItemsByQuery"
<?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>
<GetMovementPalletItemsByQuery xmlns="http://ongoingsystems.se/Automation">
<UserName>string</UserName>
<Password>string</Password>
<Query>
<FromLocations>
<string>string</string>
<string>string</string>
</FromLocations>
<CurrentLocations>
<string>string</string>
<string>string</string>
</CurrentLocations>
<ToLocations>
<string>string</string>
<string>string</string>
</ToLocations>
<WorkOrderId>int</WorkOrderId>
<PalletItemId>int</PalletItemId>
<GoodsOwnerId>int</GoodsOwnerId>
<SpecialFilters>
<OnlyGetMovementPalletItemsToBeHandled>boolean</OnlyGetMovementPalletItemsToBeHandled>
</SpecialFilters>
<Paging>
<MaxRowsToGet>int</MaxRowsToGet>
<MaxWorkOrdersToGet>int</MaxWorkOrdersToGet>
</Paging>
<GoodsOwnerEnvironment>All or Production or Training</GoodsOwnerEnvironment>
</Query>
</GetMovementPalletItemsByQuery>
</soap:Body>
</soap:Envelope>
Request specification
| GetMovementPalletItemsByQuery |
| UserName |
string(50) |
Req. |
Your username |
| Password |
string(50) |
Req. |
Your password |
| Query |
GetMovementPalletItemsQuery |
Req. |
The query object |
| GetMovementPalletItemsQuery |
| FromLocations |
string[] |
|
Filter for movement pallet items being moved from these locations |
| CurrentLocations |
string[] |
|
Filter for movement pallet items that are currently at these locations |
| ToLocations |
string[] |
|
Filter for movement pallet items being moved to these locations |
| WorkOrderId |
int |
|
Filter for movement pallet items belonging to this work order id |
| PalletItemId |
int |
|
Filter for movement pallet items for this Pallet item |
| GoodsOwnerId |
int |
|
Filter for movement pallet items for this goodsowner |
| SpecialFilters |
MovementPalletItemsSpecialFilters |
|
A SpecialFilters object |
| Paging |
MovementPalletItemsPaging |
|
A Paging object |
| GoodsOwnerEnvironment |
enum |
|
Filter for which type of goods owner environment you want to fetch movement Pallet items, only production, only training, or all: - All - Production - Training
|
| MovementPalletItemsSpecialFilters |
| OnlyGetMovementPalletItemsToBeHandled |
boolean |
|
Filter for Pallet items which have been marked as "to be handled" by MovementPalletItemHandled |
| MovementPalletItemsPaging |
| MaxRowsToGet |
int |
|
Max number of Pallet items to return in response. Note: Filter may not be used in conjunction with MaxWorkOrdersToGet |
| MaxWorkOrdersToGet |
int |
|
Max number of work orders to return in response. Note: Filter may not be used in conjunction with MaxRowsToGet |
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>
<GetMovementPalletItemsByQueryResponse xmlns="http://ongoingsystems.se/Automation">
<GetMovementPalletItemsByQueryResult>
<Success>boolean</Success>
<Message>string</Message>
<MovementPalletItems>
<MovementPalletItemInfo>
<MovementPalletItemId>int</MovementPalletItemId>
<MovementPalletItemPriority>int</MovementPalletItemPriority>
<MovementPalletItemType>
<Code>string</Code>
<Name>string</Name>
</MovementPalletItemType>
<PalletItem>
<Id>int</Id>
<LabelId>string</LabelId>
<Serial>string</Serial>
<PalletType>
<Code>string</Code>
<Name>string</Name>
</PalletType>
</PalletItem>
<WorkOrder>
<Id>int</Id>
<Comment>string</Comment>
</WorkOrder>
<FromLocation>
<Name>string</Name>
</FromLocation>
<CurrentLocation>
<Name>string</Name>
</CurrentLocation>
<ToLocation>
<Name>string</Name>
</ToLocation>
<GoodsOwner>
<Id>int</Id>
<Name>string</Name>
</GoodsOwner>
</MovementPalletItemInfo>
<MovementPalletItemInfo>
<MovementPalletItemId>int</MovementPalletItemId>
<MovementPalletItemPriority>int</MovementPalletItemPriority>
<MovementPalletItemType>
<Code>string</Code>
<Name>string</Name>
</MovementPalletItemType>
<PalletItem>
<Id>int</Id>
<LabelId>string</LabelId>
<Serial>string</Serial>
<PalletType>
<Code>string</Code>
<Name>string</Name>
</PalletType>
</PalletItem>
<WorkOrder>
<Id>int</Id>
<Comment>string</Comment>
</WorkOrder>
<FromLocation>
<Name>string</Name>
</FromLocation>
<CurrentLocation>
<Name>string</Name>
</CurrentLocation>
<ToLocation>
<Name>string</Name>
</ToLocation>
<GoodsOwner>
<Id>int</Id>
<Name>string</Name>
</GoodsOwner>
</MovementPalletItemInfo>
</MovementPalletItems>
</GetMovementPalletItemsByQueryResult>
</GetMovementPalletItemsByQueryResponse>
</soap:Body>
</soap:Envelope>
Response specification
| GetMovementPalletItemsByQueryResponse |
| GetMovementPalletItemsByQueryResult |
GetMovementPalletItemsResult |
|
| GetMovementPalletItemsResult |
| Success |
boolean |
True if the call succeeded, false otherwise |
| Message |
string |
If the call failed, this field contains the error message |
| MovementPalletItems |
MovementPalletItemInfo[] |
The movement pallet items that matched the filter, as a list of MovementPalletItemInfo objects |
| MovementPalletItemInfo |
| MovementPalletItemId |
int |
The internal system id of the movement pallet item |
| MovementPalletItemPriority |
int |
The priority of the movement pallet item |
| MovementPalletItemType |
MovementPalletItemTypeInfo |
An MovementPalletItemTypeInfo object, containing information about the type of the movement pallet item |
| PalletItem |
PalletItemInfo_GetMovementPalletItems |
An PalletItemInfo_GetMovementPalletItems object, containing information about the pallet item |
| WorkOrder |
WorkOrderInfo_GetMovementPalletItems |
An WorkOrderInfo_GetMovementPalletItems object, containing information about the work order |
| FromLocation |
LocationInfo_GetMovementPalletItems |
An LocationInfo_GetMovementPalletItems object, containing information about the location where the pallet item is being moved from. Can be NULL! |
| CurrentLocation |
LocationInfo_GetMovementPalletItems |
An LocationInfo_GetMovementPalletItems object, containing information about the location where the pallet item is currently located. Can be NULL! |
| ToLocation |
LocationInfo_GetMovementPalletItems |
An LocationInfo_GetMovementPalletItems object, containing information about the location where the pallet item is being moved to. Can be NULL! |
| GoodsOwner |
GoodsOwnerInfo_GetMovementPalletItems |
Info about the Goods Owner. Can be NULL! |
| MovementPalletItemTypeInfo |
| Code |
string(50) |
Code of the movement pallet item type |
| Name |
string(50) |
Name of the movement pallet item type |
| PalletItemInfo_GetMovementPalletItems |
| Id |
int |
Ongoing WMS internal id of the pallet item |
| LabelId |
string(50) |
Label of the pallet item |
| Serial |
string(100) |
Serial number of the pallet item |
| PalletType |
PalletTypeInfo_GetMovementPalletItems |
An PalletTypeInfo_GetMovementPalletItems object, containing information about the pallet type of the pallet item |
| WorkOrderInfo_GetMovementPalletItems |
| Id |
int |
Ongoing WMS internal id of the work order |
| Comment |
string(200) |
The work order comment |
| LocationInfo_GetMovementPalletItems |
| Name |
string(50) |
The name of the location |
| GoodsOwnerInfo_GetMovementPalletItems |
| Id |
int |
Ongoing WMS internal id of the goods owner |
| Name |
string(400) |
The name (code) of the goods owner |
| PalletTypeInfo_GetMovementPalletItems |
| Code |
string(50) |
Code of the pallet type |
| Name |
string(100) |
Name of the pallet type |