Set Port Sequence
Requires AS Router software.
Port must to be opened inSEQUENCEmode.
Endpoint
TASK_INTERFACE_API_ENDPOINT
Request parameters
| Parameter | Mandatory? | Data type | Description |
|---|---|---|---|
port_id | True | Int (1-2000) | Identifies the Port. |
taskgroup_id | False | Int (1-2147483647) | Identifies the task group. |
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/task";
//XML that will be POST'ed
string xmlData = string.Format(
@"<?xml version=""1.0""?>
<methodcall>
<name>setportsequence</name>
<params>
<port_id>3</port_id>
<taskgroups>
<taskgroup_id>137802</taskgroup_id>
<taskgroup_id>144911</taskgroup_id>
<taskgroup_id>202554</taskgroup_id>
<taskgroup_id>162597</taskgroup_id>
</taskgroups>
</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>setportsequence</name>
<params>
<port_id>4</port_id>
<taskgroups>
<taskgroup_id>137802</taskgroup_id>
<taskgroup_id>144911</taskgroup_id>
<taskgroup_id>202554</taskgroup_id>
<taskgroup_id>162597</taskgroup_id>
</taskgroups>
</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>setportsequence</name>
<params>
<port_id>4</port_id>
<taskgroups>
<taskgroup_id>137802</taskgroup_id>
<taskgroup_id>144911</taskgroup_id>
<taskgroup_id>202554</taskgroup_id>
<taskgroup_id>162597</taskgroup_id>
</taskgroups>
</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>setportsequence</name>
<params>
<port_id>4</port_id>
<taskgroups>
<taskgroup_id>137802</taskgroup_id>
<taskgroup_id>144911</taskgroup_id>
<taskgroup_id>202554</taskgroup_id>
<taskgroup_id>162597</taskgroup_id>
</taskgroups>
</params>
</methodcall>{
"method": "setportsequence",
"params": {
"port_id": 4,
"taskgroups": [
137802,
144911,
202554,
162597
]
}
}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). |
| 1013 | Parameter taskgroup_id is not valid (invalid format or out of range). |
| 1018 | The specified task group does not exist. |
| 1044 | The task group is selected by a Port. |
| 1090 | Category conflict. |
| 1091 | The task group belongs to a shipment. |
| 1092 | The task group belongs to a sequence |
Software version requirement
Software Release April 2023
Updated about 2 months ago