POST Seed/GetProductAvailability

Get seed product availability

Request Information

URI Parameters

Body Parameters

request object

ProductAvailability
NameDescriptionTypeAdditional Information
VendorId

Vendor ID

 string

Required

Max length: 10
LocationId

Location ID

 string

Required

Max length: 6
Products

List of products to check availability

 Collection of ProductRequest

List cannot be empty

Request Formats

application/json, text/json

Sample: 
{
  "VendorId": "sample string 1",
  "LocationId": "sample string 2",
  "Products": [
    {
      "DeptId": "sample string 1",
      "ProdId": "sample string 2",
      "RequestedQuantity": 3.1
    },
    {
      "DeptId": "sample string 1",
      "ProdId": "sample string 2",
      "RequestedQuantity": 3.1
    }
  ]
}

application/xml, text/xml

Sample: 
<ProductAvailability xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SKY.Core.Seed">
  <LocationId>sample string 2</LocationId>
  <Products>
    <ProductAvailability.ProductRequest>
      <DeptId>sample string 1</DeptId>
      <ProdId>sample string 2</ProdId>
      <RequestedQuantity>3.1</RequestedQuantity>
    </ProductAvailability.ProductRequest>
    <ProductAvailability.ProductRequest>
      <DeptId>sample string 1</DeptId>
      <ProdId>sample string 2</ProdId>
      <RequestedQuantity>3.1</RequestedQuantity>
    </ProductAvailability.ProductRequest>
  </Products>
  <VendorId>sample string 1</VendorId>
</ProductAvailability>

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 'ProductAvailability'.

Response Information

Resource Description

Get seed product availability

AgvProductAvailability
NameDescriptionTypeAdditional Information
Status

0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful.

 string
Message

Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know.

 string
ErrorList

List of errors from the API

 Collection of string
WarningList

List of warnings from the API

 Collection of string
Count

Count of how many Products are returned

 string
Products

List of Products

 Collection of ProductDetail

Response Formats

application/json, text/json

Sample: 
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "WarningList": [
    "sample string 1",
    "sample string 2"
  ],
  "Count": "2",
  "Products": [
    {
      "DeptId": "sample string 1",
      "ProdId": "sample string 2",
      "AmountAvailableMessage": "sample string 3"
    },
    {
      "DeptId": "sample string 1",
      "ProdId": "sample string 2",
      "AmountAvailableMessage": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample: 
<AgvProductAvailability xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Seed">
  <ErrorList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorList>
  <Message>sample string 2</Message>
  <Products xmlns:d2p1="http://schemas.datacontract.org/2004/07/SKY.Core.Seed">
    <d2p1:ProductAvailability.ProductDetail>
      <d2p1:AmountAvailableMessage>sample string 3</d2p1:AmountAvailableMessage>
      <d2p1:DeptId>sample string 1</d2p1:DeptId>
      <d2p1:ProdId>sample string 2</d2p1:ProdId>
    </d2p1:ProductAvailability.ProductDetail>
    <d2p1:ProductAvailability.ProductDetail>
      <d2p1:AmountAvailableMessage>sample string 3</d2p1:AmountAvailableMessage>
      <d2p1:DeptId>sample string 1</d2p1:DeptId>
      <d2p1:ProdId>sample string 2</d2p1:ProdId>
    </d2p1:ProductAvailability.ProductDetail>
  </Products>
  <Status>sample string 1</Status>
  <WarningList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WarningList>
</AgvProductAvailability>