API Module Domain checkDomainRequest

From Openprovider API documentation

Revision as of 11:10, 23 March 2012 (view source) WikiSysop (Talk | contribs) ← Older edit		Revision as of 08:42, 1 October 2015 (view source) WikiSysop (Talk | contribs) Newer edit →
Line 19:		Line 19:
	*domain		*domain
	*status		*status
		+	*reason (if status is ''active'')
	|}		|}
Line 30:		Line 31:
	array(		array(
	'name' => 'openprovider',		'name' => 'openprovider',
-	'extension' => 'nl'	+	'extension' => 'com'
	),		),
	array(		array(
Line 52:		Line 53:
	<item>		<item>
	<name>openprovider</name>		<name>openprovider</name>
-	<extension>nl</extension>	+	<extension>com</extension>
	</item>		</item>
	<item>		<item>
	<name>this-domain-is-free</name>		<name>this-domain-is-free</name>
	<extension>biz</extension>		<extension>biz</extension>
		+	</item>
		+	<item>
		+	<name>greece</name>
		+	<extension>guru</extension>
	</item>		</item>
	</array>		</array>
Line 74:		Line 79:
	<domain>openprovider.nl</domain>		<domain>openprovider.nl</domain>
	<status>active</status>		<status>active</status>
		+	<reason>Domain exists</reason>
	</item>		</item>
	<item>		<item>
	<domain>this-domain-is-free.biz</domain>		<domain>this-domain-is-free.biz</domain>
	<status>free</status>		<status>free</status>
		+	</item>
		+	<item>
		+	<domain>greece.guru</domain>
		+	<status>active</status>
		+	<reason>Reserved Domain Name</reason>
	</item>		</item>
	</array>		</array>

---

Revision as of 08:42, 1 October 2015

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 reason (if status is active)

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' => 'com'
      ),
      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>com</extension>
        </item>
        <item>
          <name>this-domain-is-free</name>
          <extension>biz</extension>
        </item>
        <item>
          <name>greece</name>
          <extension>guru</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>
          <reason>Domain exists</reason>
        </item>
        <item>
          <domain>this-domain-is-free.biz</domain>
          <status>free</status>
        </item>
        <item>
          <domain>greece.guru</domain>
          <status>active</status>
          <reason>Reserved Domain Name</reason>
        </item>
      </array>
    </data>
  </reply>
</openXML>