Port Bin Mode

Endpoint

TASK_INTERFACE_API_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)	Identifies the Bin.
`bin_mode`	True	String	Sets the Bin mode. Can be `OPEN`, `CLOSED`, or `OUTSIDE`. Setting the Bin mode to `OUTSIDE` is only allowed if the current Bin mode is `TOGRID`.
`content`	False	Int (0-10000000)	If this parameter is not provided then the Bin's content is not changed.

Request Example

//Interface installation location(Ip adress)
string ip = "127.0.0.1";
//This method is available in both interfaces, this example uses the task interface. 
//The URL to the task interface
string url = "http://" + ip + ":44000/api/v2/task";
//The URL to the bin interface, uncomment to use 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>portbinmode</name>
  <params>
    <port_id>1</port_id>
    <bin_id>22344</bin_id>
    <bin_mode>CLOSED</bin_mode>
    <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/task"
# XML that will be POST'ed
xmlData ="""<?xml version="1.0"?>
<methodcall>
  <name>portbinmode</name>
  <params>
    <port_id>1</port_id>
    <bin_id>22344</bin_id>
    <bin_mode>CLOSED</bin_mode>
    <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/task`;
const xmlData = 
`<?xml version="1.0"?>
<methodcall>
  <name>portbinmode</name>
  <params>
    <port_id>1</port_id>
    <bin_id>22344</bin_id>
    <bin_mode>CLOSED</bin_mode>
    <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>portbinmode</name>
  <params>
    <port_id>1</port_id>
    <bin_id>22344</bin_id>
    <bin_mode>CLOSED</bin_mode>
    <content>1</content>
  </params>
</methodcall>

{
    "method": "portbinmode",
    "params": {
        "port_id": 1,
        "bin_id": 22344,
        "bin_mode": "CLOSED",
        "content": 1
    }
}

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).
1024	Mandatory parameter bin_id is missing.
1048	System is not available.
1075	Parameter bin_mode is not valid (invalid format or out of range).

Software Version Requirement

Software Release October 2022 and newer

Updated 2 months ago