Get Bin Information
Endpoint
http://<server>:44000/api/v2/bin
Request parameters
| Parameter | Mandatory? | Data type | Description |
|---|---|---|---|
| bin_id | false | Int (1-4000000) | If the parameter bin_id is provided, only information about that specific Bin is returned. |
| min_bin_id | False | Int (1-4000000) | If the parameter min_bin_id is provided, only Bins with bin_id greater than or equal to min_bin_id are returned. |
| max_bin_id | False | Int (1-4000000) | If the parameter max_bin_id is provided, only Bins with bin_id less than or equal to max_bin_id are returned. |
Request example
//Interface installation location(Ip adress)
string ip = "127.0.0.1";
//The URL to the bin 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>getbininfo</name>
<params>
<bin_id>12004</bin_id>
</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>getbininfo</name>
<params>
<bin_id>12004</bin_id>
</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>getbininfo</name>
<params>
<bin_id>12004</bin_id>
</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>getbininfo</name>
<params>
<bin_id>12004</bin_id>
</params>
</methodcall>Response parameters
| Parameter | Data type | Description |
|---|---|---|
| bin_id | Int (1-4000000) | Identifies the Bin. |
| content | Int (0 and CONTENT_MAX) | The Bin's content. |
| target_grid | Int (1-1024) | The bin's target Grid |
Response example
<?xml version="1.0"?>
<response>
<params>
<bins>
<bin>
<bin_id>12004</bin_id>
<content>21</content>
<target_grid>1</target_grid>
</bin>
</bins>
</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. |
| 1049 | Response overflow. |
| 1055 | Parameter min_bin_id is not valid (invalid format or out of range). |
| 1056 | Parameter max_bin_id is not valid (invalid format or out of range). |
Software version requirement
Software Release October 2022 and newer
Updated 2 months ago