Enable MultiPort

⚠️
Requires AS Router software.

📘
Requires Empty Port
WARNING: Before enabling a MultiPort, the MultiPort must be empty from bins. This can be accomplished by calling the Flush Port method on the MultiPort and waiting until the robots have picked up all bins.

Endpoint

TASK_INTERFACE_API_ENDPOINT

Request parameters

Parameter	Mandatory?	Data type	Description
`port_id`	True	Int (1-2000)	Identifies the 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/task";
//XML that will be POST'ed
string xmlData = string.Format(
@"<?xml version=""1.0""?>
<methodcall>
  <name>enablemultiport</name>
  <params>
    <port_id>5</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>enablemultiport</name>
  <params>
    <port_id>5</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>enablemultiport</name>
  <params>
    <port_id>5</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>enablemultiport</name>
  <params>
    <port_id>5</port_id>
  </params>
</methodcall>

{
    "method": "enablemultiport",
    "params": {
        "port_id": 5
    }
}

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
1003	Mandatory parameter port_id is missing.
1004	Parameter port_id is not valid (invalid format or out of range).
1078	Bin is in port. The port must be empty before it is possible to enable the MultiPort, but there is one or more bins in the MultiPort or one of the connected physical ports. The `flushport` method can be used to request the port(s) to be emptied.
1099	The MultiPort or one of the connected physical ports does not have the correct PortMode to allow enabling of the MultiPort.

Software version requirement

Software Release October 2023