Cancel Prepare Bin

Endpoint

BIN_INTERFACE_API_ENDPOINT

Request parameters

Parameter	Mandatory?	Data type	Description
`all`	False	Boolean	Specifies that all bins should be removed from the preparation queue.
`bin_id`	False	Int (1-4000000)	Identifies one or more bins to be removed/cancelled from the prepare queue. 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>cancelpreparebin</name>
  <params>
    <bins>
      <bin_id>21334</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>cancelpreparebin</name>
  <params>
    <bins>
      <bin_id>21334</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>cancelpreparebin</name>
  <params>
    <bins>
      <bin_id>21334</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>cancelpreparebin</name>
  <params>
    <bins>
      <bin_id>21334</bin_id>
    </bins>
  </params>
</methodcall>

{
    "method": "cancelpreparebin",
    "params": {
        "all": false,
        "bins": [
            21334
        ]
    }
}

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
1010	Parameter bin_id is not valid (invalid format or out of range).
1011	The specified Bin does not exist.
1048	System is not available.
1065	Parameter all is not valid (invalid format or out of range).

Software version requirement

Software Release October 2022 and newer