API Module SpamExperts retrieveDomainSeRequest
From Openprovider API documentation
(Difference between revisions)
(Created page with '==Module SpamExperts > Modify Domain== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |SpamExperts |- style="background-color:#EEEEEE;" |'''Comm…') |
|||
| Line 1: | Line 1: | ||
| - | ==Module SpamExperts > | + | ==Module SpamExperts > Retrieve Domain== |
{| border="1" cellpadding="4" | {| border="1" cellpadding="4" | ||
|- style="background-color:#BBBBBB;" | |- style="background-color:#BBBBBB;" | ||
| Line 13: | Line 13: | ||
|'''Input''' | |'''Input''' | ||
| | | | ||
| - | + | *domainName | |
| - | + | *bundle | |
| - | + | *withRecords | |
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
|'''Output''' | |'''Output''' | ||
| | | | ||
| - | + | *resellerId | |
| - | + | *isActive | |
| - | + | *withOutgoingFilter | |
| - | + | *domainName | |
| - | + | *userEmail | |
| - | + | *userPassword | |
| - | + | *products | |
| - | + | *expirationDate | |
| + | *records | ||
|} | |} | ||
| Line 35: | Line 36: | ||
->setAuth(array('username' => $username, 'password' => $password)) | ->setAuth(array('username' => $username, 'password' => $password)) | ||
->setArgs(array( | ->setArgs(array( | ||
| - | 'domainName' => ' | + | 'domainName' => 'filter.nl', |
| + | 'bundle' => 0, | ||
| + | 'withRecords' => 1, | ||
)); | )); | ||
| Line 47: | Line 50: | ||
</credentials> | </credentials> | ||
<retrieveDomainSeRequest> | <retrieveDomainSeRequest> | ||
| - | <domainName> | + | <domainName>filter.nl</domainName> |
</retrieveDomainSeRequest> | </retrieveDomainSeRequest> | ||
</openXML> | </openXML> | ||
| Line 57: | Line 60: | ||
<desc /> | <desc /> | ||
<data> | <data> | ||
| + | <resellerId>123456</resellerId> | ||
| + | <isActive>1</isActive> | ||
| + | <withOutgoingFilter>0</withOutgoingFilter> | ||
| + | <domainName>filter.nl</domainName> | ||
| + | <userEmail>admin@filter.nl</userEmail> | ||
| + | <userPassword>qweasdzxc</userPassword> | ||
| + | <products></products> | ||
| + | <expirationDate>2017-09-01</expirationDate> | ||
| + | <records> | ||
| + | <destinations></destinations> | ||
| + | <aliases></aliases> | ||
| + | <outgoingUserIps></outgoingUserIps> | ||
| + | </records> | ||
</data> | </data> | ||
</reply> | </reply> | ||
</openXML> | </openXML> | ||
Revision as of 04:12, 30 August 2017
Contents |
Module SpamExperts > Retrieve Domain
| Module | SpamExperts |
| Command name | retrieveDomainSeRequest |
| Use | Retrieves an existing domain filter or bundle |
| Input |
|
| Output |
|
Examples
Using PHP class
$request = new OP_Request;
$request->setCommand('retrieveDomainSeRequest')
->setAuth(array('username' => $username, 'password' => $password))
->setArgs(array(
'domainName' => 'filter.nl',
'bundle' => 0,
'withRecords' => 1,
));
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>
<retrieveDomainSeRequest>
<domainName>filter.nl</domainName>
</retrieveDomainSeRequest>
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<reply>
< code>0</code>
<desc />
<data>
<resellerId>123456</resellerId>
<isActive>1</isActive>
<withOutgoingFilter>0</withOutgoingFilter>
<domainName>filter.nl</domainName>
<userEmail>admin@filter.nl</userEmail>
<userPassword>qweasdzxc</userPassword>
<products></products>
<expirationDate>2017-09-01</expirationDate>
<records>
<destinations></destinations>
<aliases></aliases>
<outgoingUserIps></outgoingUserIps>
</records>
</data>
</reply>
</openXML>