This documentation has moved

XML API documentation can now be found at developer.openprovider.com. This page will remain available until September 2026, but will no longer be updated.

The XML API itself is not changing. Your existing integration continues to work.

API Module Domain deleteDomainForwardingRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(Created page with '==Module Domain > Delete domain forwarding== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |domain |- style="background-color:#EEEEEE;" |'''Com…')
(Module Domain > Delete domain forwarding)
Line 20: Line 20:
*true
*true
|}
|}
 +
 +
==Examples==
 +
===Using PHP class===
 +
$request = new OP_Request;
 +
$request->setCommand('createDomainForwardingRequest')
 +
  ->setAuth(array('username' => 'username', 'password' => 'password'))
 +
  ->setArgs(array(
 +
    'forwardFrom' => 'test.nl',
 +
    'schemeFrom' => 'http',
 +
  ));
 +
 +
===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>
 +
  <createDomainForwardingRequest>
 +
    <forwardFrom>test.nl</forwardFrom>
 +
    <schemeFrom>http</forwardFrom>
 +
  </createDomainForwardingRequest>
 +
</openXML>
 +
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<openXML>
 +
  <reply>
 +
    <nowiki><code>0</code></nowiki>
 +
    <desc>
 +
    </desc>
 +
    <data>1</data>
 +
  </reply>
 +
</openXML>

Revision as of 10:43, 3 November 2016

Contents

Module Domain > Delete domain forwarding

Module domain
Command name deleteDomainForwardingRequest
Use Delete domain forwarding rule
Input
  • forwardFrom (hostname)
  • schemeFrom (only 'http' now)
output
  • true

Examples

Using PHP class

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

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>
  <createDomainForwardingRequest>
    <forwardFrom>test.nl</forwardFrom>
    <schemeFrom>http</forwardFrom>
  </createDomainForwardingRequest>
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    <code>0</code>
    <desc>
    </desc>
    <data>1</data>
  </reply>
</openXML>
Views
Personal tools