POST api/Mobile/RemoveItemFromConsolidation
Use this method to remove an item (piece or shipment) from a consolidation
Request Information
URI Parameters
None.
Body Parameters
ConsolidationParmName | Description | Type | Additional information |
---|---|---|---|
auth |
Authentication identifier |
string |
None. |
ConsolidationID |
The consolidation ID |
string |
None. |
ItemID |
List of ItemID's to add to or remove from consolidation |
Collection of string |
None. |
Request Formats
application/json, text/json
Sample:
{ "auth": "sample string 1", "ConsolidationID": "sample string 2", "ItemID": [ "sample string 1", "sample string 2" ] }
application/xml, text/xml
Sample:
<ConsolidationParm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models.Mobile"> <ConsolidationID>sample string 2</ConsolidationID> <ItemID xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:string>sample string 1</d2p1:string> <d2p1:string>sample string 2</d2p1:string> </ItemID> <auth>sample string 1</auth> </ConsolidationParm>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ResponseBaseName | Description | Type | Additional information |
---|---|---|---|
IsSuccessful |
Set to true if method was successful |
boolean |
None. |
ErrorMessage |
The error message if method call was not successful |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "IsSuccessful": true, "ErrorMessage": "sample string 2" }
application/xml, text/xml
Sample:
<ResponseBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Mnx.WebApi.Transportation.Models"> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> </ResponseBase>