API Module SpamExperts retrieveDomainSeRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 04:40, 30 August 2017

Module SpamExperts > Retrieve Domain

Module	SpamExperts
Command name	retrieveDomainSeRequest
Use	Retrieves an existing domain filter or bundle
Input	domainName bundle withRecords
Output	resellerId isActive withOutgoingFilter domainName userEmail userPassword products expirationDate records

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>
      <smtpPassword></smtpPassword>
      <products>
        <incoming>1</incoming>
        <outgoing>0</outgoing>
        <archiving>1</archiving>
      </products>
      <expirationDate>2017-09-01</expirationDate>
      <records>
        <destinations>
          <array>
            <item>
              <hostname>mbox001.filter.nl</hostname>
              <port>25</port>
            </item>
          </array>
        </destinations>
        <aliases/>
        <outgoingUserIps/>
      </records>
    </data>
  </reply>
</openXML>