HomeInterfacesRecipesChangelogFAQ
Log In
Interfaces

Open Bin

Endpoint

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

Request parameters

ParameterMandatory?Data typeDescription
port_idTrueInt
(1-2000)
Identifies the Port.
bin_idFalseInt
(1-4000000)
The port ID is disabled. The port module is controlled by a MultiPort.
Explicitly selects a specific bin.

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>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/bin"
# 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/bin`;
const xmlData = 
`<?xml version="1.0"?>
<methodcall>
  <name>openbin</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>openbin</name>
  <params>
    <port_id>4</port_id>
  </params>
</methodcall>

Response parameters

ParameterData typeDescription
port_idInt
(1-2000)
Identifies the Port.
bin_idInt
(1-4000000)
The Port's selected Bin.

Response example

<?xml version="1.0"?>
<response>
  <params>
    <port_id>4</port_id>
    <bin_id>14861</bin_id>
  </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).
1009The specified Port is not open.
1010Parameter bin_id is not valid (invalid format or out of range).
1011The specified Bin does not exist
1015There are no tasks or Bins that fulfill the Port select requirements.
1016There are no Bins ready that fulfill the Port select requirements.
1020The openbin conflicts with a previous openbin call that is not yet closed.
1048System is not available

Software version requirement

Software Release October 2022 and newer