Open Port

🚧
Requires AS Router software
WARNING: Parts of this feature requires router software!

Endpoint

TASK_INTERFACE_API_ENDPOINT

Request parameters

Parameter	Mandatory?	Data type	Description
`port_id`	True	Int (1-2000)	Identifies the Port.
`category`	False	Int (1-10000000)	A collection of categories. The collection cannot contain Bin content codes as well as categories.
`content`	False	Int (0-10000000)	A collection of Bin content codes. The collection cannot contain categories as well as Bin content codes.
`req_time`	False	Date and time (Between 1971.01.01 and 2038.01.18.)	Sets the Port's `req_time` property. The `req_time` property must conform to UTC ISO 8601.
`port_mode`	False	String	Specifies a special mode of operation. Valid Port modes are `INSERT`, `OPEN`, `SWAP`, `SEQUENCE` and `RUNOUT`. Both modes `OPEN` and `SWAP` requires that the select parameter has been specified. If the `port_mode` parameter is omitted, the Port is opened in mode `OPEN` if the select parameter has been specified, or in mode `INSERT` if the select parameter has been omitted. Port mode `SEQUENCE` can only be used with AS Router software!

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>openport</name>
  <params>
    <port_id>4</port_id>
    <req_time>2008-12-12T14:00:00Z</req_time>
    <select>
      <category>1</category>
      <category>2</category>
    </select>
  </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>openport</name>
  <params>
    <port_id>4</port_id>
    <req_time>2008-12-12T14:00:00Z</req_time>
    <select>
      <category>1</category>
      <category>2</category>
    </select>
  </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>openport</name>
  <params>
    <port_id>4</port_id>
    <req_time>2008-12-12T14:00:00Z</req_time>
    <select>
      <category>1</category>
      <category>2</category>
    </select>
  </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>openport</name>
  <params>
    <port_id>4</port_id>
    <req_time>2008-12-12T14:00:00Z</req_time>
    <select>
      <category>1</category>
      <category>2</category>
    </select>
  </params>
</methodcall>

{
    "method": "openport",
    "params": {
        "port_id": 1,
      	"req_time": "2008-12-12T14:00:00Z",
        "select": 
        {
            "category": [
                1,2
            ]
        }
    }
}

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.
1002	The specified Port is already open.
1003	Mandatory parameter port_id is missing.
1004	Parameter port_id is not valid (invalid format or out of range).
1006	Parameter content is not valid (invalid format or out of range).
1007	Parameter category is not valid (invalid format or out of range).
1008	Parameter req_time is not valid (invalid format or out of range).
1048	System is not available.
1050	Too many categories or content codes.
1051	Conflicting category and content codes.

Software version requirement

Software Release October 2022 and newer