POST api/Auction/ValidatePackagePickUp?authToken={authToken}
Validates the Package Pickup
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
authToken |
The Authentication Token |
string |
Required |
Body Parameters
PackageValidationModelName | Description | Type | Additional information |
---|---|---|---|
AuctionParcelId | globally unique identifier |
None. |
|
CarrierCode | integer |
None. |
Request Formats
application/json, text/json
Sample:
{ "AuctionParcelId": "7826e473-b385-4eb8-a05f-cbc2896f7169", "CarrierCode": 2 }
application/xml, text/xml
Sample:
<PackageValidationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOP.Apps.Web.Areas.Api.Models"> <AuctionParcelId>7826e473-b385-4eb8-a05f-cbc2896f7169</AuctionParcelId> <CarrierCode>2</CarrierCode> </PackageValidationModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ServiceResultOfPackageValidationResultModelName | Description | Type | Additional information |
---|---|---|---|
Result | PackageValidationResultModel |
None. |
|
ErrorCode | ServiceErrorCode |
None. |
|
ErrorMessage | Collection of string |
None. |
|
Success | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "Result": { "AuctionId": "ddc04d0a-c0a8-4a55-a0f1-5a0b3e1a6827", "AuctionBidParcelId": "sample string 2", "ParcelId": "fede0bc2-27c9-4c56-8975-a724b3353e8a", "ParcelName": "sample string 4", "VolumesReadCount": 5, "TotalVolumes": 6 }, "ErrorCode": 0, "ErrorMessage": [ "sample string 1", "sample string 2" ], "Success": true }
application/xml, text/xml
Sample:
<ServiceResultOfPackageValidationResultModelEJHQiVcc 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:AuctionBidParcelId>sample string 2</d2p1:AuctionBidParcelId> <d2p1:AuctionId>ddc04d0a-c0a8-4a55-a0f1-5a0b3e1a6827</d2p1:AuctionId> <d2p1:ParcelId>fede0bc2-27c9-4c56-8975-a724b3353e8a</d2p1:ParcelId> <d2p1:ParcelName>sample string 4</d2p1:ParcelName> <d2p1:TotalVolumes>6</d2p1:TotalVolumes> <d2p1:VolumesReadCount>5</d2p1:VolumesReadCount> </Result> </ServiceResultOfPackageValidationResultModelEJHQiVcc>