API Module Domain checkDomainRequest

From Openprovider API documentation

Revision as of 15:00, 22 April 2010 (view source) WikiSysop (Talk | contribs) (Created page with '==Module Domain > Check== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |domain |- style="background-color:#EEEEEE;" |'''Command name''' |check…') ← Older edit		Revision as of 15:02, 22 April 2010 (view source) WikiSysop (Talk | contribs) Newer edit →
Line 13:		Line 13:
	|'''Input'''		|'''Input'''
	|		|
-	*[[API Format Domain|domains]]	+	*'''[[API Format Domain|domains]]'''
	|- style="vertical-align:top;"		|- style="vertical-align:top;"
	|'''Output'''		|'''Output'''

---

Revision as of 15:02, 22 April 2010

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

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

<?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>
    
      0
    <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>