API Module Domain searchDomainForwardingRequest
From Openprovider API documentation
(Difference between revisions)
(→Module Domain > Search domain forwarding) |
|||
Line 26: | Line 26: | ||
===Using PHP class=== | ===Using PHP class=== | ||
$request = new OP_Request; | $request = new OP_Request; | ||
- | $request->setCommand(' | + | $request->setCommand('searchDomainForwardingRequest') |
->setAuth(array('username' => 'username', 'password' => 'password')) | ->setAuth(array('username' => 'username', 'password' => 'password')) | ||
->setArgs(array( | ->setArgs(array( | ||
'forwardFrom' => 'test.nl', | 'forwardFrom' => 'test.nl', | ||
- | |||
- | |||
- | |||
)); | )); | ||
Line 43: | Line 40: | ||
<password>password</password> | <password>password</password> | ||
</credentials> | </credentials> | ||
- | < | + | <searchDomainForwardingRequest> |
<forwardFrom>test.nl</forwardFrom> | <forwardFrom>test.nl</forwardFrom> | ||
- | + | </searchDomainForwardingRequest> | |
- | + | ||
- | + | ||
- | </ | + | |
</openXML> | </openXML> | ||
Line 57: | Line 51: | ||
<desc> | <desc> | ||
</desc> | </desc> | ||
- | <data>1</data> | + | <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> | </reply> | ||
</openXML> | </openXML> |
Revision as of 10:48, 3 November 2016
Contents |
Module Domain > Search domain forwarding
Module | domain |
Command name | searchDomainForwardingRequest |
Use | Search domain forwarding rules |
Input |
|
output |
|
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>