POST api/Parcel/FindAvailableForAuction?authToken={authToken}

Finds the available Parcels for auction with the given filters.

Request Information

URI Parameters

Name	Description	Type	Additional information
authToken	The authentication token.	string	Required

Body Parameters

The filters.

PagedRequest

Name	Type	Additional 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

ServiceResultOfPagedModelOfParcelListItemModel

Name	Type	Additional information
Result	PagedModelOfParcelListItemModel	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": [
      {
        "Id": "5d0f0034-6d4f-411f-ac8f-c669c4e286e3",
        "BidParcelId": "sample string 2",
        "Name": "sample string 3",
        "NumberOfVolumes": 1,
        "Weight": 1.0,
        "AverageVolume": 1.0,
        "PickUpDate": "2024-11-04T10:35:31.5961782+00:00",
        "DeliveryDate": "2024-11-04T10:35:31.5961782+00:00",
        "ActualPickUpDate": "2024-11-04T10:35:31.5961782+00:00",
        "ActualDeliveryDate": "2024-11-04T10:35:31.5961782+00:00",
        "StartValue": 1.0,
        "EndValue": 1.0,
        "StateId": 1,
        "StateDescription": "Aguarda Pagamento",
        "DestinationZipCode": null,
        "CollectionZipCode": null,
        "CollectionAddress": null,
        "DestinationAddress": null,
        "CollectionCity": null,
        "DestinationCity": null
      },
      {
        "Id": "5d0f0034-6d4f-411f-ac8f-c669c4e286e3",
        "BidParcelId": "sample string 2",
        "Name": "sample string 3",
        "NumberOfVolumes": 1,
        "Weight": 1.0,
        "AverageVolume": 1.0,
        "PickUpDate": "2024-11-04T10:35:31.5961782+00:00",
        "DeliveryDate": "2024-11-04T10:35:31.5961782+00:00",
        "ActualPickUpDate": "2024-11-04T10:35:31.5961782+00:00",
        "ActualDeliveryDate": "2024-11-04T10:35:31.5961782+00:00",
        "StartValue": 1.0,
        "EndValue": 1.0,
        "StateId": 1,
        "StateDescription": "Aguarda Pagamento",
        "DestinationZipCode": null,
        "CollectionZipCode": null,
        "CollectionAddress": null,
        "DestinationAddress": null,
        "CollectionCity": null,
        "DestinationCity": null
      }
    ],
    "Footer": {
      "Id": "5d0f0034-6d4f-411f-ac8f-c669c4e286e3",
      "BidParcelId": "sample string 2",
      "Name": "sample string 3",
      "NumberOfVolumes": 1,
      "Weight": 1.0,
      "AverageVolume": 1.0,
      "PickUpDate": "2024-11-04T10:35:31.5961782+00:00",
      "DeliveryDate": "2024-11-04T10:35:31.5961782+00:00",
      "ActualPickUpDate": "2024-11-04T10:35:31.5961782+00:00",
      "ActualDeliveryDate": "2024-11-04T10:35:31.5961782+00:00",
      "StartValue": 1.0,
      "EndValue": 1.0,
      "StateId": 1,
      "StateDescription": "Aguarda Pagamento",
      "DestinationZipCode": null,
      "CollectionZipCode": null,
      "CollectionAddress": null,
      "DestinationAddress": null,
      "CollectionCity": null,
      "DestinationCity": null
    },
    "TotalPages": 3,
    "TotalRows": 4
  },
  "ErrorCode": 0,
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Success": true
}

application/xml, text/xml

Sample:

<ServiceResultOfPagedModelOfParcelListItemModelEJHQiVccHLrnX27W 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-11-04T10:35:31.5961782+00:00</d3p1:ActualDeliveryDate>
      <d3p1:ActualPickUpDate>2024-11-04T10:35:31.5961782+00:00</d3p1:ActualPickUpDate>
      <d3p1:AverageVolume>1</d3p1:AverageVolume>
      <d3p1:BidParcelId>sample string 2</d3p1:BidParcelId>
      <d3p1:DeliveryDate>2024-11-04T10:35:31.5961782+00:00</d3p1:DeliveryDate>
      <d3p1:EndValue>1</d3p1:EndValue>
      <d3p1:Id>5d0f0034-6d4f-411f-ac8f-c669c4e286e3</d3p1:Id>
      <d3p1:Name>sample string 3</d3p1:Name>
      <d3p1:NumberOfVolumes>1</d3p1:NumberOfVolumes>
      <d3p1:PickUpDate>2024-11-04T10:35:31.5961782+00:00</d3p1:PickUpDate>
      <d3p1:StartValue>1</d3p1:StartValue>
      <d3p1:StateId>Pending</d3p1:StateId>
      <d3p1:Weight>1</d3p1:Weight>
    </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:ParcelListItemModel>
        <d3p1:ActualDeliveryDate>2024-11-04T10:35:31.5961782+00:00</d3p1:ActualDeliveryDate>
        <d3p1:ActualPickUpDate>2024-11-04T10:35:31.5961782+00:00</d3p1:ActualPickUpDate>
        <d3p1:AverageVolume>1</d3p1:AverageVolume>
        <d3p1:BidParcelId>sample string 2</d3p1:BidParcelId>
        <d3p1:DeliveryDate>2024-11-04T10:35:31.5961782+00:00</d3p1:DeliveryDate>
        <d3p1:EndValue>1</d3p1:EndValue>
        <d3p1:Id>5d0f0034-6d4f-411f-ac8f-c669c4e286e3</d3p1:Id>
        <d3p1:Name>sample string 3</d3p1:Name>
        <d3p1:NumberOfVolumes>1</d3p1:NumberOfVolumes>
        <d3p1:PickUpDate>2024-11-04T10:35:31.5961782+00:00</d3p1:PickUpDate>
        <d3p1:StartValue>1</d3p1:StartValue>
        <d3p1:StateId>Pending</d3p1:StateId>
        <d3p1:Weight>1</d3p1:Weight>
      </d3p1:ParcelListItemModel>
      <d3p1:ParcelListItemModel>
        <d3p1:ActualDeliveryDate>2024-11-04T10:35:31.5961782+00:00</d3p1:ActualDeliveryDate>
        <d3p1:ActualPickUpDate>2024-11-04T10:35:31.5961782+00:00</d3p1:ActualPickUpDate>
        <d3p1:AverageVolume>1</d3p1:AverageVolume>
        <d3p1:BidParcelId>sample string 2</d3p1:BidParcelId>
        <d3p1:DeliveryDate>2024-11-04T10:35:31.5961782+00:00</d3p1:DeliveryDate>
        <d3p1:EndValue>1</d3p1:EndValue>
        <d3p1:Id>5d0f0034-6d4f-411f-ac8f-c669c4e286e3</d3p1:Id>
        <d3p1:Name>sample string 3</d3p1:Name>
        <d3p1:NumberOfVolumes>1</d3p1:NumberOfVolumes>
        <d3p1:PickUpDate>2024-11-04T10:35:31.5961782+00:00</d3p1:PickUpDate>
        <d3p1:StartValue>1</d3p1:StartValue>
        <d3p1:StateId>Pending</d3p1:StateId>
        <d3p1:Weight>1</d3p1:Weight>
      </d3p1:ParcelListItemModel>
    </d2p1:Rows>
    <d2p1:TotalPages>3</d2p1:TotalPages>
    <d2p1:TotalRows>4</d2p1:TotalRows>
  </Result>
</ServiceResultOfPagedModelOfParcelListItemModelEJHQiVccHLrnX27W>