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

PackageValidationModel

Name	Description	Type	Additional information
AuctionParcelId		globally unique identifier	None.
CarrierCode		integer	None.

Request Formats

application/json, text/json

Sample:

{
  "AuctionParcelId": "228389e0-9d95-4ebe-818d-a9bebbd48c82",
  "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>228389e0-9d95-4ebe-818d-a9bebbd48c82</AuctionParcelId>
  <CarrierCode>2</CarrierCode>
</PackageValidationModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ServiceResultOfPackageValidationResultModel

Name	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": "04ea6456-2f19-41c7-9a57-0312fe184658",
    "AuctionBidParcelId": "sample string 2",
    "ParcelId": "aea9ce06-41ad-46b2-bc0a-79e069e97080",
    "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>04ea6456-2f19-41c7-9a57-0312fe184658</d2p1:AuctionId>
    <d2p1:ParcelId>aea9ce06-41ad-46b2-bc0a-79e069e97080</d2p1:ParcelId>
    <d2p1:ParcelName>sample string 4</d2p1:ParcelName>
    <d2p1:TotalVolumes>6</d2p1:TotalVolumes>
    <d2p1:VolumesReadCount>5</d2p1:VolumesReadCount>
  </Result>
</ServiceResultOfPackageValidationResultModelEJHQiVcc>