API Module Domain deleteDomainForwardingRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(Module Domain > Delete domain forwarding)
(Examples)
 
Line 24: Line 24:
===Using PHP class===
===Using PHP class===
  $request = new OP_Request;
  $request = new OP_Request;
-
  $request->setCommand('createDomainForwardingRequest')
+
  $request->setCommand('deleteDomainForwardingRequest')
   ->setAuth(array('username' => 'username', 'password' => 'password'))
   ->setAuth(array('username' => 'username', 'password' => 'password'))
   ->setArgs(array(
   ->setArgs(array(
Line 39: Line 39:
     <password>password</password>
     <password>password</password>
   </credentials>
   </credentials>
-
   <createDomainForwardingRequest>
+
   <deleteDomainForwardingRequest>
     <forwardFrom>test.nl</forwardFrom>
     <forwardFrom>test.nl</forwardFrom>
     <schemeFrom>http</forwardFrom>
     <schemeFrom>http</forwardFrom>
-
   </createDomainForwardingRequest>
+
   </deleteDomainForwardingRequest>
  </openXML>
  </openXML>

Current revision as of 10:45, 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('deleteDomainForwardingRequest')
 ->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>
  <deleteDomainForwardingRequest>
    <forwardFrom>test.nl</forwardFrom>
    <schemeFrom>http</forwardFrom>
  </deleteDomainForwardingRequest>
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    <code>0</code>
    <desc>
    </desc>
    <data>1</data>
  </reply>
</openXML>
Views
Personal tools