POST api/Auction/Create?authToken={authToken}
Creates an Auction.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
authToken |
The authentication token. |
string |
Required |
Body Parameters
The model.
AuctionInsertModelName | Description | Type | Additional information |
---|---|---|---|
ParentAuctionId | globally unique identifier |
None. |
|
BidParcelId | string |
Max length: 128 |
|
Name | string |
Required Max length: 256 |
|
Comments | string |
None. |
|
PickUpDate | date |
Required |
|
DeliveryDate | date |
Required |
|
Type | AuctionType |
Required |
|
Value | decimal number |
Required |
|
ExpirationDate | date |
Required |
|
SelectedParcels | Collection of globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{ "ParentAuctionId": "f341857d-427a-4c02-be10-b11b627aac7c", "BidParcelId": "sample string 1", "Name": "sample string 2", "Comments": "sample string 3", "PickUpDate": "2025-04-25T00:46:15.1535897+00:00", "DeliveryDate": "2025-04-25T00:46:15.1535897+00:00", "Type": 1, "Value": 6.0, "ExpirationDate": "2025-04-25T00:46:15.1535897+00:00", "SelectedParcels": [ "debf12ed-beb2-4db4-8184-0c480df8669b", "ad80e967-a5a4-42a7-8a25-f917a151a172" ] }
application/xml, text/xml
Sample:
<AuctionInsertModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOP.Apps.Web.Areas.Api.Models"> <BidParcelId>sample string 1</BidParcelId> <Comments>sample string 3</Comments> <DeliveryDate>2025-04-25T00:46:15.1535897+00:00</DeliveryDate> <ExpirationDate>2025-04-25T00:46:15.1535897+00:00</ExpirationDate> <Name>sample string 2</Name> <ParentAuctionId>f341857d-427a-4c02-be10-b11b627aac7c</ParentAuctionId> <PickUpDate>2025-04-25T00:46:15.1535897+00:00</PickUpDate> <SelectedParcels xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>debf12ed-beb2-4db4-8184-0c480df8669b</d2p1:guid> <d2p1:guid>ad80e967-a5a4-42a7-8a25-f917a151a172</d2p1:guid> </SelectedParcels> <Type>Timed</Type> <Value>6</Value> </AuctionInsertModel>
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>