API Module Domain checkDomainRequest
From Openprovider API documentation
(Difference between revisions)
(→Module Domain > Check) |
m |
||
| Line 21: | Line 21: | ||
*status - free or active (indicating whether the domain is available for registration or not) | *status - free or active (indicating whether the domain is available for registration or not) | ||
*reason (if status is ''active'') | *reason (if status is ''active'') | ||
| + | *premium price - price for Create operation | ||
|} | |} | ||
| Line 69: | Line 70: | ||
</openXML> | </openXML> | ||
| - | + | <pre> | |
| - | + | <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> | ||
| + | </pre> | ||
Revision as of 04:31, 13 May 2020
Contents |
Module Domain > Check
| Module | domain |
| Command name | checkDomainRequest |
| Use | Returns the availability of one or more domain names (max 15 per request) |
| 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>
<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>