Close Bin

Endpoint

BIN_INTERFACE_API_ENDPOINT

Request parameters

Parameter	Mandatory?	Data type	Description
`port_id`	True	Int (1-2000)	Identifies the Port.
`bin_id`	True	Int (1-4000000)	Must be equal to the open Bin.
`content`	False	Int (0 and 10000000)	Sets the content of the Bin. If this parameter is not provided, the content of the Bin is not changed.

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>closebin</name>
  <params>
    <port_id>4</port_id>
    <bin_id>14861</bin_id>
    <content>1</content>
  </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>closebin</name>
  <params>
    <port_id>4</port_id>
    <bin_id>14861</bin_id>
    <content>1</content>
  </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>closebin</name>
  <params>
    <port_id>4</port_id>
    <bin_id>14861</bin_id>
    <content>1</content>
  </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>closebin</name>
  <params>
    <port_id>4</port_id>
    <bin_id>14861</bin_id>
    <content>1</content>
  </params>
</methodcall>

{
    "method": "closebin",
    "params": {
        "port_id": 4,
        "bin_id": 14861,
        "target_grid": 2
    }
}

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
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).
1006	Parameter content is not valid (invalid format or out of range).
1010	Parameter bin_id is not valid (invalid format or out of range).
1024	Mandatory parameter bin_id is missing.
1026	The Port does not have a selected Bin.
1027	The Bin is not yet ready in the Port.
1028	The Bin and task parameters conflict with the open Bin and task.
1048	System is not available.
1061	Parameter target_grid is not valid (invalid format or out of range).
1083	No room for given content.

Software version requirement

Software Release October 2022 and newer