Configure Port

Endpoint

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

Request parameters

Parameter	Mandatory?	Data type	Description
port_id	True	Int (1-2000)	Identifies the Port.
configname	True	String	The name of the configuration that should be updated.
configvalue	True	String	The new value of the specified configuration.

Configuration Name	Configuration Value	Configuration Description
weight_config	0	Overload always disabled.
weight_config	1	Overload always enabled.
weight_config	2	(Deprecated) Overload disabled in picking mode
weight_config	3	No weight.
weight_config	4	Overload always enabled. Silent mode. The local port will not signal or trigger error on overload.
enableweight(Deprecated)	True	Enable the weight in the Port. (same as weight_config = 1)
enableweight(Deprecated)	False	Disable the weight in the Port. (same as weight_config = 0)
robotqueue		Integer value that specifies the maximum number of bins that could be queued towards the port.
robotqueue	-1	Clears the setting.
changeportbinqueue (Deprecated)		Same as robotqueue.
nextTaskGroupBinLookahead		Integer value that specifies the number of bins the system will use to determine when to notify about upcoming task groups for each port. This configuration is only available for the Task Interface.
nextTaskGroupBinLookahead	-1	Clears the setting.

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/bin";
//XML that will be POST'ed
string xmlData = string.Format(
@"<?xml version=""1.0""?>
<methodcall>
  <name>configureport</name>
  <params>
    <port_id>3</port_id>
    <configname>enableweight</configname>
    <configvalue>True</configvalue>
  </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>configureport</name>
  <params>
    <port_id>3</port_id>
    <configname>enableweight</configname>
    <configvalue>True</configvalue>
  </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>configureport</name>
  <params>
    <port_id>3</port_id>
    <configname>enableweight</configname>
    <configvalue>True</configvalue>
  </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>configureport</name>
  <params>
    <port_id>3</port_id>
    <configname>enableweight</configname>
    <configvalue>True</configvalue>
  </params>
</methodcall>

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.
1003	Mandatory parameter port_id is missing.
1004	Parameter port_id is not valid (invalid format or out of range).
1048	System is not available.
1084	Invalid parameter configname.
1085	Invalid parameter configvalue.

Software version requirement

Software Release October 2022 and newer