HomeInterfacesRecipesChangelogFAQ
Log In
Interfaces

Get Port Status

Endpoint

http://<server>:44000/api/v2/task

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"" encoding=""utf-8""?>
<methodcall>
<name>getportstatus</name>
  <params>
    <port_id>1</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" encoding="utf-8"?>
<methodcall>
<name>getportstatus</name>
  <params>
    <port_id>1</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" encoding="utf-8"?>
<methodcall>
<name>getportstatus</name>
  <params>
    <port_id>1</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" encoding="utf-8"?>
<methodcall>
<name>getportstatus</name>
  <params>
    <port_id>1</port_id>
  </params>
</methodcall>

Response parameters

ParameterData typeDescription
port_idInt
(1-2000)
Identifies the Port.
modeStringThe current mode of operation of the Port.
selectInt (1-32767)A collection of either categories or Bin content codes specified for the port.
selected_binInt
(1-4000000)
Which Bin is currently selected at the specified Port (0 if no Bin is selected).
selected_taskInt
(1-2147483647)
Which Task is currently selected at the specified Port (0 if no Task is selected).
is_readyBooleanTells if the Bin is ready to be handled in the Port.
errorBooleanIndicates whether or not the port currently has an error.
ModeDescription
CLOSEDThe port is closed.
OPENDefault mode. The port is open for picking or receiving goods.
AUTOThe port is open for picking or receiving goods, and will automatically open bins.(Deprecated.)
INSERTSpecial mode. The port is open for bin insertion.
SWAPSpecial mode. The port can be used for exchanging bins between grids.
MOVENot used.
SEQUENCESpecial mode. Task Interface only. The port is open and will deliver the defined sequence of task groups.
DISABLEDThe port is disabled. See section about MultiPort.
MULTIPORT_PUPPETThe port ID is disabled. The port module is controlled by a MultiPort.

Response example

<?xml version="1.0" encoding="utf-8"?>
<response>
  <params>
    <port>
      <port_id>1</port_id>
      <mode>OPEN</mode>
      <select>1</select>
      <selected_bin>34401</selected_bin>
      <selected_task>1190504</selected_task>
      <is_ready>0</is_ready>
      <error>0</error>
    </port>
  </params>
</response>

OR

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

Error Codes

Error CodeDescription
1000The specified Port is not available.
1003Mandatory parameter port_id is missing
1004Parameter port_id is not valid (invalid format or out of range).

Software version requirement

Software Release October 2022 and newer