API Module Domain checkDomainRequest

From Openprovider API documentation

Revision as of 15:02, 22 April 2010 (view source) WikiSysop (Talk | contribs) ← Older edit		Revision as of 13:45, 1 July 2010 (view source) WikiSysop (Talk | contribs) Newer edit →
Line 41:		Line 41:
	===Raw XML===		===Raw XML===
	<?xml version="1.0" encoding="UTF-8"?>		<?xml version="1.0" encoding="UTF-8"?>
-	<openxml>	+	<openXML>
	<credentials>		<credentials>
	<username>username</username>		<username>username</username>
	<password>password</password>		<password>password</password>
	</credentials>		</credentials>
-	<checkdomainrequest>	+	<checkDomainRequest>
	<domains>		<domains>
	<array>		<array>
Line 59:		Line 59:
	</array>		</array>
	</domains>		</domains>
-	</checkdomainrequest>	+	</checkDomainRequest>
-	</openxml>	+	</openXML>
	<?xml version="1.0" encoding="UTF-8"?>		<?xml version="1.0" encoding="UTF-8"?>
-	<openxml>	+	<openXML>
	<reply>		<reply>
-	<code>	+	< code>0</code>
-	0</code>	+
	<desc>		<desc>
	</desc>		</desc>
Line 82:		Line 81:
	</data>		</data>
	</reply>		</reply>
-	</openxml>	+	</openXML>

---

Revision as of 13:45, 1 July 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>
    < 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>