POST Allocation/PostAllocation

Creates an allocation.

Request Information

URI Parameters

Body Parameters

Allocation object to post.

clsAPIAllocation
NameDescriptionTypeAdditional Information
AllocationNum

integer

Required

If auto numbering is to be used send 0. Otherwise, send the allocation number.

Must be filled out and numeric

Range: inclusive between 0 and 2147483647
AllocationDate

string

Required

Data type: DateTime

Format must be MM/dd/yyyy
DeptID

string

Required

Max length: 6
ProductID

string

Required

Max length: 10
Quantity

decimal number

Required

Cannot be negative

Must be numeric
SellingPrice

decimal number

Required

Cannot be negative

Must be numeric
StorageLocation

string

Max length: 20
StartDate

string

Data type: DateTime

Format must be MM/dd/yyyy
ExpirationDate

string

Data type: DateTime

Format must be MM/dd/yyyy
ReferenceNum

string

Max length: 20
Comments

string

Max length: 250
AllocationStatus

string

Required

Max length: 15

Valid options: Open or Closed.
AllocationExpirationDate

string

Data type: DateTime

Format must be MM/dd/yyyy
UnitCost

decimal number

Must be numeric
SalespersonList

Collection of SalesAllocationSalesperson

Request Formats

application/json, text/json

Sample: 
{
  "AllocationNum": 1,
  "AllocationDate": "sample string 2",
  "DeptID": "sample string 3",
  "ProductID": "sample string 4",
  "Quantity": 5.1,
  "SellingPrice": 6.1,
  "StorageLocation": "sample string 7",
  "StartDate": "sample string 8",
  "ExpirationDate": "sample string 9",
  "ReferenceNum": "sample string 10",
  "Comments": "sample string 11",
  "AllocationStatus": "sample string 12",
  "CreatedByUser": "sample string 13",
  "TimeCreated": "sample string 14",
  "AllocationExpirationDate": "sample string 15",
  "UnitCost": 16.1,
  "SalespersonList": [
    {
      "SalesPersonID": "sample string 1",
      "AllocationNum": 2,
      "Quantity": 3.1
    },
    {
      "SalesPersonID": "sample string 1",
      "AllocationNum": 2,
      "Quantity": 3.1
    }
  ]
}

application/xml, text/xml

Sample: 
<clsAPIAllocation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.API">
  <AllocationDate>sample string 2</AllocationDate>
  <AllocationExpirationDate>sample string 15</AllocationExpirationDate>
  <AllocationNum>1</AllocationNum>
  <AllocationStatus>sample string 12</AllocationStatus>
  <Comments>sample string 11</Comments>
  <CreatedByUser>sample string 13</CreatedByUser>
  <DeptID>sample string 3</DeptID>
  <ExpirationDate>sample string 9</ExpirationDate>
  <ProductID>sample string 4</ProductID>
  <Quantity>5.1</Quantity>
  <ReferenceNum>sample string 10</ReferenceNum>
  <SalespersonList>
    <clsAPIAllocation.SalesAllocationSalesperson>
      <AllocationNum>2</AllocationNum>
      <Quantity>3.1</Quantity>
      <SalesPersonID>sample string 1</SalesPersonID>
    </clsAPIAllocation.SalesAllocationSalesperson>
    <clsAPIAllocation.SalesAllocationSalesperson>
      <AllocationNum>2</AllocationNum>
      <Quantity>3.1</Quantity>
      <SalesPersonID>sample string 1</SalesPersonID>
    </clsAPIAllocation.SalesAllocationSalesperson>
  </SalespersonList>
  <SellingPrice>6.1</SellingPrice>
  <StartDate>sample string 8</StartDate>
  <StorageLocation>sample string 7</StorageLocation>
  <TimeCreated>sample string 14</TimeCreated>
  <UnitCost>16.1</UnitCost>
</clsAPIAllocation>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'clsAPIAllocation'.

Response Information

Resource Description

Creates an allocation.

AgvAllocation
NameDescriptionTypeAdditional Information
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>