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

Find Picking up Parcels for Client

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

ServiceResultOfPagedModelOfAuctionParcelListItemModel

Name	Type	Additional information
Result	PagedModelOfAuctionParcelListItemModel	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": "120ded44-c585-4780-be15-9b806e4b19c2",
        "AuctionId": "c7d14782-31ac-42d8-92cb-d46d97d8c312",
        "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": "7bbf8454-9e0c-447f-bf7c-1add14692792",
        "BidParcelId": "sample string 14",
        "PickUpDate": "2024-04-15T02:55:51.5771897+00:00",
        "DeliveryDate": "2024-04-15T02:55:51.5771897+00:00",
        "ActualPickUpDate": "2024-04-15T02:55:51.5771897+00:00",
        "ActualDeliveryDate": "2024-04-15T02:55:51.5771897+00:00"
      },
      {
        "Id": "120ded44-c585-4780-be15-9b806e4b19c2",
        "AuctionId": "c7d14782-31ac-42d8-92cb-d46d97d8c312",
        "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": "7bbf8454-9e0c-447f-bf7c-1add14692792",
        "BidParcelId": "sample string 14",
        "PickUpDate": "2024-04-15T02:55:51.5771897+00:00",
        "DeliveryDate": "2024-04-15T02:55:51.5771897+00:00",
        "ActualPickUpDate": "2024-04-15T02:55:51.5771897+00:00",
        "ActualDeliveryDate": "2024-04-15T02:55:51.5771897+00:00"
      }
    ],
    "Footer": {
      "Id": "120ded44-c585-4780-be15-9b806e4b19c2",
      "AuctionId": "c7d14782-31ac-42d8-92cb-d46d97d8c312",
      "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": "7bbf8454-9e0c-447f-bf7c-1add14692792",
      "BidParcelId": "sample string 14",
      "PickUpDate": "2024-04-15T02:55:51.5771897+00:00",
      "DeliveryDate": "2024-04-15T02:55:51.5771897+00:00",
      "ActualPickUpDate": "2024-04-15T02:55:51.5771897+00:00",
      "ActualDeliveryDate": "2024-04-15T02:55:51.5771897+00:00"
    },
    "TotalPages": 3,
    "TotalRows": 4
  },
  "ErrorCode": 0,
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Success": true
}

application/xml, text/xml

Sample:

