POST api/Auction/Find?authToken={authToken}

Find All Auctions

Request Information

URI Parameters

NameDescriptionTypeAdditional information
authToken

The Authentication Token

string

Required

Body Parameters

The Filters

PagedRequest
NameDescriptionTypeAdditional information
Page

integer

None.

PageSize

integer

None.

SortField

string

None.

SortOrder

string

None.

Filters

Collection of FilterModel

None.

Request Formats

application/json, text/json

Sample:
{
  "Page": 1,
  "PageSize": 2,
  "SortField": "sample string 3",
  "SortOrder": "sample string 4",
  "Filters": [
    {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "Operator": 1,
      "RelatedField": "sample string 4",
      "RadioId": "sample string 5",
      "RenderValue": "sample string 6"
    },
    {
      "Id": "sample string 1",
      "Name": "sample string 2",
      "Value": "sample string 3",
      "Operator": 1,
      "RelatedField": "sample string 4",
      "RadioId": "sample string 5",
      "RenderValue": "sample string 6"
    }
  ]
}

application/xml, text/xml

Sample:
<PagedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOP.Common.Infrastructure.Filters">
  <FilterCondition>And</FilterCondition>
  <Filters>
    <FilterModel>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
      <Operator>Equal</Operator>
      <RadioId>sample string 5</RadioId>
      <RelatedField>sample string 4</RelatedField>
      <RenderValue>sample string 6</RenderValue>
      <Value>sample string 3</Value>
    </FilterModel>
    <FilterModel>
      <Id>sample string 1</Id>
      <Name>sample string 2</Name>
      <Operator>Equal</Operator>
      <RadioId>sample string 5</RadioId>
      <RelatedField>sample string 4</RelatedField>
      <RenderValue>sample string 6</RenderValue>
      <Value>sample string 3</Value>
    </FilterModel>
  </Filters>
  <Page>1</Page>
  <PageSize>2</PageSize>
  <SortField>sample string 3</SortField>
  <SortOrder>sample string 4</SortOrder>
</PagedRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ServiceResultOfPagedModelOfAuctionListItemModel
NameDescriptionTypeAdditional information
Result

PagedModelOfAuctionListItemModel

None.

ErrorCode

ServiceErrorCode

None.

ErrorMessage

Collection of string

None.

