HomeInterfacesRecipesChangelogFAQ
Log In
Interfaces

Flush Port Bin

Endpoint

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

Request parameters

ParameterMandatory?Data typeDescription
port_idTrueInt
(1-2000)
Identifies the Port.
bin_idTrueInt
(1-4000000)
Identifies the Bin that should be moved.

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>flushportbin</name>
  <params>
    <port_id>5</port_id>
    <bin_id>14861</bin_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>flushportbin</name>
  <params>
    <port_id>5</port_id>
    <bin_id>14861</bin_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>flushportbin</name>
  <params>
    <port_id>5</port_id>
    <bin_id>14861</bin_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>flushportbin</name>
  <params>
    <port_id>5</port_id>
    <bin_id>14861</bin_id>
  </params>
</methodcall>

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 CodeDescription
1000The specified Port is not available.
1002The specified Port is already open.
1003Mandatory parameter port_id is missing.
1004Parameter port_id is not valid (invalid format or out of range).
1010Parameter bin_id is not valid (invalid format or out of range).
1011The specified Bin does not exist.
1024Mandatory parameter bin_id is missing.
1072The specified position does not belong to the specified Port.
1079Illegal Bin mode. The message forecastbin will be rejected if the current bin mode is not GRID. The cancelforecastbin will be rejected if the current bin mode is not FORECAST.
1087Illegal Port type.

Software version requirement

Software Release October 2022 and newer