GET Allocation/GetAllocationsByProduct?DepartmentID={DepartmentID}&ProductID={ProductID}&LocationID={LocationID}&SalespersonID={SalespersonID}

Returns allocation details for a specific product.

Request Information

URI Parameters

Name	Description	Type	Additional Information
DepartmentID	Department id to get the allocations for.	string	Required
ProductID	Product id to get the allocations for.	string	Required
LocationID	Location ID logged into.	string	Required
SalespersonID	Salesperson id to get the allocations for.	string	Default value is string.Empty

Body Parameters

Response Information

Resource Description

Returns allocation details for a specific product.

AgvAllocation

Name	Description	Type
Status	Status of the API call.	string
Message	Message of the API call.	string
Count	Count of how many Allocation JSON dictionaries.	string
AllocationNum	AllocationNum if new Allocation is Posted.	string
Allocations	JSON dictionary of Allocation.	Collection of Allocation

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "sample string 3",
  "AllocationNum": "sample string 4",
  "Allocations": [
    {
      "AllocationNumber": "sample string 1",
      "DeptID": "sample string 2",
      "ProdID": "sample string 3",
      "ProductName": "sample string 4",
      "Quantity": 5.1,
      "QuantityOffered": 6.1,
      "QuantityApproved": 7.1,
      "Price": 8.1,
      "StartDate": "sample string 9",
      "EndDate": "sample string 10",
      "BillingUnit": "sample string 11",
      "InventoryUnit": "sample string 12",
      "UnitCost": 13.1,
      "AllocationExpirationDate": "sample string 14",
      "NetOffered": 15.1,
      "AllocationStartDate": "sample string 16",
      "ProdIDAlternate": "sample string 17",
      "SalesPersons": [
        {
          "Id": "sample string 1",
          "Quantity": 2.1
        },
        {
          "Id": "sample string 1",
          "Quantity": 2.1
        }
      ]
    },
    {
      "AllocationNumber": "sample string 1",
      "DeptID": "sample string 2",
      "ProdID": "sample string 3",
      "ProductName": "sample string 4",
      "Quantity": 5.1,
      "QuantityOffered": 6.1,
      "QuantityApproved": 7.1,
      "Price": 8.1,
      "StartDate": "sample string 9",
      "EndDate": "sample string 10",
      "BillingUnit": "sample string 11",
      "InventoryUnit": "sample string 12",
      "UnitCost": 13.1,
      "AllocationExpirationDate": "sample string 14",
      "NetOffered": 15.1,
      "AllocationStartDate": "sample string 16",
      "ProdIDAlternate": "sample string 17",
      "SalesPersons": [
        {
          "Id": "sample string 1",
          "Quantity": 2.1
        },
        {
          "Id": "sample string 1",
          "Quantity": 2.1
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<AgvAllocation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Allocation">
  <AllocationNum>sample string 4</AllocationNum>
  <Allocations>
    <Allocation>
      <AllocationExpirationDate>sample string 14</AllocationExpirationDate>
      <AllocationNumber>sample string 1</AllocationNumber>
      <AllocationStartDate>sample string 16</AllocationStartDate>
      <BillingUnit>sample string 11</BillingUnit>
      <DeptID>sample string 2</DeptID>
      <EndDate>sample string 10</EndDate>
      <InventoryUnit>sample string 12</InventoryUnit>
      <NetOffered>15.1</NetOffered>
      <Price>8.1</Price>
      <ProdID>sample string 3</ProdID>
      <ProdIDAlternate>sample string 17</ProdIDAlternate>
      <ProductName>sample string 4</ProductName>
      <Quantity>5.1</Quantity>
      <QuantityApproved>7.1</QuantityApproved>
      <QuantityOffered>6.1</QuantityOffered>
      <SalesPersons>
        <AllocationSalesPerson>
          <Id>sample string 1</Id>
          <Quantity>2.1</Quantity>
        </AllocationSalesPerson>
        <AllocationSalesPerson>
          <Id>sample string 1</Id>
          <Quantity>2.1</Quantity>
        </AllocationSalesPerson>
      </SalesPersons>
      <StartDate>sample string 9</StartDate>
      <UnitCost>13.1</UnitCost>
    </Allocation>
    <Allocation>
      <AllocationExpirationDate>sample string 14</AllocationExpirationDate>
      <AllocationNumber>sample string 1</AllocationNumber>
      <AllocationStartDate>sample string 16</AllocationStartDate>
      <BillingUnit>sample string 11</BillingUnit>
      <DeptID>sample string 2</DeptID>
      <EndDate>sample string 10</EndDate>
      <InventoryUnit>sample string 12</InventoryUnit>
      <NetOffered>15.1</NetOffered>
      <Price>8.1</Price>
      <ProdID>sample string 3</ProdID>
      <ProdIDAlternate>sample string 17</ProdIDAlternate>
      <ProductName>sample string 4</ProductName>
      <Quantity>5.1</Quantity>
      <QuantityApproved>7.1</QuantityApproved>
      <QuantityOffered>6.1</QuantityOffered>
      <SalesPersons>
        <AllocationSalesPerson>
          <Id>sample string 1</Id>
          <Quantity>2.1</Quantity>
        </AllocationSalesPerson>
        <AllocationSalesPerson>
          <Id>sample string 1</Id>
          <Quantity>2.1</Quantity>
        </AllocationSalesPerson>
      </SalesPersons>
      <StartDate>sample string 9</StartDate>
      <UnitCost>13.1</UnitCost>
    </Allocation>
  </Allocations>
  <Count>sample string 3</Count>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
</AgvAllocation>