Open Port

Endpoint

BIN_INTERFACE_API_ENDPOINT

Request parameters

Parameter	Mandatory?	Data type	Description
`port_id`	True	Int (1-2000)	Identifies the Port.
`port_mode`	False	String	Specifies a special mode of operation. The default port mode is `OPEN`, unless a special mode is specified.

Mode	Description
CLOSED	The port is closed.
OPEN	Default mode. The port is open for picking or receiving goods.
AUTO	The port is open for picking or receiving goods, and will automatically open bins. (Deprecated.)
INSERT	Special mode. The port is open for bin insertion.
SWAP	Special mode. The port can be used for exchanging bins between grids.
MOVE	Not used.
SEQUENCE	Special mode. Task Interface only. The port is open and will deliver the defined sequence of task groups.
DISABLED	The port is disabled. See section about MultiPort.
MULTIPORT_PUPPETT	The port ID is disabled. The port module is controlled by a MultiPort.

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/bin";
//XML that will be POST'ed
string xmlData = string.Format(
@"<?xml version=""1.0""?>
<methodcall>
  <name>openport</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/bin"
# XML that will be POST'ed
xmlData ="""<?xml version="1.0"?>
<methodcall>
  <name>openport</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/bin`;
const xmlData = 
`<?xml version="1.0"?>
<methodcall>
  <name>openport</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>openport</name>
  <params>
    <port_id>4</port_id>
  </params>
</methodcall>

{
    "method": "openport",
    "params": {
        "port_id": 4
    }
}

Response parameters

This method has no response parameters.

Response example

<?xml version="1.0"?>
<response>
  <params/>
</response>

OR

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

Error Codes

Error Code	Description
1000	The specified Port is not available.
1001	The specified Port is closing.
1002	The specified Port is already open.
1003	Mandatory parameter port_id is missing.
1004	Parameter port_id is not valid (invalid format or out of range).
1048	System is not available.
1060	Parameter port_mode is not valid (invalid format or out of range).

Software version requirement

Software Release October 2022 and newer