GET api/Auction/GetParcelInformationByExternalCode?authToken={authToken}&code={code}&externalOperatorId={externalOperatorId}

Gets Parcel Information by Package External Code

Request Information

URI Parameters

NameDescriptionTypeAdditional information
authToken

The Authentication Token

string

Required

code

The External Code

integer

Required

externalOperatorId

The External Operator Identifier

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

ServiceResultOfListOfAuctionParcelPickupModel
NameDescriptionTypeAdditional information
Result

Collection of AuctionParcelPickupModel

None.

ErrorCode

ServiceErrorCode

None.

ErrorMessage

Collection of string

None.

Success

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "Result": [
    {
      "AuctionParcelId": "ee6db19c-f301-43cf-897f-699f70151722",
      "AuctionId": "0f7fba9b-6461-4d7a-98aa-8b9d223acdfd",
      "BidParcelId": "sample string 3",
      "ParcelName": "sample string 4",
      "Packages": [
        {
          "Id": "c2c2443e-ea49-4f06-a194-9f63ed19cd2f",
          "BidParcelId": "sample string 2",
          "Name": "sample string 3",
          "Weight": 4.0,
          "Height": 5.0,
          "Width": 6.0,
          "Length": 7.0,
          "QrCode": "sample string 8",
          "ExternalCode": 1,
          "ExternalOperatorId": "804969e6-d5ef-4886-b2f4-b4b7e6edc1e0"
        },
        {
          "Id": "c2c2443e-ea49-4f06-a194-9f63ed19cd2f",
          "BidParcelId": "sample string 2",
          "Name": "sample string 3",
          "Weight": 4.0,
          "Height": 5.0,
          "Width": 6.0,
          "Length": 7.0,
          "QrCode": "sample string 8",
          "ExternalCode": 1,
          "ExternalOperatorId": "804969e6-d5ef-4886-b2f4-b4b7e6edc1e0"
        }
      ]
    },
    {
      "AuctionParcelId": "ee6db19c-f301-43cf-897f-699f70151722",
      "AuctionId": "0f7fba9b-6461-4d7a-98aa-8b9d223acdfd",
      "BidParcelId": "sample string 3",
      "ParcelName": "sample string 4",
      "Packages": [
        {
          "Id": "c2c2443e-ea49-4f06-a194-9f63ed19cd2f",
          "BidParcelId": "sample string 2",
          "Name": "sample string 3",
          "Weight": 4.0,
          "Height": 5.0,
          "Width": 6.0,
          "Length": 7.0,
          "QrCode": "sample string 8",
          "ExternalCode": 1,
          "ExternalOperatorId": "804969e6-d5ef-4886-b2f4-b4b7e6edc1e0"
        },
        {
          "Id": "c2c2443e-ea49-4f06-a194-9f63ed19cd2f",
          "BidParcelId": "sample string 2",
          "Name": "sample string 3",
          "Weight": 4.0,
          "Height": 5.0,
          "Width": 6.0,
          "Length": 7.0,
          "QrCode": "sample string 8",
          "ExternalCode": 1,
          "ExternalOperatorId": "804969e6-d5ef-4886-b2f4-b4b7e6edc1e0"
        }
      ]
    }
  ],
  "ErrorCode": 0,
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Success": true
}

application/xml, text/xml

