HomeInterfacesRecipesChangelogFAQ
Log In
Interfaces

Get Drawer State

🚧

Requires router software

WARNING: This feature requires router software!

Endpoint

http://<server>:44000/api/v2/bin

Request parameters

ParameterMandatory?Data typeDescription
port_idTrueInt
(1-2000)
Identifies the Port.

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>getdrawerstate</name>
  <params>
    <port_id>2</port_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>getdrawerstate</name>
  <params>
    <port_id>2</port_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>getdrawerstate</name>
  <params>
    <port_id>2</port_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>getdrawerstate</name>
  <params>
    <port_id>2</port_id>
  </params>
</methodcall>

Response parameters

ParameterData typeDescription
drawer_positionStringReturns the position of the drawer: UNKNOWN, CLOSED, OPEN.
snap_lockStringReturns the lock state of the drawer: UNKNOWN, ENABLED, DISABLED.

Response example

<?xml version="1.0"?>
<response>
  <params>
  	<drawer_position>OPEN</drawer_position>
  	<snap_lock>DISABLED</snap_lock>
  </params>
</methodcall>

OR

<?xml version="1.0"?>
<response>
  <fault>
    <code>1000</code>
  </fault>
</response>

Error Codes

Error CodeDescription
1000The specified Port is not available.
1003Mandatory parameter port_id is missing.
1004Parameter port_id is not valid (invalid format or out of range).

Software version requirement

Software Release April 2023