API Module Extension searchExtensionRequest
From Openprovider API documentation
(Difference between revisions)
(→Module Extension > Search) |
(→Module Extension > Search) |
||
| Line 15: | Line 15: | ||
*[[API Format Limit|limit]] (''default value: 100, maximum value: 1000'') | *[[API Format Limit|limit]] (''default value: 100, maximum value: 1000'') | ||
*[[API Format Offset|offset]] (''default value: 0'') | *[[API Format Offset|offset]] (''default value: 0'') | ||
| - | *onlyNames | + | *onlyNames (use to receive only the list of TLDs in the response) |
| - | *withDescription ''default value: 0'' | + | *withDescription (''default value: 0'') |
| - | *withPrice ''default value: 0'' | + | *withPrice (''default value: 0'') |
| - | *withUsageCount ''default value: 0'' | + | *withUsageCount (''default value: 0'') |
|- style="vertical-align:top;" | |- style="vertical-align:top;" | ||
|'''Output''' | |'''Output''' | ||
|Result set of extension details: | |Result set of extension details: | ||
*name | *name | ||
| + | *minPeriod (minimum period of registration in years) | ||
| + | *maxPeriod (maximum period of registration in years) | ||
*transferAvailable | *transferAvailable | ||
| - | *isTransferAuthCodeRequired | + | *isTransferAuthCodeRequired (if transfer is done via authorization code) |
| - | *domicileAvailable | + | *domicileAvailable (if domicile \ trustee service could be used for TLD) |
| - | *usageCount | + | *usageCount (to show number of domains with such TLD in the account) |
*description | *description | ||
*[[API Format Extension Prices|prices]] | *[[API Format Extension Prices|prices]] | ||
| - | + | *isLockingAllowed (if TLD supports 'theft protection') | |
| - | *isLockingAllowed | + | |
*isTradeAllowed | *isTradeAllowed | ||
| - | * | + | *isPrivateWhoisAllowed |
| + | *dnssecAllowed | ||
|} | |} | ||
Revision as of 10:27, 17 June 2016
Contents |
Module Extension > Search
| Module | extension |
| Command name | searchExtensionRequest |
| Use | Returns a list of extension objects matching search criteria |
| Input | |
| Output | Result set of extension details:
|
Examples
Using PHP class
$request = new OP_Request;
$request->setCommand('searchExtensionRequest')
->setAuth(array('username' => 'username', 'password' => 'password'))
->setArgs(array(
'withUsageCount' => true
));
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>
<searchExtensionRequest>
<withUsageCount>1</withUsageCount>
<limit>3</limit>
</searchExtensionRequest>
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<reply>
< code>0</code>
<desc></desc>
<data>
<results>
<array>
<item>
<name>ac</name>
<transferAvailable>0</transferAvailable>
<isRransferAuthCodeRequired>0</isTransferAuthCodeRequired>
<domicileAvailable>0</domicileAvailable>
</item>
<item>
<name>ae</name>
<transferAvailable>1</transferAvailable>
<isTransferAuthCodeRequired>1</isTransferAuthCodeRequired>
<domicileAvailable>0</domicileAvailable>
</item>
<item>
<name>ag</name>
<transferAvailable>0</transferAvailable>
<isTransferAuthCodeRequired>1</isTransferAuthCodeRequired>
<domicileAvailable>0</domicileAvailable>
</item>
</array>
</results>
<total>117</total>
</data>
</reply>
</openXML>