Insert Bin

Endpoint

TASK_INTERFACE_API_ENDPOINT

Request parameters

Parameter	Mandatory?	Data type	Description
`port_id`	True	Int (1-2000)	Identifies the Port.
`bin_id`	True	Int (1and 4000000)	Integer between 1 and 4000000. Identifies the Bin.
`content`	False, but mandatory when `bin_type` is set	Int (0 and 10000000)	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_type`	False, but mandatory if the bin is not defined yet	Int	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.

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/task";
//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/task"
# 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/task`;
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>

{
    "method": "insertbin",
    "params": {
        "port_id": 4,
        "bin_id": 16477,
        "content": 10
    }
}

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.
1001	The specified Port is closing.
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).
1009	The specified Port is not open.
1010	Parameter bin_id is not valid (invalid format or out of range).
1011	The specified Bin does not exist.
1029	The specified Bin is already inserted.
1030	The Port has a selected Bin
1048	System is not available.
1058	Bin is still outside.
1073	Parameter bin_type is not valid (invalid format or out of range).
1077	Maximum number of Bins already inserted.
1083	No room for given content.

Software version requirement

Software Release October 2022 and newer