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.
AuctionInsertModel| Name | 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": "243eff35-9e03-45d5-bbea-4b07b72b0911",
"BidParcelId": "sample string 1",
"Name": "sample string 2",
"Comments": "sample string 3",
"PickUpDate": "2024-04-26T00:27:54.0027573+00:00",
"DeliveryDate": "2024-04-26T00:27:54.0027573+00:00",
"Type": 1,
"Value": 6.0,
"ExpirationDate": "2024-04-26T00:27:54.0027573+00:00",
"SelectedParcels": [
"e3f1f391-51d9-437e-a2d6-f23e02c7fe4a",
"455083ec-037d-4462-8b1e-c93e4049a9e7"
]
}
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>2024-04-26T00:27:54.0027573+00:00</DeliveryDate>
<ExpirationDate>2024-04-26T00:27:54.0027573+00:00</ExpirationDate>
<Name>sample string 2</Name>
<ParentAuctionId>243eff35-9e03-45d5-bbea-4b07b72b0911</ParentAuctionId>
<PickUpDate>2024-04-26T00:27:54.0027573+00:00</PickUpDate>
<SelectedParcels xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>e3f1f391-51d9-437e-a2d6-f23e02c7fe4a</d2p1:guid>
<d2p1:guid>455083ec-037d-4462-8b1e-c93e4049a9e7</d2p1:guid>
</SelectedParcels>
<Type>Timed</Type>
<Value>6</Value>
</AuctionInsertModel>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ServiceResult| Name | 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>