Port Location Ready
Endpoint
TASK_INTERFACE_API_ENDPOINT
or
BIN_INTERFACE_API_ENDPOINT
Request Parameters
| Parameter | Mandatory? | Data type | Description |
|---|---|---|---|
port_id | True | Int (1-2000) | Identifies the Port. |
x | True | Int (1-1024) | Specifies the x position of the announced cell. |
y | True | Int (1-1024) | Specifies the y position of the announced cell. |
getbin | False | Boolean | Specifies 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>portlocationready</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>portlocationready</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>portlocationready</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>portlocationready</name>
<params>
<port_id>1</port_id>
<x>26</x>
<y>18</y>
<getbin>1</getbin>
</params>
</methodcall>{
"method": "portlocationready",
"params": {
"port_id": 1,
"x": 26,
"y": 18,
"getbin": 0
}
}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). |
| 1009 | The Port is not open. |
| 1048 | System is not available. |
| 1066 | Mandatory parameter x is missing. |
| 1067 | Parameter x is not valid (invalid format or out of range). |
| 1068 | Mandatory parameter y is missing. |
| 1069 | Parameter y is not valid (invalid format or out of range). |
| 1070 | Mandatory parameter getbin is missing. |
| 1071 | Parameter getbin is not valid (invalid format or out of range). |
| 1072 | The specified position does not belong to the specified Port. |
Software Version Requirement
Software Release October 2022 and newer
Updated 2 months ago