HomeInterfacesRecipesChangelogFAQ
Log In
Interfaces

Prepare Bin

Endpoint

BIN_INTERFACE_API_ENDPOINT

Request parameters

ParameterMandatory?Data typeDescription
bin_idTrueInt
(1-4000000)
Identifies one or more bins to be prepared for use. A maximum of 60,000 Bins is allowed in a single message.

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>preparebin</name>
  <params>
    <bins>
      <bin_id>21334</bin_id>
      <bin_id>25860</bin_id>
    </bins>
  </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>preparebin</name>
  <params>
    <bins>
      <bin_id>21334</bin_id>
      <bin_id>25860</bin_id>
    </bins>
  </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>preparebin</name>
  <params>
    <bins>
      <bin_id>21334</bin_id>
      <bin_id>25860</bin_id>
    </bins>
  </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>preparebin</name>
  <params>
    <bins>
      <bin_id>21334</bin_id>
      <bin_id>25860</bin_id>
    </bins>
  </params>
</methodcall>
{
    "method": "preparebin",
    "params": {
        "bins": [
            21334,
            25860
        ]
    }
}

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
1010Parameter bin_id is not valid (invalid format or out of range).
1011The specified Bin does not exist.
1048System is not available.
1063Bin preparation queue is full. The maximum size of the bin preparation queue is 60000 bins.
1064Mandatory parameter element Bins are missing.

Software version requirement

Software Release October 2022 and newer