Open Bin
Endpoint
TASK_INTERFACE_API_ENDPOINT
Request parameters
| Parameter | Mandatory? | Data type | Description |
|---|---|---|---|
port_id | True | Int (1-2000) | Identifies the Port. |
bin_id | False | Int (1 and 4000000) | Explicitly selects a specific bin. Use only when requesting ad-hoc bins. |
task_id | False | Int (1 and 2147483647) | Explicitly selects a specific task. Use only when requesting ad-hoc bins. |
taskgroup_id | False | Int (1 and 2147483647) | Explicitly selects a specific task group. Use only when requesting ad-hoc bins or resuming a suspended task group. |
shipment | False | Int (1 and 2147483647) | Explicitly selects a specific shipment. Use only when requesting ad-hoc bins. |
An ad-hoc bin request is made by opening the port withopenport(with category) and then callingopenbinwith the requestedbin_idandport_id. In this case thetask_idin the response will be automatically set to `
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>openbin</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>openbin</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>openbin</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"?>
<methodcall>
<name>openbin</name>
<params>
<port_id>4</port_id>
</params>
</methodcall>{
"method": "openbin",
"params": {
"port_id": 4
}
}Response parameters
| Parameter | Data type | Description |
|---|---|---|
| port_id | Int (1-2000) | Identifies the Port. |
| bin_id | Int (1-4000000) | The Port's selected Bin. |
| task_id | Int (1-2147483647) | The Port's selected task. |
Response example
<?xml version="1.0"?>
<response>
<params>
<port_id>4</port_id>
<bin_id>14861</bin_id>
<task_id>310022</task_id>
</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. |
| 1003 | Mandatory parameter port_id is missing. |
| 1004 | Parameter port_id is not valid (invalid format or out of range). |
| 1009 | The specified Port is not open. |
| 1010 | Parameter bin_id is not valid (invalid format or out of range). |
| 1011 | The specified Bin does not exist |
| 1012 | Parameter task_id is not valid (invalid format or out of range). |
| 1013 | Parameter taskgroup_id is not valid (invalid format or out of range). |
| 1014 | Parameter shipment is not valid (invalid format or out of range). |
| 1015 | There are no tasks or Bins that fulfill the Port select requirements. |
| 1016 | There are no Bins ready that fulfill the Port select requirements. |
| 1017 | The specified task does not exist |
| 1018 | The specified task group does not exist. |
| 1019 | The specified task group is selected by another Port. |
| 1020 | The openbin conflicts with a previous openbin call that is not yet closed. |
| 1021 | The openbin conflicts with the Port's selected shipment. |
| 1022 | The openbin conflicts with the Port's selected task group |
| 1023 | Multiple selection parameters are not allowed |
| 1048 | System is not available |
Software version requirement
Software Release October 2022 and newer
Updated about 2 months ago