API Module Domain checkDomainRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 11:10, 23 March 2012

Module Domain > Check

Module	domain
Command name	checkDomainRequest
Use	Returns the availability of one or more domain names
Input	domains
Output	Result set of domain availabilities: domain status

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('checkDomainRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'domains' => array(
      array(
        'name' => 'openprovider',
        'extension' => 'nl'
      ),
      array(
        'name' => 'this-domain-is-free',
        'extension' => 'biz'
      )
    )
  ));

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>
  <checkDomainRequest>
    <domains>
      <array>
        <item>
          <name>openprovider</name>
          <extension>nl</extension>
        </item>
        <item>
          <name>this-domain-is-free</name>
          <extension>biz</extension>
        </item>
      </array>
    </domains>
  </checkDomainRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    < code>0</code>
    <desc>
    </desc>
    <data>
      <array>
        <item>
          <domain>openprovider.nl</domain>
          <status>active</status>
        </item>
        <item>
          <domain>this-domain-is-free.biz</domain>
          <status>free</status>
        </item>
      </array>
    </data>
  </reply>
</openXML>

@@ Line 40: / Line 40: @@
 ===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>