GET api/BagPiece/{auth}/{BagGUID}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| auth | string |
Required |
|
| BagGUID | string |
Required |
Body Parameters
None.
Response Information
Resource Description
BagPieceResp| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccessful | boolean |
None. |
|
| ErrorMessage | string |
None. |
|
| Pieces | Collection of BagPieceItem |
None. |
Response Formats
application/json, text/json
Sample:
{
"IsSuccessful": true,
"ErrorMessage": "sample string 2",
"Pieces": [
{
"BagPieceID": 1,
"BagGUID": "sample string 2",
"ShipmentPieceID": 3,
"ShipmentNumber": 4,
"Contents": "sample string 5",
"Reference": "sample string 6",
"Weight": 1.0,
"DimWeight": 1.0,
"WeightUOM": "sample string 7",
"WeightDescription": "sample string 8",
"Length": 1,
"Width": 1,
"Height": 1,
"SizeUOM": "sample string 9",
"PackagingType": "sample string 10",
"DeclaredValue": 1.0,
"DeclaredValueCurrencyID": "sample string 11"
},
{
"BagPieceID": 1,
"BagGUID": "sample string 2",
"ShipmentPieceID": 3,
"ShipmentNumber": 4,
"Contents": "sample string 5",
"Reference": "sample string 6",
"Weight": 1.0,
"DimWeight": 1.0,
"WeightUOM": "sample string 7",
"WeightDescription": "sample string 8",
"Length": 1,
"Width": 1,
"Height": 1,
"SizeUOM": "sample string 9",
"PackagingType": "sample string 10",
"DeclaredValue": 1.0,
"DeclaredValueCurrencyID": "sample string 11"
}
]
}
application/xml, text/xml
Sample:
<BagPieceResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models">
<ErrorMessage>sample string 2</ErrorMessage>
<IsSuccessful>true</IsSuccessful>
<Pieces>
<BagPieceItem>
<BagGUID>sample string 2</BagGUID>
<BagPieceID>1</BagPieceID>
<Contents>sample string 5</Contents>
<DeclaredValue>1</DeclaredValue>
<DeclaredValueCurrencyID>sample string 11</DeclaredValueCurrencyID>
<DimWeight>1</DimWeight>
<Height>1</Height>
<Length>1</Length>
<PackagingType>sample string 10</PackagingType>
<Reference>sample string 6</Reference>
<ShipmentNumber>4</ShipmentNumber>
<ShipmentPieceID>3</ShipmentPieceID>
<SizeUOM>sample string 9</SizeUOM>
<Weight>1</Weight>
<WeightDescription>sample string 8</WeightDescription>
<WeightUOM>sample string 7</WeightUOM>
<Width>1</Width>
</BagPieceItem>
<BagPieceItem>
<BagGUID>sample string 2</BagGUID>
<BagPieceID>1</BagPieceID>
<Contents>sample string 5</Contents>
<DeclaredValue>1</DeclaredValue>
<DeclaredValueCurrencyID>sample string 11</DeclaredValueCurrencyID>
<DimWeight>1</DimWeight>
<Height>1</Height>
<Length>1</Length>
<PackagingType>sample string 10</PackagingType>
<Reference>sample string 6</Reference>
<ShipmentNumber>4</ShipmentNumber>
<ShipmentPieceID>3</ShipmentPieceID>
<SizeUOM>sample string 9</SizeUOM>
<Weight>1</Weight>
<WeightDescription>sample string 8</WeightDescription>
<WeightUOM>sample string 7</WeightUOM>
<Width>1</Width>
</BagPieceItem>
</Pieces>
</BagPieceResp>