API Module Domain checkDomainRequest
From Openprovider API documentation
(Difference between revisions)
(→Module Domain > Check) |
(→Module Domain > Check) |
||
| Line 14: | Line 14: | ||
| | | | ||
*'''[[API Format Domain|domains]]''' | *'''[[API Format Domain|domains]]''' | ||
| - | *[[API Format Additional Data|additionalData]] (required for checking IDN names) | + | *[[API Format Additional Data|additionalData]] (idnScript required for checking IDN names) |
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
|'''Output''' | |'''Output''' | ||
Revision as of 17:29, 8 December 2016
Contents |
Module Domain > Check
| Module | domain |
| Command name | checkDomainRequest |
| Use | Returns the availability of one or more domain names |
| Input |
|
| Output | Result set of domain availabilities:
|
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>