GET api/Auction/Get?authToken={authToken}&auctionId={auctionId}

Get Auction info

Request Information

URI Parameters

NameDescriptionTypeAdditional information
authToken

The Authentication Token

 string

Required
auctionId

The Auction Id

 globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

ServiceResultOfAuctionDetailsModel
NameDescriptionTypeAdditional information
Result

AuctionDetailsModel

None.
ErrorCode

ServiceErrorCode

None.
ErrorMessage

Collection of string

None.
Success

boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "Result": {
    "Id": "07e8292d-446a-4ebb-9083-eb43dacdab2c",
    "State": 1,
    "Category": 1,
    "HasBids": true,
    "HasWinnerBeenChosen": true,
    "WinnerId": "5c54e44b-02c5-464f-a414-493802ab5ece",
    "IsWinner": true,
    "CurrentValue": 5.0,
    "IsPaid": true,
    "AuctionParcels": [
      {
        "Id": "217e8513-ee9f-438b-af40-509cc0eaee6e",
        "AuctionId": "15be9bf2-db1c-4833-8f7d-affb595463dd",
        "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": "7db7882a-2dd3-428b-a99d-2c70c03635b2",
        "BidParcelId": "sample string 14",
        "PickUpDate": "2024-11-05T14:17:32.7797072+00:00",
        "DeliveryDate": "2024-11-05T14:17:32.7797072+00:00",
        "ActualPickUpDate": "2024-11-05T14:17:32.7797072+00:00",
        "ActualDeliveryDate": "2024-11-05T14:17:32.7797072+00:00"
      },
      {
        "Id": "217e8513-ee9f-438b-af40-509cc0eaee6e",
        "AuctionId": "15be9bf2-db1c-4833-8f7d-affb595463dd",
        "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": "7db7882a-2dd3-428b-a99d-2c70c03635b2",
        "BidParcelId": "sample string 14",
        "PickUpDate": "2024-11-05T14:17:32.7797072+00:00",
        "DeliveryDate": "2024-11-05T14:17:32.7797072+00:00",
        "ActualPickUpDate": "2024-11-05T14:17:32.7797072+00:00",
        "ActualDeliveryDate": "2024-11-05T14:17:32.7797072+00:00"
      }
    ],
    "ParentAuctionId": "471348a7-89f4-496c-a019-83c5f93c3a18",
    "BidParcelId": "sample string 7",
    "Name": "sample string 8",
    "Comments": "sample string 9",
    "PickUpDate": "2024-11-05T14:17:32.7797072+00:00",
    "DeliveryDate": "2024-11-05T14:17:32.7797072+00:00",
    "Type": 1,
    "Value": 12.0,
    "ExpirationDate": "2024-11-05T14:17:32.7797072+00:00",
    "SelectedParcels": [
      "6a6962f8-5bb4-48a2-8477-7faf17637da8",
      "bae1ef82-01e9-4e5f-9ab9-2ad23ce6cb1a"
    ]
  },
  "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-11-05T14:17:32.7797072+00:00</d2p1:DeliveryDate>
    <d2p1:ExpirationDate>2024-11-05T14:17:32.7797072+00:00</d2p1:ExpirationDate>
    <d2p1:Name>sample string 8</d2p1:Name>
    <d2p1:ParentAuctionId>471348a7-89f4-496c-a019-83c5f93c3a18</d2p1:ParentAuctionId>
    <d2p1:PickUpDate>2024-11-05T14:17:32.7797072+00:00</d2p1:PickUpDate>
    <d2p1:SelectedParcels xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>6a6962f8-5bb4-48a2-8477-7faf17637da8</d3p1:guid>
      <d3p1:guid>bae1ef82-01e9-4e5f-9ab9-2ad23ce6cb1a</d3p1:guid>
    </d2p1:SelectedParcels>
    <d2p1:Type>Timed</d2p1:Type>
    <d2p1:Value>12</d2p1:Value>
    <d2p1:AuctionParcels>
      <d2p1:AuctionParcelListItemModel>
        <d2p1:ActualDeliveryDate>2024-11-05T14:17:32.7797072+00:00</d2p1:ActualDeliveryDate>
        <d2p1:ActualPickUpDate>2024-11-05T14:17:32.7797072+00:00</d2p1:ActualPickUpDate>
        <d2p1:AuctionId>15be9bf2-db1c-4833-8f7d-affb595463dd</d2p1:AuctionId>
        <d2p1:AverageVolume>1</d2p1:AverageVolume>
        <d2p1:BidParcelId>sample string 14</d2p1:BidParcelId>
        <d2p1:CarrierAccountId>7db7882a-2dd3-428b-a99d-2c70c03635b2</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-11-05T14:17:32.7797072+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>217e8513-ee9f-438b-af40-509cc0eaee6e</d2p1:Id>
        <d2p1:Name>sample string 3</d2p1:Name>
        <d2p1:NumberOfVolumes>1</d2p1:NumberOfVolumes>
        <d2p1:PickUpDate>2024-11-05T14:17:32.7797072+00:00</d2p1:PickUpDate>
        <d2p1:Weight>1</d2p1:Weight>
      </d2p1:AuctionParcelListItemModel>
      <d2p1:AuctionParcelListItemModel>
        <d2p1:ActualDeliveryDate>2024-11-05T14:17:32.7797072+00:00</d2p1:ActualDeliveryDate>
        <d2p1:ActualPickUpDate>2024-11-05T14:17:32.7797072+00:00</d2p1:ActualPickUpDate>
        <d2p1:AuctionId>15be9bf2-db1c-4833-8f7d-affb595463dd</d2p1:AuctionId>
        <d2p1:AverageVolume>1</d2p1:AverageVolume>
        <d2p1:BidParcelId>sample string 14</d2p1:BidParcelId>
        <d2p1:CarrierAccountId>7db7882a-2dd3-428b-a99d-2c70c03635b2</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-11-05T14:17:32.7797072+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>217e8513-ee9f-438b-af40-509cc0eaee6e</d2p1:Id>
        <d2p1:Name>sample string 3</d2p1:Name>
        <d2p1:NumberOfVolumes>1</d2p1:NumberOfVolumes>
        <d2p1:PickUpDate>2024-11-05T14:17:32.7797072+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>07e8292d-446a-4ebb-9083-eb43dacdab2c</d2p1:Id>
    <d2p1:IsPaid>true</d2p1:IsPaid>
    <d2p1:IsWinner>true</d2p1:IsWinner>
    <d2p1:State>Pending</d2p1:State>
    <d2p1:WinnerId>5c54e44b-02c5-464f-a414-493802ab5ece</d2p1:WinnerId>
  </Result>
</ServiceResultOfAuctionDetailsModelEJHQiVcc>