Sample:
<ServiceResultOfArrayOfAuctionParcelPickupModelEJHQiVcc 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:AuctionParcelPickupModel>
      <d2p1:AuctionId>0f7fba9b-6461-4d7a-98aa-8b9d223acdfd</d2p1:AuctionId>
      <d2p1:AuctionParcelId>ee6db19c-f301-43cf-897f-699f70151722</d2p1:AuctionParcelId>
      <d2p1:BidParcelId>sample string 3</d2p1:BidParcelId>
      <d2p1:Packages>
        <d2p1:AuctionPackagePickupItemModel>
          <d2p1:BidParcelId>sample string 2</d2p1:BidParcelId>
          <d2p1:ExternalCode>1</d2p1:ExternalCode>
          <d2p1:ExternalOperatorId>804969e6-d5ef-4886-b2f4-b4b7e6edc1e0</d2p1:ExternalOperatorId>
          <d2p1:Height>5</d2p1:Height>
          <d2p1:Id>c2c2443e-ea49-4f06-a194-9f63ed19cd2f</d2p1:Id>
          <d2p1:Length>7</d2p1:Length>
          <d2p1:Name>sample string 3</d2p1:Name>
          <d2p1:QrCode>sample string 8</d2p1:QrCode>
          <d2p1:Weight>4</d2p1:Weight>
          <d2p1:Width>6</d2p1:Width>
        </d2p1:AuctionPackagePickupItemModel>
        <d2p1:AuctionPackagePickupItemModel>
          <d2p1:BidParcelId>sample string 2</d2p1:BidParcelId>
          <d2p1:ExternalCode>1</d2p1:ExternalCode>
          <d2p1:ExternalOperatorId>804969e6-d5ef-4886-b2f4-b4b7e6edc1e0</d2p1:ExternalOperatorId>
          <d2p1:Height>5</d2p1:Height>
          <d2p1:Id>c2c2443e-ea49-4f06-a194-9f63ed19cd2f</d2p1:Id>
          <d2p1:Length>7</d2p1:Length>
          <d2p1:Name>sample string 3</d2p1:Name>
          <d2p1:QrCode>sample string 8</d2p1:QrCode>
          <d2p1:Weight>4</d2p1:Weight>
          <d2p1:Width>6</d2p1:Width>
        </d2p1:AuctionPackagePickupItemModel>
      </d2p1:Packages>
      <d2p1:ParcelName>sample string 4</d2p1:ParcelName>
    </d2p1:AuctionParcelPickupModel>
    <d2p1:AuctionParcelPickupModel>
      <d2p1:AuctionId>0f7fba9b-6461-4d7a-98aa-8b9d223acdfd</d2p1:AuctionId>
      <d2p1:AuctionParcelId>ee6db19c-f301-43cf-897f-699f70151722</d2p1:AuctionParcelId>
      <d2p1:BidParcelId>sample string 3</d2p1:BidParcelId>
      <d2p1:Packages>
        <d2p1:AuctionPackagePickupItemModel>
          <d2p1:BidParcelId>sample string 2</d2p1:BidParcelId>
          <d2p1:ExternalCode>1</d2p1:ExternalCode>
          <d2p1:ExternalOperatorId>804969e6-d5ef-4886-b2f4-b4b7e6edc1e0</d2p1:ExternalOperatorId>
          <d2p1:Height>5</d2p1:Height>
          <d2p1:Id>c2c2443e-ea49-4f06-a194-9f63ed19cd2f</d2p1:Id>
          <d2p1:Length>7</d2p1:Length>
          <d2p1:Name>sample string 3</d2p1:Name>
          <d2p1:QrCode>sample string 8</d2p1:QrCode>
          <d2p1:Weight>4</d2p1:Weight>
          <d2p1:Width>6</d2p1:Width>
        </d2p1:AuctionPackagePickupItemModel>
        <d2p1:AuctionPackagePickupItemModel>
          <d2p1:BidParcelId>sample string 2</d2p1:BidParcelId>
          <d2p1:ExternalCode>1</d2p1:ExternalCode>
          <d2p1:ExternalOperatorId>804969e6-d5ef-4886-b2f4-b4b7e6edc1e0</d2p1:ExternalOperatorId>
          <d2p1:Height>5</d2p1:Height>
          <d2p1:Id>c2c2443e-ea49-4f06-a194-9f63ed19cd2f</d2p1:Id>
          <d2p1:Length>7</d2p1:Length>
          <d2p1:Name>sample string 3</d2p1:Name>
          <d2p1:QrCode>sample string 8</d2p1:QrCode>
          <d2p1:Weight>4</d2p1:Weight>
          <d2p1:Width>6</d2p1:Width>
        </d2p1:AuctionPackagePickupItemModel>
      </d2p1:Packages>
      <d2p1:ParcelName>sample string 4</d2p1:ParcelName>
    </d2p1:AuctionParcelPickupModel>
  </Result>
</ServiceResultOfArrayOfAuctionParcelPickupModelEJHQiVcc>