GET api/Auction/GetParcelInformation?authToken={authToken}&code={code}
Gets Parcel Information by Package QrCode
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| authToken |
The Authentication Token |
string |
Required |
| code |
The QrCode |
string |
Required |
Body Parameters
None.
Response Information
Resource Description
ServiceResultOfAuctionParcelPickupModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Result | AuctionParcelPickupModel |
None. |
|
| ErrorCode | ServiceErrorCode |
None. |
|
| ErrorMessage | Collection of string |
None. |
|
| Success | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"Result": {
"AuctionParcelId": "c619cb16-24e4-400c-90c6-e9b204109753",
"AuctionId": "771a9738-57f0-42f2-9015-eda2ef93a70e",
"BidParcelId": "sample string 3",
"ParcelName": "sample string 4",
"Packages": [
{
"Id": "b3df33e8-6c52-4033-aa54-4d521ffea28b",
"BidParcelId": "sample string 2",
"Name": "sample string 3",
"Weight": 4.0,
"Height": 5.0,
"Width": 6.0,
"Length": 7.0,
"QrCode": "sample string 8",
"ExternalCode": 1,
"ExternalOperatorId": "e9f71189-bb8f-4c55-ad33-b888cdb3073c"
},
{
"Id": "b3df33e8-6c52-4033-aa54-4d521ffea28b",
"BidParcelId": "sample string 2",
"Name": "sample string 3",
"Weight": 4.0,
"Height": 5.0,
"Width": 6.0,
"Length": 7.0,
"QrCode": "sample string 8",
"ExternalCode": 1,
"ExternalOperatorId": "e9f71189-bb8f-4c55-ad33-b888cdb3073c"
}
]
},
"ErrorCode": 0,
"ErrorMessage": [
"sample string 1",
"sample string 2"
],
"Success": true
}
application/xml, text/xml
Sample:
<ServiceResultOfAuctionParcelPickupModelEJHQiVcc xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOP.Common.Infrastructure.ApiObjects.Results">
<ErrorCode>None</ErrorCode>
<ErrorMessage xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</ErrorMessage>
<Success>true</Success>
<Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/BOP.Apps.Web.Areas.Api.Models">
<d2p1:AuctionId>771a9738-57f0-42f2-9015-eda2ef93a70e</d2p1:AuctionId>
<d2p1:AuctionParcelId>c619cb16-24e4-400c-90c6-e9b204109753</d2p1:AuctionParcelId>
<d2p1:BidParcelId>sample string 3</d2p1:BidParcelId>
<d2p1:Packages>
<d2p1:AuctionPackagePickupItemModel>
<d2p1:BidParcelId>sample string 2</d2p1:BidParcelId>
<d2p1:ExternalCode>1</d2p1:ExternalCode>
<d2p1:ExternalOperatorId>e9f71189-bb8f-4c55-ad33-b888cdb3073c</d2p1:ExternalOperatorId>
<d2p1:Height>5</d2p1:Height>
<d2p1:Id>b3df33e8-6c52-4033-aa54-4d521ffea28b</d2p1:Id>
<d2p1:Length>7</d2p1:Length>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:QrCode>sample string 8</d2p1:QrCode>
<d2p1:Weight>4</d2p1:Weight>
<d2p1:Width>6</d2p1:Width>
</d2p1:AuctionPackagePickupItemModel>
<d2p1:AuctionPackagePickupItemModel>
<d2p1:BidParcelId>sample string 2</d2p1:BidParcelId>
<d2p1:ExternalCode>1</d2p1:ExternalCode>
<d2p1:ExternalOperatorId>e9f71189-bb8f-4c55-ad33-b888cdb3073c</d2p1:ExternalOperatorId>
<d2p1:Height>5</d2p1:Height>
<d2p1:Id>b3df33e8-6c52-4033-aa54-4d521ffea28b</d2p1:Id>
<d2p1:Length>7</d2p1:Length>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:QrCode>sample string 8</d2p1:QrCode>
<d2p1:Weight>4</d2p1:Weight>
<d2p1:Width>6</d2p1:Width>
</d2p1:AuctionPackagePickupItemModel>
</d2p1:Packages>
<d2p1:ParcelName>sample string 4</d2p1:ParcelName>
</Result>
</ServiceResultOfAuctionParcelPickupModelEJHQiVcc>