<ServiceResultOfPagedModelOfAuctionParcelListItemModelEJHQiVccHLrnX27W 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-04-15T02:55:51.5771897+00:00</d3p1:ActualDeliveryDate>
      <d3p1:ActualPickUpDate>2024-04-15T02:55:51.5771897+00:00</d3p1:ActualPickUpDate>
      <d3p1:AuctionId>c7d14782-31ac-42d8-92cb-d46d97d8c312</d3p1:AuctionId>
      <d3p1:AverageVolume>1</d3p1:AverageVolume>
      <d3p1:BidParcelId>sample string 14</d3p1:BidParcelId>
      <d3p1:CarrierAccountId>7bbf8454-9e0c-447f-bf7c-1add14692792</d3p1:CarrierAccountId>
      <d3p1:CarrierName>sample string 13</d3p1:CarrierName>
      <d3p1:CollectionAddress>sample string 4</d3p1:CollectionAddress>
      <d3p1:CollectionZipCode>sample string 5</d3p1:CollectionZipCode>
      <d3p1:Comments>sample string 8</d3p1:Comments>
      <d3p1:DeliveryDate>2024-04-15T02:55:51.5771897+00:00</d3p1:DeliveryDate>
      <d3p1:DeliveryStateId>12</d3p1:DeliveryStateId>
      <d3p1:DestinationAddress>sample string 6</d3p1:DestinationAddress>
      <d3p1:DestinationEmail>sample string 10</d3p1:DestinationEmail>
      <d3p1:DestinationName>sample string 9</d3p1:DestinationName>
      <d3p1:DestinationPhone>sample string 11</d3p1:DestinationPhone>
      <d3p1:DestinationZipCode>sample string 7</d3p1:DestinationZipCode>
      <d3p1:Id>120ded44-c585-4780-be15-9b806e4b19c2</d3p1:Id>
      <d3p1:Name>sample string 3</d3p1:Name>
      <d3p1:NumberOfVolumes>1</d3p1:NumberOfVolumes>
      <d3p1:PickUpDate>2024-04-15T02:55:51.5771897+00:00</d3p1:PickUpDate>
      <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:AuctionParcelListItemModel>
        <d3p1:ActualDeliveryDate>2024-04-15T02:55:51.5771897+00:00</d3p1:ActualDeliveryDate>
        <d3p1:ActualPickUpDate>2024-04-15T02:55:51.5771897+00:00</d3p1:ActualPickUpDate>
        <d3p1:AuctionId>c7d14782-31ac-42d8-92cb-d46d97d8c312</d3p1:AuctionId>
        <d3p1:AverageVolume>1</d3p1:AverageVolume>
        <d3p1:BidParcelId>sample string 14</d3p1:BidParcelId>
        <d3p1:CarrierAccountId>7bbf8454-9e0c-447f-bf7c-1add14692792</d3p1:CarrierAccountId>
        <d3p1:CarrierName>sample string 13</d3p1:CarrierName>
        <d3p1:CollectionAddress>sample string 4</d3p1:CollectionAddress>
        <d3p1:CollectionZipCode>sample string 5</d3p1:CollectionZipCode>
        <d3p1:Comments>sample string 8</d3p1:Comments>
        <d3p1:DeliveryDate>2024-04-15T02:55:51.5771897+00:00</d3p1:DeliveryDate>
        <d3p1:DeliveryStateId>12</d3p1:DeliveryStateId>
        <d3p1:DestinationAddress>sample string 6</d3p1:DestinationAddress>
        <d3p1:DestinationEmail>sample string 10</d3p1:DestinationEmail>
        <d3p1:DestinationName>sample string 9</d3p1:DestinationName>
        <d3p1:DestinationPhone>sample string 11</d3p1:DestinationPhone>
        <d3p1:DestinationZipCode>sample string 7</d3p1:DestinationZipCode>
        <d3p1:Id>120ded44-c585-4780-be15-9b806e4b19c2</d3p1:Id>
        <d3p1:Name>sample string 3</d3p1:Name>
        <d3p1:NumberOfVolumes>1</d3p1:NumberOfVolumes>
        <d3p1:PickUpDate>2024-04-15T02:55:51.5771897+00:00</d3p1:PickUpDate>
        <d3p1:Weight>1</d3p1:Weight>
      </d3p1:AuctionParcelListItemModel>
      <d3p1:AuctionParcelListItemModel>
        <d3p1:ActualDeliveryDate>2024-04-15T02:55:51.5771897+00:00</d3p1:ActualDeliveryDate>
        <d3p1:ActualPickUpDate>2024-04-15T02:55:51.5771897+00:00</d3p1:ActualPickUpDate>
        <d3p1:AuctionId>c7d14782-31ac-42d8-92cb-d46d97d8c312</d3p1:AuctionId>
        <d3p1:AverageVolume>1</d3p1:AverageVolume>
        <d3p1:BidParcelId>sample string 14</d3p1:BidParcelId>
        <d3p1:CarrierAccountId>7bbf8454-9e0c-447f-bf7c-1add14692792</d3p1:CarrierAccountId>
        <d3p1:CarrierName>sample string 13</d3p1:CarrierName>
        <d3p1:CollectionAddress>sample string 4</d3p1:CollectionAddress>
        <d3p1:CollectionZipCode>sample string 5</d3p1:CollectionZipCode>
        <d3p1:Comments>sample string 8</d3p1:Comments>
        <d3p1:DeliveryDate>2024-04-15T02:55:51.5771897+00:00</d3p1:DeliveryDate>
        <d3p1:DeliveryStateId>12</d3p1:DeliveryStateId>
        <d3p1:DestinationAddress>sample string 6</d3p1:DestinationAddress>
        <d3p1:DestinationEmail>sample string 10</d3p1:DestinationEmail>
        <d3p1:DestinationName>sample string 9</d3p1:DestinationName>
        <d3p1:DestinationPhone>sample string 11</d3p1:DestinationPhone>
        <d3p1:DestinationZipCode>sample string 7</d3p1:DestinationZipCode>
        <d3p1:Id>120ded44-c585-4780-be15-9b806e4b19c2</d3p1:Id>
        <d3p1:Name>sample string 3</d3p1:Name>
        <d3p1:NumberOfVolumes>1</d3p1:NumberOfVolumes>
        <d3p1:PickUpDate>2024-04-15T02:55:51.5771897+00:00</d3p1:PickUpDate>
        <d3p1:Weight>1</d3p1:Weight>
      </d3p1:AuctionParcelListItemModel>
    </d2p1:Rows>
    <d2p1:TotalPages>3</d2p1:TotalPages>
    <d2p1:TotalRows>4</d2p1:TotalRows>
  </Result>
</ServiceResultOfPagedModelOfAuctionParcelListItemModelEJHQiVccHLrnX27W>