GET api/Auction/Get?authToken={authToken}&auctionId={auctionId}
Get Auction info
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
authToken |
The Authentication Token |
string |
Required |
auctionId |
The Auction Id |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
ServiceResultOfAuctionDetailsModelName | Description | Type | Additional information |
---|---|---|---|
Result | AuctionDetailsModel |
None. |
|
ErrorCode | ServiceErrorCode |
None. |
|
ErrorMessage | Collection of string |
None. |
|
Success | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{ "Result": { "Id": "baff4497-4789-4436-aa62-fb2342fea93f", "State": 1, "Category": 1, "HasBids": true, "HasWinnerBeenChosen": true, "WinnerId": "4a39f53b-f934-4c63-a986-014598e3b103", "IsWinner": true, "CurrentValue": 5.0, "IsPaid": true, "AuctionParcels": [ { "Id": "75b1c3c3-c924-47f4-8199-cb2a342948c0", "AuctionId": "25813bd9-7e1f-4b49-9b04-fb704a66b269", "Name": "sample string 3", "NumberOfVolumes": 1, "CollectionAddress": "sample string 4", "CollectionZipCode": "sample string 5", "DestinationAddress": "sample string 6", "DestinationZipCode": "sample string 7", "Weight": 1.0, "AverageVolume": 1.0, "Comments": "sample string 8", "DestinationName": "sample string 9", "DestinationEmail": "sample string 10", "DestinationPhone": "sample string 11", "DeliveryStateId": 12, "CarrierName": "sample string 13", "CarrierAccountId": "acc6f5aa-a8c3-439c-aba9-29e7688e0eb3", "BidParcelId": "sample string 14", "PickUpDate": "2024-05-03T06:35:37.4913388+00:00", "DeliveryDate": "2024-05-03T06:35:37.4913388+00:00", "ActualPickUpDate": "2024-05-03T06:35:37.4913388+00:00", "ActualDeliveryDate": "2024-05-03T06:35:37.4913388+00:00" }, { "Id": "75b1c3c3-c924-47f4-8199-cb2a342948c0", "AuctionId": "25813bd9-7e1f-4b49-9b04-fb704a66b269", "Name": "sample string 3", "NumberOfVolumes": 1, "CollectionAddress": "sample string 4", "CollectionZipCode": "sample string 5", "DestinationAddress": "sample string 6", "DestinationZipCode": "sample string 7", "Weight": 1.0, "AverageVolume": 1.0, "Comments": "sample string 8", "DestinationName": "sample string 9", "DestinationEmail": "sample string 10", "DestinationPhone": "sample string 11", "DeliveryStateId": 12, "CarrierName": "sample string 13", "CarrierAccountId": "acc6f5aa-a8c3-439c-aba9-29e7688e0eb3", "BidParcelId": "sample string 14", "PickUpDate": "2024-05-03T06:35:37.4913388+00:00", "DeliveryDate": "2024-05-03T06:35:37.4913388+00:00", "ActualPickUpDate": "2024-05-03T06:35:37.4913388+00:00", "ActualDeliveryDate": "2024-05-03T06:35:37.4913388+00:00" } ], "ParentAuctionId": "8ca40c49-5f59-4983-b000-4735eaddbae3", "BidParcelId": "sample string 7", "Name": "sample string 8", "Comments": "sample string 9", "PickUpDate": "2024-05-03T06:35:37.4913388+00:00", "DeliveryDate": "2024-05-03T06:35:37.4913388+00:00", "Type": 1, "Value": 12.0, "ExpirationDate": "2024-05-03T06:35:37.4913388+00:00", "SelectedParcels": [ "0d0f9583-e455-4c19-abd9-0e553e40be83", "f2d4efd7-eb30-4a64-a12b-3223b527187e" ] }, "ErrorCode": 0, "ErrorMessage": [ "sample string 1", "sample string 2" ], "Success": true }
application/xml, text/xml
Sample:
<ServiceResultOfAuctionDetailsModelEJHQiVcc 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:BidParcelId>sample string 7</d2p1:BidParcelId> <d2p1:Comments>sample string 9</d2p1:Comments> <d2p1:DeliveryDate>2024-05-03T06:35:37.4913388+00:00</d2p1:DeliveryDate> <d2p1:ExpirationDate>2024-05-03T06:35:37.4913388+00:00</d2p1:ExpirationDate> <d2p1:Name>sample string 8</d2p1:Name> <d2p1:ParentAuctionId>8ca40c49-5f59-4983-b000-4735eaddbae3</d2p1:ParentAuctionId> <d2p1:PickUpDate>2024-05-03T06:35:37.4913388+00:00</d2p1:PickUpDate> <d2p1:SelectedParcels xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:guid>0d0f9583-e455-4c19-abd9-0e553e40be83</d3p1:guid> <d3p1:guid>f2d4efd7-eb30-4a64-a12b-3223b527187e</d3p1:guid> </d2p1:SelectedParcels> <d2p1:Type>Timed</d2p1:Type> <d2p1:Value>12</d2p1:Value> <d2p1:AuctionParcels> <d2p1:AuctionParcelListItemModel> <d2p1:ActualDeliveryDate>2024-05-03T06:35:37.4913388+00:00</d2p1:ActualDeliveryDate> <d2p1:ActualPickUpDate>2024-05-03T06:35:37.4913388+00:00</d2p1:ActualPickUpDate> <d2p1:AuctionId>25813bd9-7e1f-4b49-9b04-fb704a66b269</d2p1:AuctionId> <d2p1:AverageVolume>1</d2p1:AverageVolume> <d2p1:BidParcelId>sample string 14</d2p1:BidParcelId> <d2p1:CarrierAccountId>acc6f5aa-a8c3-439c-aba9-29e7688e0eb3</d2p1:CarrierAccountId> <d2p1:CarrierName>sample string 13</d2p1:CarrierName> <d2p1:CollectionAddress>sample string 4</d2p1:CollectionAddress> <d2p1:CollectionZipCode>sample string 5</d2p1:CollectionZipCode> <d2p1:Comments>sample string 8</d2p1:Comments> <d2p1:DeliveryDate>2024-05-03T06:35:37.4913388+00:00</d2p1:DeliveryDate> <d2p1:DeliveryStateId>12</d2p1:DeliveryStateId> <d2p1:DestinationAddress>sample string 6</d2p1:DestinationAddress> <d2p1:DestinationEmail>sample string 10</d2p1:DestinationEmail> <d2p1:DestinationName>sample string 9</d2p1:DestinationName> <d2p1:DestinationPhone>sample string 11</d2p1:DestinationPhone> <d2p1:DestinationZipCode>sample string 7</d2p1:DestinationZipCode> <d2p1:Id>75b1c3c3-c924-47f4-8199-cb2a342948c0</d2p1:Id> <d2p1:Name>sample string 3</d2p1:Name> <d2p1:NumberOfVolumes>1</d2p1:NumberOfVolumes> <d2p1:PickUpDate>2024-05-03T06:35:37.4913388+00:00</d2p1:PickUpDate> <d2p1:Weight>1</d2p1:Weight> </d2p1:AuctionParcelListItemModel> <d2p1:AuctionParcelListItemModel> <d2p1:ActualDeliveryDate>2024-05-03T06:35:37.4913388+00:00</d2p1:ActualDeliveryDate> <d2p1:ActualPickUpDate>2024-05-03T06:35:37.4913388+00:00</d2p1:ActualPickUpDate> <d2p1:AuctionId>25813bd9-7e1f-4b49-9b04-fb704a66b269</d2p1:AuctionId> <d2p1:AverageVolume>1</d2p1:AverageVolume> <d2p1:BidParcelId>sample string 14</d2p1:BidParcelId> <d2p1:CarrierAccountId>acc6f5aa-a8c3-439c-aba9-29e7688e0eb3</d2p1:CarrierAccountId> <d2p1:CarrierName>sample string 13</d2p1:CarrierName> <d2p1:CollectionAddress>sample string 4</d2p1:CollectionAddress> <d2p1:CollectionZipCode>sample string 5</d2p1:CollectionZipCode> <d2p1:Comments>sample string 8</d2p1:Comments> <d2p1:DeliveryDate>2024-05-03T06:35:37.4913388+00:00</d2p1:DeliveryDate> <d2p1:DeliveryStateId>12</d2p1:DeliveryStateId> <d2p1:DestinationAddress>sample string 6</d2p1:DestinationAddress> <d2p1:DestinationEmail>sample string 10</d2p1:DestinationEmail> <d2p1:DestinationName>sample string 9</d2p1:DestinationName> <d2p1:DestinationPhone>sample string 11</d2p1:DestinationPhone> <d2p1:DestinationZipCode>sample string 7</d2p1:DestinationZipCode> <d2p1:Id>75b1c3c3-c924-47f4-8199-cb2a342948c0</d2p1:Id> <d2p1:Name>sample string 3</d2p1:Name> <d2p1:NumberOfVolumes>1</d2p1:NumberOfVolumes> <d2p1:PickUpDate>2024-05-03T06:35:37.4913388+00:00</d2p1:PickUpDate> <d2p1:Weight>1</d2p1:Weight> </d2p1:AuctionParcelListItemModel> </d2p1:AuctionParcels> <d2p1:Category>Normal</d2p1:Category> <d2p1:CurrentValue>5</d2p1:CurrentValue> <d2p1:HasBids>true</d2p1:HasBids> <d2p1:HasWinnerBeenChosen>true</d2p1:HasWinnerBeenChosen> <d2p1:Id>baff4497-4789-4436-aa62-fb2342fea93f</d2p1:Id> <d2p1:IsPaid>true</d2p1:IsPaid> <d2p1:IsWinner>true</d2p1:IsWinner> <d2p1:State>Pending</d2p1:State> <d2p1:WinnerId>4a39f53b-f934-4c63-a986-014598e3b103</d2p1:WinnerId> </Result> </ServiceResultOfAuctionDetailsModelEJHQiVcc>