POST Product/ProductLotRequirementList

Returns the list of Products passed in, showing whether they require lot numbers.

Request Information

URI Parameters

Body Parameters

List of Product identifiers; either a ProductGuid or both DepartmentId and ProductId.

Collection of ClsProductToCheck
NameDescriptionTypeAdditional Information
ProductGuid

The unique identifier for a product

globally unique identifier

Either ProductGuid or the DepartmentId and ProductId must be populated

DepartmentId

Department ID of the product

string

Either this and ProductId or else the ProductGuid must be populated

Max length: 6

ProductId

ID of the product

string

Either this and DepartmentId or else the ProductGuid must be populated

Max length: 10

Request Formats

application/json, text/json

Sample:
[
  {
    "ProductGuid": "3cc3c28a-8551-4bc8-a1a7-41ad6c09077d",
    "DepartmentId": "sample string 3",
    "ProductId": "sample string 4"
  },
  {
    "ProductGuid": "3cc3c28a-8551-4bc8-a1a7-41ad6c09077d",
    "DepartmentId": "sample string 3",
    "ProductId": "sample string 4"
  }
]

application/xml, text/xml

Sample:
<ArrayOfClsProductLotTracking.ClsProductToCheck xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SKY.Core.Inventory">
  <ClsProductLotTracking.ClsProductToCheck>
    <DepartmentId>sample string 3</DepartmentId>
    <ProductGuid>3cc3c28a-8551-4bc8-a1a7-41ad6c09077d</ProductGuid>
    <ProductId>sample string 4</ProductId>
  </ClsProductLotTracking.ClsProductToCheck>
  <ClsProductLotTracking.ClsProductToCheck>
    <DepartmentId>sample string 3</DepartmentId>
    <ProductGuid>3cc3c28a-8551-4bc8-a1a7-41ad6c09077d</ProductGuid>
    <ProductId>sample string 4</ProductId>
  </ClsProductLotTracking.ClsProductToCheck>
</ArrayOfClsProductLotTracking.ClsProductToCheck>

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 'List`1'.

Response Information

Resource Description

Returns the list of Products passed in, showing whether they require lot numbers.

AgvProductLotRequirements
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
Count

Number of results returned

string
ProductLotNumberRequirements

List of Products that match the Products identified in the request with a RequiresLotNumber property value

Collection of ClsProductLotNumberRequirement

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "2",
  "ProductLotNumberRequirements": [
    {
      "RequiresLotNumber": true,
      "ProductGuid": "9688e1f4-ff8b-4ab1-9eb6-ba11862e1709",
      "DepartmentId": "sample string 4",
      "ProductId": "sample string 5"
    },
    {
      "RequiresLotNumber": true,
      "ProductGuid": "9688e1f4-ff8b-4ab1-9eb6-ba11862e1709",
      "DepartmentId": "sample string 4",
      "ProductId": "sample string 5"
    }
  ]
}

application/xml, text/xml

Sample:
<AgvProductLotRequirements xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Product">
  <Message>sample string 2</Message>
  <ProductLotNumberRequirements xmlns:d2p1="http://schemas.datacontract.org/2004/07/SKY.Core.Inventory">
    <d2p1:ClsProductLotTracking.ClsProductLotNumberRequirement>
      <d2p1:DepartmentId>sample string 4</d2p1:DepartmentId>
      <d2p1:ProductGuid>9688e1f4-ff8b-4ab1-9eb6-ba11862e1709</d2p1:ProductGuid>
      <d2p1:ProductId>sample string 5</d2p1:ProductId>
      <d2p1:RequiresLotNumber>true</d2p1:RequiresLotNumber>
    </d2p1:ClsProductLotTracking.ClsProductLotNumberRequirement>
    <d2p1:ClsProductLotTracking.ClsProductLotNumberRequirement>
      <d2p1:DepartmentId>sample string 4</d2p1:DepartmentId>
      <d2p1:ProductGuid>9688e1f4-ff8b-4ab1-9eb6-ba11862e1709</d2p1:ProductGuid>
      <d2p1:ProductId>sample string 5</d2p1:ProductId>
      <d2p1:RequiresLotNumber>true</d2p1:RequiresLotNumber>
    </d2p1:ClsProductLotTracking.ClsProductLotNumberRequirement>
  </ProductLotNumberRequirements>
  <Status>sample string 1</Status>
</AgvProductLotRequirements>