POST api/HCS/GetOpenBatches

Request Information

URI Parameters

None.

Body Parameters

BatchCompletionCriteria
NameDescriptionTypeAdditional information
EmpId

integer

None.

LineID

string

None.

ITEMNMBR

string

None.

GPDocDate

date

None.

BulkBatch

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "EmpId": 1,
  "LineID": "sample string 2",
  "ITEMNMBR": "sample string 3",
  "GPDocDate": "2025-05-15T13:00:36.3088612+00:00",
  "BulkBatch": true
}

application/xml, text/xml

Sample:
<BatchCompletionCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HCSAPI.DTOs">
  <BulkBatch>true</BulkBatch>
  <EmpId>1</EmpId>
  <GPDocDate>2025-05-15T13:00:36.3088612+00:00</GPDocDate>
  <ITEMNMBR>sample string 3</ITEMNMBR>
  <LineID>sample string 2</LineID>
</BatchCompletionCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of NameValue
NameDescriptionTypeAdditional information
Name

string

None.

Value

string

None.

Permission

string

None.

id

integer

None.

defaultselection

boolean

None.

Location

string

None.

ViewOption

boolean

None.

EditOption

boolean

None.

Prefix

string

None.

ProductionStatus

string

None.

MixerID

integer

None.

MixerNmbr

integer

None.

MixerName

string

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Name": "sample string 1",
    "Value": "sample string 2",
    "Permission": "sample string 3",
    "id": 4,
    "defaultselection": true,
    "Location": "sample string 6",
    "ViewOption": true,
    "EditOption": true,
    "Prefix": "sample string 9",
    "ProductionStatus": "sample string 10",
    "MixerID": 11,
    "MixerNmbr": 12,
    "MixerName": "sample string 13"
  },
  {
    "Name": "sample string 1",
    "Value": "sample string 2",
    "Permission": "sample string 3",
    "id": 4,
    "defaultselection": true,
    "Location": "sample string 6",
    "ViewOption": true,
    "EditOption": true,
    "Prefix": "sample string 9",
    "ProductionStatus": "sample string 10",
    "MixerID": 11,
    "MixerNmbr": 12,
    "MixerName": "sample string 13"
  }
]

application/xml, text/xml

Sample:
<ArrayOfNameValue xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HCSAPI.DTOs">
  <NameValue>
    <EditOption>true</EditOption>
    <Location>sample string 6</Location>
    <MixerID>11</MixerID>
    <MixerName>sample string 13</MixerName>
    <MixerNmbr>12</MixerNmbr>
    <Name>sample string 1</Name>
    <Permission>sample string 3</Permission>
    <Prefix>sample string 9</Prefix>
    <ProductionStatus>sample string 10</ProductionStatus>
    <Value>sample string 2</Value>
    <ViewOption>true</ViewOption>
    <defaultselection>true</defaultselection>
    <id>4</id>
  </NameValue>
  <NameValue>
    <EditOption>true</EditOption>
    <Location>sample string 6</Location>
    <MixerID>11</MixerID>
    <MixerName>sample string 13</MixerName>
    <MixerNmbr>12</MixerNmbr>
    <Name>sample string 1</Name>
    <Permission>sample string 3</Permission>
    <Prefix>sample string 9</Prefix>
    <ProductionStatus>sample string 10</ProductionStatus>
    <Value>sample string 2</Value>
    <ViewOption>true</ViewOption>
    <defaultselection>true</defaultselection>
    <id>4</id>
  </NameValue>
</ArrayOfNameValue>