API Module Domain searchDomainForwardingRequest

From Openprovider API documentation

(Difference between revisions)

Current revision as of 10:50, 3 November 2016

Module Domain > Search domain forwarding

Module	domain
Command name	searchDomainForwardingRequest
Use	Search domain forwarding rules
Input	forwardFrom (hostname) schemeFrom (only 'http' now) forwardTo (hostname) forwardType ('permanent'\|'temporary'\|'iframe')
output	Result set of domain forwarding details: forwardFrom schemeFrom forwardTo forwardType

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('searchDomainForwardingRequest')
 ->setAuth(array('username' => 'username', 'password' => 'password'))
 ->setArgs(array(
   'forwardFrom' => 'test.nl',
 ));

Raw XML

Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your XML command before sending it to Openprovider.

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <credentials>
    <username>username</username>
    <password>password</password>
  </credentials>
  <searchDomainForwardingRequest>
    <forwardFrom>test.nl</forwardFrom>
  </searchDomainForwardingRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    <code>0</code>
    <desc>
    </desc>
    <data>
      <results>
        <array>
          <item>
            <forwardFrom>test.nl</forwardFrom>
            <schemeFrom>http</forwardFrom>
            <forwardTo>test2.nl</forwardFrom>
           <forwardType>permanent</forwardFrom>
          </item>
        </array>
      </results>
      <total>1</total>
    </data>
  </reply>
</openXML>

@@ Line 19: / Line 19: @@
 |-
 |'''output'''
-|
+|Result set of domain forwarding details:
-*true
+*forwardFrom
+*schemeFrom
+*forwardTo
+*forwardType
 |}