GET Allocation/GetAllocation?AllocationNumber={AllocationNumber}&LocationID={LocationID}&DeptID={DeptID}&ProdID={ProdID}

Returns allocation details.

Request Information

URI Parameters

Name	Description	Type	Additional Information
AllocationNumber	Allocation number of the allocation to return the allocation details for.	string	Required
LocationID	Location ID logged into.	string	Required
DeptID	Department id that is on the allocation. (optional)	string	Default value is string.Empty
ProdID	Product id that is on the allocation. (optional)	string	Default value is string.Empty

Body Parameters

Response Information

Resource Description

Returns allocation details.

AgvAllocationDetails

Name	Description	Type
Status	Status of the API call.	string
Message	Message of the API call.	string
Count	Count of how many AllocationDetails.	string
Allocation	JSON dictionary of AllocationDetails.	AllocationDetails

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "sample string 3",
  "Allocation": {
    "AllocationNumber": "sample string 1",
    "DeptID": "sample string 2",
    "ProdID": "sample string 3",
    "ProductName": "sample string 4",
    "Quantity": 5.1,
    "Price": 6.1,
    "StorageLocation": "sample string 7",
    "StartDate": "sample string 8",
    "EndDate": "sample string 9",
    "Reference": "sample string 10",
    "Comments": "sample string 11",
    "QuantityOffered": 12.1,
    "QuantityApproved": 13.1,
    "BillingUnit": "sample string 14",
    "InventoryUnit": "sample string 15",
    "UnitCost": 16.1,
    "AllocationStartDate": "sample string 17",
    "AllocationExpirationDate": "sample string 18",
    "ProdIDAlternate": "sample string 19",
    "SalesPersons": [
      {
        "Id": "sample string 1",
        "Quantity": 2.1
      },
      {
        "Id": "sample string 1",
        "Quantity": 2.1
      }
    ]
  }
}

application/xml, text/xml

Sample:

<AgvAllocationDetails xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Allocation">
  <Allocation>
    <AllocationExpirationDate>sample string 18</AllocationExpirationDate>
    <AllocationNumber>sample string 1</AllocationNumber>
    <AllocationStartDate>sample string 17</AllocationStartDate>
    <BillingUnit>sample string 14</BillingUnit>
    <Comments>sample string 11</Comments>
    <DeptID>sample string 2</DeptID>
    <EndDate>sample string 9</EndDate>
    <InventoryUnit>sample string 15</InventoryUnit>
    <Price>6.1</Price>
    <ProdID>sample string 3</ProdID>
    <ProdIDAlternate>sample string 19</ProdIDAlternate>
    <ProductName>sample string 4</ProductName>
    <Quantity>5.1</Quantity>
    <QuantityApproved>13.1</QuantityApproved>
    <QuantityOffered>12.1</QuantityOffered>
    <Reference>sample string 10</Reference>
    <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 8</StartDate>
    <StorageLocation>sample string 7</StorageLocation>
    <UnitCost>16.1</UnitCost>
  </Allocation>
  <Count>sample string 3</Count>
  <Message>sample string 2</Message>
  <Status>sample string 1</Status>
</AgvAllocationDetails>