API Module SpamExperts retrieveDomainSeRequest

From Openprovider API documentation

Revision as of 04:41, 30 August 2017 (view source) WikiSysop (Talk | contribs) (→Module SpamExperts > Retrieve Domain) ← Older edit		Current revision as of 04:42, 30 August 2017 (view source) WikiSysop (Talk | contribs) (→Raw XML)
Line 52:		Line 52:
	<retrieveDomainSeRequest>		<retrieveDomainSeRequest>
	<domainName>filter.nl</domainName>		<domainName>filter.nl</domainName>
		+	<withRecords>1</withRecords>
	</retrieveDomainSeRequest>		</retrieveDomainSeRequest>
	</openXML>		</openXML>

---

Current revision as of 04:42, 30 August 2017

Contents 1 Module SpamExperts > Retrieve Domain 2 Examples 2.1 Using PHP class 2.2 Raw XML

Module SpamExperts > Retrieve Domain

Module	SpamExperts
Command name	retrieveDomainSeRequest
Use	Retrieves an existing domain filter or bundle
Input	domainName bundle (obsolete: used for old SE bundles) withRecords
Output	resellerId isActive withOutgoingFilter domainName userEmail userPassword smtpPassword 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>
    <withRecords>1</withRecords>
  </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>