HomeInterfacesRecipesChangelogFAQ
Log In
Interfaces

Get Port Sequence

⚠️

Requires AS Router software.

📘

Port must to be opened in SEQUENCE mode.

Endpoint

TASK_INTERFACE_API_ENDPOINT

Request Parameters

ParameterMandatory?Data typeDescription
port_idTrueInt
(1-2000)
Identifies the Port.

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>getportsequence</name>
  <params>
    <port_id>3</port_id>
  </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>getportsequence</name>
  <params>
    <port_id>3</port_id>
  </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>getportsequence</name>
  <params>
    <port_id>3</port_id>
  </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>getportsequence</name>
  <params>
    <port_id>3</port_id>
  </params>
</methodcall>
{
    "method": "getportsequence",
    "params": {
        "port_id": 3
    }
}

Response Parameters

ParameterData typeDescription
sequenceInt
(1-2147483647)
Returns sequence of taskgroups in the port's sequence.

Response Example

<?xml version="1.0" encoding="utf-8"?>
<response>
    <params>
        <sequence>
            <taskgroup_id>6</taskgroup_id>
            <taskgroup_id>5</taskgroup_id>
            <taskgroup_id>7</taskgroup_id>
        </sequence>
    </params>
</response>

OR

<?xml version="1.0"?>
<response>
  <fault>
    <code>1000</code>
  </fault>
</response>

Error Codes

Error CodeDescription
1000The specified Port is not available.
1004Parameter port_id is not valid (invalid format or out of range).
1099The Port is not in the correct mode.

Software Version Requirement

Software Release April 2025 - Interface Version 2.5.0