Success

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Result": {
    "Page": 1,
    "PageIndex": 1,
    "PageSize": 2,
    "Rows": [
      {
        "Name": "sample string 1",
        "MyBidDisplay": "sample string 2",
        "MyBid": 1.0,
        "AllParcelsPickedUp": true,
        "AllParcelsDelivered": true,
        "ClientRating": 5.0,
        "CarrierRating": 1.0,
        "WinnerRating": 1.0,
        "IsWinner": true,
        "MaxZipCode": "sample string 7",
        "MinZipCode": "sample string 8",
        "ZipCodesDisplay": "sample string 9",
        "DeliveryDate": "2024-03-29T02:32:46.9839921+00:00",
        "PickUpDate": "2024-03-29T02:32:46.9839921+00:00",
        "ActualDeliveryDate": "2024-03-29T02:32:46.9839921+00:00",
        "ActualPickUpDate": "2024-03-29T02:32:46.9839921+00:00",
        "ExpirationDate": "2024-03-29T02:32:46.9839921+00:00",
        "CreatedDate": "2024-03-29T02:32:46.9839921+00:00",
        "CurrentBidDisplay": "sample string 14",
        "CurrentBid": 1.0,
        "WinnerBidDisplay": "sample string 15",
        "WinnerBid": 1.0,
        "StartValueDisplay": "sample string 16",
        "StartValue": 17.0,
        "AverageVolumeDisplay": "sample string 18",
        "AverageVolume": 1.0,
        "WeightDisplay": "sample string 19",
        "Weight": 1.0,
        "NumberOfVolumes": 20,
        "TotalParcels": 21,
        "BidParcelId": "sample string 22",
        "Id": "69c96032-2ea7-4f9d-b622-02900ab55903",
        "AuctionStateId": 24
      },
      {
        "Name": "sample string 1",
        "MyBidDisplay": "sample string 2",
        "MyBid": 1.0,
        "AllParcelsPickedUp": true,
        "AllParcelsDelivered": true,
        "ClientRating": 5.0,
        "CarrierRating": 1.0,
        "WinnerRating": 1.0,
        "IsWinner": true,
        "MaxZipCode": "sample string 7",
        "MinZipCode": "sample string 8",
        "ZipCodesDisplay": "sample string 9",
        "DeliveryDate": "2024-03-29T02:32:46.9839921+00:00",
        "PickUpDate": "2024-03-29T02:32:46.9839921+00:00",
        "ActualDeliveryDate": "2024-03-29T02:32:46.9839921+00:00",
        "ActualPickUpDate": "2024-03-29T02:32:46.9839921+00:00",
        "ExpirationDate": "2024-03-29T02:32:46.9839921+00:00",
        "CreatedDate": "2024-03-29T02:32:46.9839921+00:00",
        "CurrentBidDisplay": "sample string 14",
        "CurrentBid": 1.0,
        "WinnerBidDisplay": "sample string 15",
        "WinnerBid": 1.0,
        "StartValueDisplay": "sample string 16",
        "StartValue": 17.0,
        "AverageVolumeDisplay": "sample string 18",
        "AverageVolume": 1.0,
        "WeightDisplay": "sample string 19",
        "Weight": 1.0,
        "NumberOfVolumes": 20,
        "TotalParcels": 21,
        "BidParcelId": "sample string 22",
        "Id": "69c96032-2ea7-4f9d-b622-02900ab55903",
        "AuctionStateId": 24
      }
    ],
    "Footer": {
      "Name": "sample string 1",
      "MyBidDisplay": "sample string 2",
      "MyBid": 1.0,
      "AllParcelsPickedUp": true,
      "AllParcelsDelivered": true,
      "ClientRating": 5.0,
      "CarrierRating": 1.0,
      "WinnerRating": 1.0,
      "IsWinner": true,
      "MaxZipCode": "sample string 7",
      "MinZipCode": "sample string 8",
      "ZipCodesDisplay": "sample string 9",
      "DeliveryDate": "2024-03-29T02:32:46.9839921+00:00",
      "PickUpDate": "2024-03-29T02:32:46.9839921+00:00",
      "ActualDeliveryDate": "2024-03-29T02:32:46.9839921+00:00",
      "ActualPickUpDate": "2024-03-29T02:32:46.9839921+00:00",
      "ExpirationDate": "2024-03-29T02:32:46.9839921+00:00",
      "CreatedDate": "2024-03-29T02:32:46.9839921+00:00",
      "CurrentBidDisplay": "sample string 14",
      "CurrentBid": 1.0,
      "WinnerBidDisplay": "sample string 15",
      "WinnerBid": 1.0,
      "StartValueDisplay": "sample string 16",
      "StartValue": 17.0,
      "AverageVolumeDisplay": "sample string 18",
      "AverageVolume": 1.0,
      "WeightDisplay": "sample string 19",
      "Weight": 1.0,
      "NumberOfVolumes": 20,
      "TotalParcels": 21,
      "BidParcelId": "sample string 22",
      "Id": "69c96032-2ea7-4f9d-b622-02900ab55903",
      "AuctionStateId": 24
    },
    "TotalPages": 3,
    "TotalRows": 4
  },
  "ErrorCode": 0,
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Success": true
}

application/xml, text/xml

