POST api/Bag/Create
Request Information
URI Parameters
None.
Body Parameters
BagCreateParms| Name | Description | Type | Additional information |
|---|---|---|---|
| auth | string |
None. |
|
| BagIdentifier | string |
None. |
|
| ManifestGUID | string |
None. |
|
| BagTypeID | integer |
None. |
|
| PackagingType | string |
None. |
|
| Weight | decimal number |
None. |
|
| DimWeight | decimal number |
None. |
|
| WeightUOM | string |
None. |
|
| Length | integer |
None. |
|
| Width | integer |
None. |
|
| Height | integer |
None. |
|
| SizeUOM | string |
None. |
|
| Count | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"auth": "sample string 1",
"BagIdentifier": "sample string 2",
"ManifestGUID": "sample string 3",
"BagTypeID": 4,
"PackagingType": "sample string 5",
"Weight": 6.0,
"DimWeight": 1.0,
"WeightUOM": "sample string 7",
"Length": 1,
"Width": 1,
"Height": 1,
"SizeUOM": "sample string 8",
"Count": 9
}
application/xml, text/xml
Sample:
<BagCreateParms xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <BagIdentifier>sample string 2</BagIdentifier> <BagTypeID>4</BagTypeID> <Count>9</Count> <DimWeight>1</DimWeight> <Height>1</Height> <Length>1</Length> <ManifestGUID>sample string 3</ManifestGUID> <PackagingType>sample string 5</PackagingType> <SizeUOM>sample string 8</SizeUOM> <Weight>6</Weight> <WeightUOM>sample string 7</WeightUOM> <Width>1</Width> <auth>sample string 1</auth> </BagCreateParms>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
BagCreateResp| Name | Description | Type | Additional information |
|---|---|---|---|
| IsSuccessful | boolean |
None. |
|
| ErrorMessage | string |
None. |
|
| BagGUID | string |
None. |
|
| BagNumber | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"IsSuccessful": true,
"ErrorMessage": "sample string 2",
"BagGUID": "sample string 3",
"BagNumber": 4
}
application/xml, text/xml
Sample:
<BagCreateResp xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ParcelLogic.WebApi.Transportation.Models"> <BagGUID>sample string 3</BagGUID> <BagNumber>4</BagNumber> <ErrorMessage>sample string 2</ErrorMessage> <IsSuccessful>true</IsSuccessful> </BagCreateResp>