POST api/Auction/ValidateParcelDelivery?authToken={authToken}
Validates if the parcel has been deliveried.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
authToken |
The authentication token. |
string |
Required |
Body Parameters
The model.
ParcelDeliveryValidationModelName | Description | Type | Additional information |
---|---|---|---|
AuctionParcelId | globally unique identifier |
None. |
|
ReceiverCode | integer |
None. |
|
ReceiverName | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "AuctionParcelId": "7738b7e5-8738-433b-9660-8ae54f6f6d6b", "ReceiverCode": 2, "ReceiverName": "sample string 3" }
application/xml, text/xml
Sample:
<ParcelDeliveryValidationModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOP.Apps.Web.Areas.Api.Models"> <AuctionParcelId>7738b7e5-8738-433b-9660-8ae54f6f6d6b</AuctionParcelId> <ReceiverCode>2</ReceiverCode> <ReceiverName>sample string 3</ReceiverName> </ParcelDeliveryValidationModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ServiceResultName | Description | Type | Additional information |
---|---|---|---|
ErrorCode | ServiceErrorCode |
None. |
|
ErrorMessage | Collection of string |
None. |
|
Success | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "ErrorCode": 0, "ErrorMessage": [ "sample string 1", "sample string 2" ], "Success": true }
application/xml, text/xml
Sample:
<ServiceResult 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> </ServiceResult>