Sample:
<ServiceResultOfPagedModelOfAuctionListItemModelEJHQiVccHLrnX27W 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.Common.Infrastructure.Filters">
    <d2p1:Footer xmlns:d3p1="http://schemas.datacontract.org/2004/07/BOP.Apps.Web.Areas.Api.Models">
      <d3p1:ActualDeliveryDate>2024-03-29T02:32:46.9839921+00:00</d3p1:ActualDeliveryDate>
      <d3p1:ActualPickUpDate>2024-03-29T02:32:46.9839921+00:00</d3p1:ActualPickUpDate>
      <d3p1:AllParcelsDelivered>true</d3p1:AllParcelsDelivered>
      <d3p1:AllParcelsPickedUp>true</d3p1:AllParcelsPickedUp>
      <d3p1:AuctionStateId>24</d3p1:AuctionStateId>
      <d3p1:AverageVolume>1</d3p1:AverageVolume>
      <d3p1:AverageVolumeDisplay>sample string 18</d3p1:AverageVolumeDisplay>
      <d3p1:BidParcelId>sample string 22</d3p1:BidParcelId>
      <d3p1:CarrierRating>1</d3p1:CarrierRating>
      <d3p1:ClientRating>5</d3p1:ClientRating>
      <d3p1:CreatedDate>2024-03-29T02:32:46.9839921+00:00</d3p1:CreatedDate>
      <d3p1:CurrentBid>1</d3p1:CurrentBid>
      <d3p1:CurrentBidDisplay>sample string 14</d3p1:CurrentBidDisplay>
      <d3p1:DeliveryDate>2024-03-29T02:32:46.9839921+00:00</d3p1:DeliveryDate>
      <d3p1:ExpirationDate>2024-03-29T02:32:46.9839921+00:00</d3p1:ExpirationDate>
      <d3p1:Id>69c96032-2ea7-4f9d-b622-02900ab55903</d3p1:Id>
      <d3p1:IsWinner>true</d3p1:IsWinner>
      <d3p1:MaxZipCode>sample string 7</d3p1:MaxZipCode>
      <d3p1:MinZipCode>sample string 8</d3p1:MinZipCode>
      <d3p1:MyBid>1</d3p1:MyBid>
      <d3p1:MyBidDisplay>sample string 2</d3p1:MyBidDisplay>
      <d3p1:Name>sample string 1</d3p1:Name>
      <d3p1:NumberOfVolumes>20</d3p1:NumberOfVolumes>
      <d3p1:PickUpDate>2024-03-29T02:32:46.9839921+00:00</d3p1:PickUpDate>
      <d3p1:StartValue>17</d3p1:StartValue>
      <d3p1:StartValueDisplay>sample string 16</d3p1:StartValueDisplay>
      <d3p1:TotalParcels>21</d3p1:TotalParcels>
      <d3p1:Weight>1</d3p1:Weight>
      <d3p1:WeightDisplay>sample string 19</d3p1:WeightDisplay>
      <d3p1:WinnerBid>1</d3p1:WinnerBid>
      <d3p1:WinnerBidDisplay>sample string 15</d3p1:WinnerBidDisplay>
      <d3p1:WinnerRating>1</d3p1:WinnerRating>
      <d3p1:ZipCodesDisplay>sample string 9</d3p1:ZipCodesDisplay>
    </d2p1:Footer>
    <d2p1:PageIndex>1</d2p1:PageIndex>
    <d2p1:PageSize>2</d2p1:PageSize>
    <d2p1:Rows xmlns:d3p1="http://schemas.datacontract.org/2004/07/BOP.Apps.Web.Areas.Api.Models">
      <d3p1:AuctionListItemModel>
        <d3p1:ActualDeliveryDate>2024-03-29T02:32:46.9839921+00:00</d3p1:ActualDeliveryDate>
        <d3p1:ActualPickUpDate>2024-03-29T02:32:46.9839921+00:00</d3p1:ActualPickUpDate>
        <d3p1:AllParcelsDelivered>true</d3p1:AllParcelsDelivered>
        <d3p1:AllParcelsPickedUp>true</d3p1:AllParcelsPickedUp>
        <d3p1:AuctionStateId>24</d3p1:AuctionStateId>
        <d3p1:AverageVolume>1</d3p1:AverageVolume>
        <d3p1:AverageVolumeDisplay>sample string 18</d3p1:AverageVolumeDisplay>
        <d3p1:BidParcelId>sample string 22</d3p1:BidParcelId>
        <d3p1:CarrierRating>1</d3p1:CarrierRating>
        <d3p1:ClientRating>5</d3p1:ClientRating>
        <d3p1:CreatedDate>2024-03-29T02:32:46.9839921+00:00</d3p1:CreatedDate>
        <d3p1:CurrentBid>1</d3p1:CurrentBid>
        <d3p1:CurrentBidDisplay>sample string 14</d3p1:CurrentBidDisplay>
        <d3p1:DeliveryDate>2024-03-29T02:32:46.9839921+00:00</d3p1:DeliveryDate>
        <d3p1:ExpirationDate>2024-03-29T02:32:46.9839921+00:00</d3p1:ExpirationDate>
        <d3p1:Id>69c96032-2ea7-4f9d-b622-02900ab55903</d3p1:Id>
        <d3p1:IsWinner>true</d3p1:IsWinner>
        <d3p1:MaxZipCode>sample string 7</d3p1:MaxZipCode>
        <d3p1:MinZipCode>sample string 8</d3p1:MinZipCode>
        <d3p1:MyBid>1</d3p1:MyBid>
        <d3p1:MyBidDisplay>sample string 2</d3p1:MyBidDisplay>
        <d3p1:Name>sample string 1</d3p1:Name>
        <d3p1:NumberOfVolumes>20</d3p1:NumberOfVolumes>
        <d3p1:PickUpDate>2024-03-29T02:32:46.9839921+00:00</d3p1:PickUpDate>
        <d3p1:StartValue>17</d3p1:StartValue>
        <d3p1:StartValueDisplay>sample string 16</d3p1:StartValueDisplay>
        <d3p1:TotalParcels>21</d3p1:TotalParcels>
        <d3p1:Weight>1</d3p1:Weight>
        <d3p1:WeightDisplay>sample string 19</d3p1:WeightDisplay>
        <d3p1:WinnerBid>1</d3p1:WinnerBid>
        <d3p1:WinnerBidDisplay>sample string 15</d3p1:WinnerBidDisplay>
        <d3p1:WinnerRating>1</d3p1:WinnerRating>
        <d3p1:ZipCodesDisplay>sample string 9</d3p1:ZipCodesDisplay>
      </d3p1:AuctionListItemModel>
      <d3p1:AuctionListItemModel>
        <d3p1:ActualDeliveryDate>2024-03-29T02:32:46.9839921+00:00</d3p1:ActualDeliveryDate>
        <d3p1:ActualPickUpDate>2024-03-29T02:32:46.9839921+00:00</d3p1:ActualPickUpDate>
        <d3p1:AllParcelsDelivered>true</d3p1:AllParcelsDelivered>
        <d3p1:AllParcelsPickedUp>true</d3p1:AllParcelsPickedUp>
        <d3p1:AuctionStateId>24</d3p1:AuctionStateId>
        <d3p1:AverageVolume>1</d3p1:AverageVolume>
        <d3p1:AverageVolumeDisplay>sample string 18</d3p1:AverageVolumeDisplay>
        <d3p1:BidParcelId>sample string 22</d3p1:BidParcelId>
        <d3p1:CarrierRating>1</d3p1:CarrierRating>
        <d3p1:ClientRating>5</d3p1:ClientRating>
        <d3p1:CreatedDate>2024-03-29T02:32:46.9839921+00:00</d3p1:CreatedDate>
        <d3p1:CurrentBid>1</d3p1:CurrentBid>
        <d3p1:CurrentBidDisplay>sample string 14</d3p1:CurrentBidDisplay>
        <d3p1:DeliveryDate>2024-03-29T02:32:46.9839921+00:00</d3p1:DeliveryDate>
        <d3p1:ExpirationDate>2024-03-29T02:32:46.9839921+00:00</d3p1:ExpirationDate>
        <d3p1:Id>69c96032-2ea7-4f9d-b622-02900ab55903</d3p1:Id>
        <d3p1:IsWinner>true</d3p1:IsWinner>
        <d3p1:MaxZipCode>sample string 7</d3p1:MaxZipCode>
        <d3p1:MinZipCode>sample string 8</d3p1:MinZipCode>
        <d3p1:MyBid>1</d3p1:MyBid>
        <d3p1:MyBidDisplay>sample string 2</d3p1:MyBidDisplay>
        <d3p1:Name>sample string 1</d3p1:Name>
        <d3p1:NumberOfVolumes>20</d3p1:NumberOfVolumes>
        <d3p1:PickUpDate>2024-03-29T02:32:46.9839921+00:00</d3p1:PickUpDate>
        <d3p1:StartValue>17</d3p1:StartValue>
        <d3p1:StartValueDisplay>sample string 16</d3p1:StartValueDisplay>
        <d3p1:TotalParcels>21</d3p1:TotalParcels>
        <d3p1:Weight>1</d3p1:Weight>
        <d3p1:WeightDisplay>sample string 19</d3p1:WeightDisplay>
        <d3p1:WinnerBid>1</d3p1:WinnerBid>
        <d3p1:WinnerBidDisplay>sample string 15</d3p1:WinnerBidDisplay>
        <d3p1:WinnerRating>1</d3p1:WinnerRating>
        <d3p1:ZipCodesDisplay>sample string 9</d3p1:ZipCodesDisplay>
      </d3p1:AuctionListItemModel>
    </d2p1:Rows>
    <d2p1:TotalPages>3</d2p1:TotalPages>
    <d2p1:TotalRows>4</d2p1:TotalRows>
  </Result>
</ServiceResultOfPagedModelOfAuctionListItemModelEJHQiVccHLrnX27W>