Set Port Queue

Endpoint

BIN_INTERFACE_API_ENDPOINT

Request parameters

Parameter	Mandatory?	Data type	Description
`port_id`	True	Int (1-2000)	Identifies the Port.
`bin_id`	False	Int (1-4000000)	Identifies the Bin.
`content`	False	Int (0-10000000)	Specifies a content code. The sequence of the bin_id and content elements specify the Bin sequence.
`begingroup`	False	boolean	Starts a group in the Port queue.
`endgroup`	False	boolean	Ends a group in the Port queue.

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>setportqueue</name>
  <params>
    <port_id>4</port_id>
    <bins>
      <bin_id>35432</bin_id>
      <begingroup/>
      <bin_id>20443</bin_id>
      <bin_id>34813</bin_id>
      <endgroup/>
      <bin_id>40602</bin_id>
      <bin_id>45977</bin_id>
    </bins>
  </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>setportqueue</name>
  <params>
    <port_id>4</port_id>
    <bins>
      <bin_id>35432</bin_id>
      <begingroup/>
      <bin_id>20443</bin_id>
      <bin_id>34813</bin_id>
      <endgroup/>
      <bin_id>40602</bin_id>
      <bin_id>45977</bin_id>
    </bins>
  </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>setportqueue</name>
  <params>
    <port_id>4</port_id>
    <bins>
      <bin_id>35432</bin_id>
      <begingroup/>
      <bin_id>20443</bin_id>
      <bin_id>34813</bin_id>
      <endgroup/>
      <bin_id>40602</bin_id>
      <bin_id>45977</bin_id>
    </bins>
  </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>setportqueue</name>
  <params>
    <port_id>4</port_id>
    <bins>
      <bin_id>35432</bin_id>
      <begingroup/>
      <bin_id>20443</bin_id>
      <bin_id>34813</bin_id>
      <endgroup/>
      <bin_id>40602</bin_id>
      <bin_id>45977</bin_id>
    </bins>
  </params>
</methodcall>

{
    "method": "setportqueue",
    "params": {
        "port_id": 2,
        "queue": [
            {
                "type": "bin_id",
                "value": 35432
            },
            {
                "type": "begingroup"
            },
            {
                "type": "bin_id",
                "value": 20443
            },
            {
                "type": "bin_id",
                "value": 34813
            },
            {
                "type": "endgroup"
            },
            {
                "type": "bin_id",
                "value": 40602
            },
            {
                "type": "bin_id",
                "value": 45977
            }
        ]
    }
}

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
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).
1010	Parameter bin_id is not valid (invalid format or out of range).
1011	The specified Bin does not exist.
1048	System is not available.
1062	Port queue is full. The maximum size of a port's port queue is 1000 bins.

Software version requirement

Software Release October 2022 and newer