API Module Domain checkDomainRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 06:14, 5 August 2021

Module Domain > Check

Module	domain
Command name	checkDomainRequest
Use	Returns the availability of one or more domain names (max 15 per request)
Input	domains additionalData (idnScript required for checking IDN names) withPrice Optional boolean, default false. (Includes the price information for create domain operation in the account currency and the TLD currency )
Output	Result set of domain availabilities: domain status - free or active (indicating whether the domain is available for registration or not) reason (if status is active) premium create price - price for Create operation if the domain is reported as a premium one

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>

<openXML>
<reply>
<code>0</code>
<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>
			<premium>
				<price>
					<create>75</create>
				</price>
			</premium>
		</item>
		<item>
			<domain>greece.guru</domain>
			<status>active</status>
			<reason>Reserved Domain Name</reason>
		</item>
	</array>
</data>
</reply>
</openXML>

@@ Line 15: / Line 15: @@
 *'''[[API Format Domain|domains]]'''
 *[[API Format Additional Data|additionalData]] (idnScript required for checking IDN names)
-*withPrice  Optional boolean, default false. Includes the price information for create domain operation in the account currency and the TLD currency )
+*withPrice  Optional boolean, default false. (Includes the price information for create domain operation in the account currency and the TLD currency )
 |- style="vertical-align:top;"
 |'''Output'''