Get Port Status

Endpoint

TASK_INTERFACE_API_ENDPOINT

Request parameters

Parameter	Mandatory?	Data type	Description
`port_id`	True	Int (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>

{
    "method": "getportstatus",
    "params": {
        "port_id": 1
    }
}

Response parameters

Parameter	Data type	Description
`port_id`	Int (1-2000)	Identifies the Port.
`port_type`	String	Identifies the Port type. Type `UNKNOWN` is returned when type is not recognized by the Interface.
`mode`	String	The current mode of operation of the Port.
`selected_bin`	Int (1-4000000)	Which Bin is currently selected at the specified Port (0 if no Bin is selected).
`selected_task`	Int (1-2147483647)	Which Task is currently selected at the specified Port (0 if no Task is selected).
`is_ready`	Boolean	Tells if the Bin is ready to be handled in the Port.
`is_empty`	Boolean	Tells if the Port is physically empty.
`error`	Boolean	Indicates whether or not the port currently has an error.
`error_codes`	String	Returns error codes for the port if it has an error. If sub-errors are available, they are presented as well.
`select`	Int (1-32767)	A collection of either categories or Bin content codes specified for the port.

📘
For available port modes refer to: Value Codes

Response example

<?xml version="1.0" encoding="utf-8"?>
<response>
  <params>
    <port>
      <port_id>1</port_id>
      <mode>OPEN</mode>
      <select>
        <category>1</category>
      </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" encoding="utf-8"?>
<response>
  <params>
    <port>
      <port_id>1</port_id>
      <mode>OPEN</mode>
      <select>
        <category>1</category>
      </select>
      <selected_bin>34401</selected_bin>
      <selected_task>1190504</selected_task>
      <is_ready>0</is_ready>
      <error>1</error>
      <error_codes>
        <error_code>309</error_code>
        <sub_errors>
          <sub_error>0</sub_error>
          <sub_error>21</sub_error>
        </sub_errors>
      </error_codes>
    </port>
  </params>
</response>

<?xml version="1.0" encoding="utf-8"?>
<response>
  <fault>
    <code>1000</code>
  </fault>
</response>

Error Codes

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

Software version requirement

Software Release October 2022 and newer