HomeInterfacesRecipesChangelogFAQ
Log In
Interfaces

Port Cell Allocate

Endpoint

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

or

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

Request parameters

ParameterMandatory?Data typeDescription
port_idTrueInt
(1-2000)
Identifies the Port.
xTrueInt
(1-1024)
Specifies the X position of the announced cell.
yTrueInt
(1-1024)
Specifies the Y position of the announced cell.
getbinFalseBooleanSpecifies if a Bin should be fetched from the cell. Default false.

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>portcellallocate</name>
  <params>
    <port_id>1</port_id>
    <x>26</x>
    <y>18</y>
    <getbin>1</getbin>
  </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>portcellallocate</name>
  <params>
    <port_id>1</port_id>
    <x>26</x>
    <y>18</y>
    <getbin>1</getbin>
  </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>portcellallocate</name>
  <params>
    <port_id>1</port_id>
    <x>26</x>
    <y>18</y>
    <getbin>1</getbin>
  </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>portcellallocate</name>
  <params>
    <port_id>1</port_id>
    <x>26</x>
    <y>18</y>
    <getbin>1</getbin>
  </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 CodeDescription
1000The specified Port is not available.
1001The specified Port is closing.
1003Mandatory parameter port_id is missing.
1004Parameter port_id is not valid (invalid format or out of range).
1009The Port is not open.
1048System is not available.
1066Mandatory parameter x is missing.
1067Parameter x is not valid (invalid format or out of range).
1068Mandatory parameter y is missing.
1069Parameter y is not valid (invalid format or out of range).
1070Mandatory parameter getbin is missing.
1071Parameter getbin is not valid (invalid format or out of range).
1072The specified position does not belong to the specified Port.
1074Location is ready. The message portlocationready has been sent. Before sending the next portcellallocate for the same cell, the Bin must be confirmed in the Port (confirmation from Log Publisher).

Software version requirement

Software Release October 2022 and newer