HomeInterfacesRecipesChangelogFAQ
Log In
Interfaces

Insert 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.
target_gridFalseInt
(1-1024)
Sets the target storage Grid for the bin. If this parameter is omitted, the bin will keep its previous target Grid.
contentFalse, but mandatory when bin_type is setInt
(0 and CONTENT_MAX)
Sets the Bin's content.
If this parameter is omitted, the Bin will keep its previous content. If the Bin has never been in the system
before, the content is set to "0".
bin_typeFalse, but mandatory if the bin is not defined yetInt
(1,2,5)
Specifies the Bin's type.
This parameter is mandatory if the Bin is not defined (the first time the Bin is inserted). In installations where
Bins are removed and inserted, the bin_type parameter is not required in subsequent inserts.
bin_typeDescription
1Standard Bin. Height 330 mm
2Standard Bin. Height 220 mm
5Standard Bin. Height 425 mm

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>insertbin</name>
  <params>
    <port_id>4</port_id>
    <bin_id>16477</bin_id>
    <content>10</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>insertbin</name>
  <params>
    <port_id>4</port_id>
    <bin_id>16477</bin_id>
    <content>10</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>insertbin</name>
  <params>
    <port_id>4</port_id>
    <bin_id>16477</bin_id>
    <content>10</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>insertbin</name>
  <params>
    <port_id>4</port_id>
    <bin_id>16477</bin_id>
    <content>10</content>
  </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.
1001The specified Port is closing.
1003Mandatory parameter port_id is missing
1004Parameter port_id is not valid (invalid format or out of range).
1006Parameter content 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.
1029The specified Bin is already inserted.
1030The Port has a selected Bin
1048System is not available.
1058Bin is still outside.
1061Parameter target_grid is not valid (invalid format or out of range).
1073Parameter bin_type is not valid (invalid format or out of range).
1077Maximum number of Bins already inserted.
1083No room for given content.

Software version requirement

Software Release October 2022 and newer