API Module Domain checkDomainRequest
From Openprovider API documentation
(Difference between revisions)
(Created page with '==Module Domain > Check== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |domain |- style="background-color:#EEEEEE;" |'''Command name''' |check…') |
(→Module Domain > Check) |
||
(12 intermediate revisions not shown) | |||
Line 9: | Line 9: | ||
|- | |- | ||
|'''Use''' | |'''Use''' | ||
- | |Returns the availability of one or more domain names | + | |Returns the availability of one or more domain names (max 15 per request) |
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
|'''Input''' | |'''Input''' | ||
| | | | ||
- | *[[API Format Domain|domains]] | + | *'''[[API Format Domain|domains]]''' |
+ | *[[API Format Additional Data|additionalData]] (idnScript required for checking IDN names) | ||
+ | *withPrice (Optional boolean, default false. When true, response will includes the price information for create domain operation in the account currency and the TLD currency ) | ||
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
|'''Output''' | |'''Output''' | ||
|Result set of domain availabilities: | |Result set of domain availabilities: | ||
*domain | *domain | ||
- | *status | + | *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 | ||
|} | |} | ||
Line 30: | Line 34: | ||
array( | array( | ||
'name' => 'openprovider', | 'name' => 'openprovider', | ||
- | 'extension' => ' | + | 'extension' => 'com' |
), | ), | ||
array( | array( | ||
Line 40: | Line 44: | ||
===Raw XML=== | ===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"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
- | < | + | <openXML> |
<credentials> | <credentials> | ||
<username>username</username> | <username>username</username> | ||
<password>password</password> | <password>password</password> | ||
</credentials> | </credentials> | ||
- | < | + | <checkDomainRequest> |
<domains> | <domains> | ||
<array> | <array> | ||
<item> | <item> | ||
<name>openprovider</name> | <name>openprovider</name> | ||
- | <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> | ||
</domains> | </domains> | ||
- | </ | + | </checkDomainRequest> |
- | </ | + | </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> |
Current revision as of 06:14, 5 August 2021
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>