HomeInterfacesRecipesChangelogFAQ
Log In
Interfaces

Case Get State

Endpoint

TASK_INTERFACE_API_ENDPOINT

Request parameters

ParameterMandatory?Data typeDescription
port_idTrueInt
(1-2000)
Identifies the Port.

Request example

//Interface installation location(Ip adress)
string ip = "127.0.0.1";
//The URL to the task interface
string url = "http://" + ip + ":44000/api/v2/task";
//XML that will be POST'ed
string xmlData = string.Format(
@"<?xml version=""1.0""?>
<methodcall>
  <name>case_getstate</name>
  <params>
    <port_id>4</port_id>
	</params>
</methodcall>");
//POST to interface
HttpResponseMessage response = await new HttpClient().PostAsync(url, new StringContent(xmlData,
        Encoding.UTF8, "application/xml"));
string responseString = await response.Content.ReadAsStringAsync();
Console.WriteLine(responseString);
# Interface installation location (IP address)
ip = "127.0.0.1"
# The URL to the task interface
url = f"http://{ip}:44000/api/v2/task"
# XML that will be POST'ed
xmlData ="""<?xml version="1.0"?>
<methodcall>
  <name>case_getstate</name>
  <params>
    <port_id>4</port_id>
	</params>
</methodcall>"""
# POST to interface
response = requests.post(url, data=xmlData.encode('utf-8'), headers={"Content-Type": "application/xml"})
print(response.text)
const ip = "127.0.0.1";
const url = `http://${ip}:44000/api/v2/task`;
const xmlData =
`<?xml version="1.0"?>
<methodcall>
    <name>case_getstate</name>
  <params>
    <port_id>4</port_id>
	</params>
</methodcall>`;

fetch(url, {
    method: 'POST',
    body: xmlData,
    headers: {
        'Content-Type': 'application/xml'
    }
})
    .then(response => response.text())
    .then(responseString => console.log(responseString));
<?xml version="1.0"?>
<methodcall>
  <name>case_getstate</name>
  <params>
    <port_id>4</port_id>
	</params>
</methodcall>
{
    "method": "case_getstate",
    "params": {
        "port_id": 4
		}
}

Response parameters

ParameterData typeDescription
port_idInt
(1-2000)
Identifies the Port.
bin_idInt
(1-4000000)
Bin associated with the current operation.
operationStringCurrent state of case operation (INSERT, EXTRACT, CANCEL).
statusString (same as Log Publisher)Current status of the Port.
bin_modeStringMode of the bin associated with the current operation.

Case State Parameters

Response example

<?xml version="1.0"?>
<response>
  <params>
    <port_id>4</port_id>
		<bin_id>10019</bin_id>
    <operation>INSERT</operation>
    <status>ICIN</status>
		<bin_mode>10019</bin_mode>
  </params>
</response>

OR

<?xml version="1.0"?>
<response>
  <fault>
    <code>1000</code>
  </fault>
</response>

Error Codes

Error CodeDescription
1000The specified port does not exist.
1087The Port specified is not an AutoCase port.

Software version requirement

Software Release April 2026 and newer