API Module Domain createDomainForwardingRequest
From Openprovider API documentation
(Difference between revisions)
(→Module Domain > Create domain forwarding) |
|||
| Line 16: | Line 16: | ||
*schemeFrom (only 'http' now) | *schemeFrom (only 'http' now) | ||
*forwardTo (hostname) | *forwardTo (hostname) | ||
| - | *forwardType ('permanent'|'temporary'|'iframe') | + | *[[API Format forwardType|forwardType]] ('permanent'|'temporary'|'iframe') |
|- | |- | ||
|'''output''' | |'''output''' | ||
Revision as of 16:38, 13 December 2016
Contents |
Module Domain > Create domain forwarding
| Module | domain |
| Command name | createDomainForwardingRequest |
| Use | Create domain forwarding rule |
| Input |
|
| output |
|
Examples
Using PHP class
$request = new OP_Request;
$request->setCommand('createDomainForwardingRequest')
->setAuth(array('username' => 'username', 'password' => 'password'))
->setArgs(array(
'forwardFrom' => 'test.nl',
'schemeFrom' => 'http',
'forwardTo' => 'test2.nl',
'forwardType' => 'permanent',
));
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>
<forwardTo>test2.nl</forwardFrom>
<forwardType>permanent</forwardFrom>
</createDomainForwardingRequest>
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<reply>
<code>0</code>
<desc>
</desc>
<data>1</data>
</reply>
</openXML>