Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents
minLevel1
maxLevel72

Protocol

The API of RPS is built as standard XML-RPC services. Two ways are possible to access the interface:

...

Are you sure you want to override MAC addresses: The MAC address has been registered by another RPS user. If you want to override it, please see more details on section 2 - redirect.registerDevice(isoverride).

1.4 Request

Code Block
languagexml
<?xml version='1.0' encoding='UTF-8'?>
<methodCall>
    <methodName>redirect.registerDevice</methodName>
    <params>
        <param>
            <value>
                <string><![CDATA[001fc1000001]]></string>
            </value>
        </param>
        <param>
            <value>
                <string><![CDATA[serverName]]></string>
            </value>
        </param>
    </params>
</methodCall>

...

3.5.1 Positive Answer

Code Block
languagexml
<?xml version="1.0" encoding="UTF-8"?>
<methodResponse xmlns:ex="http://ws.apache.org/xmlrpc/namespaces/extensions">
    <params>
        <param>
            <value>
                <array>
                    <data>
                        <value>
                            <boolean>1</boolean>
                        </value>
                        <value>OK</value>
                    </data>
                </array>
            </value>
        </param>
    </params>
</methodResponse>

...

Are you sure you want to override MAC addresses → The MAC address has been registered by another RPS user. If you want to override it, please see more details on section 7 - redirect.registerDevices(isoverride).

6.4 Request

Code Block
languagexml
<?xml version='1.0' encoding='UTF-8'?>
<methodCall>
    <methodName>redirect.registerDevices</methodName>
    <params>
        <param>
            <value>
                <array>
                    <data>
                        <value>
                            <string><![CDATA[001fc1000001]]></string>
                        </value>
                        <value>
                            <string><![CDATA[001fc1000002]]></string>
                        </value> … 
                    </data>
                </array>
            </value>
        </param>
        <param>
            <value>
                <string><![CDATA[serverName]]></string>
            </value>
        </param>
    </params>
</methodCall>

...

MAC address(es) overriding failed → Failed to override the previous MAC address

7.4 Request

Code Block
languagexml
<?xml version='1.0' encoding='UTF-8'?>
<methodCall>
    <methodName>redirect.registerDevices</methodName>
    <params>
        <param>
            <value>
                <array>
                    <data>
                        <value>
                            <string><![CDATA[001fc1000001]]></string>
                        </value>
                        <value>
                            <string><![CDATA[001fc1000002]]></string>
                        </value>
                        …
                    </data>
                </array>
            </value>
        </param>
        <param>
            <value>
                <string><![CDATA[serverName]]></string>
            </value>
        </param>
        <param>
            <value>
                <string><![CDATA[0/1]]></string>
            </value>
        </param>
    </params>
</methodCall>

...

The url can only begin with 'http://' or 'https://' or 'ftp://' or 'tftp://' → Invalid format of URL

The server name cannot be empty. → The serverName should not be empty.

...

Code Block
languagexml
<?xml version='1.0' encoding='UTF-8'?>
<methodCall>
      <methodName>redirect.addServer</methodName>
      <params>
            <param>
            <value>
                           <value>
                <string><![CDATA[serverName]]></string>
                       </value>
            </param>
            <param>
            <value>
               
            <value>
                <string><![CDATA[serverUrlserverURL]]></string>
                  </value>
            </param>
      </params>
</methodCall>

9.5 Answer

...

Are you sure you want to override MAC addresses → The MAC address has been registered by another RPS user. If you want to override it, please see more details on section 11 - redirect.editDevice(isoverride).

10.4 Request

Code Block
languagexml
<?xml version='1.0' encoding='UTF-8'?>
<methodCall>
    <methodName>redirect.editDevice</methodName>
    <params>
        <param>
            <value>
                <string><![CDATA[001fc1000001]]></string>
            </value>
        </param>
        <param>
            <value>
                <string><![CDATA[serverName]]></string>
            </value>
        </param>
    </params>
</methodCall>

...