From Openprovider API documentation
Module Extension > Retrieve
| Module
| extension
|
| Command name
| retrieveExtensionRequest
|
| Use
| Retrieves information about specific extension (TLD)
|
| Input
|
- name
- withDescription
- withPrice
- withUsageCount
|
| Output
| Overview of extension details:
- name
- minPeriod (minimum period of registration in years)
- maxPeriod (maximum period of registration in years)
- transferAvailable (if transfer is available for this TLD)
- tradeAvailable (if trade is available for this TLD)
- isTransferAuthCodeRequired (if transfer is done via authorization code)
- isTradeAuthCodeRequired (if trade is done via authorization code)
- isAuthCodeRequested (if authorization code could be requested from registry via e-mail)
- isAuthCodeAvailable (if authorization code is available immediately on demand)
- isAuthCodeChangeable (if authorization code could be changed via API call)
- domicileAvailable (if domicile \ trustee service could be used for TLD)
- softQuarantinePeriod (period in days that allows to restore an expired domain w/o additional fees)
- quarantinePeriod (period in days that allows to restore a deleted domain with additional fees)
- dnssecAllowed (if DNSSEC is allowed for this TLD)
- dnssecAlgorithms (array with allowed algorithms)
- status (ACT - active, PRE - only pre-registrations available)
- supportedIdnScripts (the list of supported IDN scripts)
- prices (createPrice block shows tier price, resellerPrice block shows current price based on memberships and promotions)
- usageCount (to show number of domains with such TLD in the account)
- description
- isPrivateWhoisAllowed (if Whois Privacy Protection could be enabled on domains registered in this TLD)
|
Examples
Using PHP class
$request = new OP_Request;
$request->setCommand('retrieveExtensionRequest')
->setAuth(array('username' => 'username', 'password' => 'password'))
->setArgs(array(
'withPrice' => 1,
'withDescription' => 0,
'name' => 'co.uk',
));
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>
<retrieveExtensionRequest>
<withPrice>1</withPrice>
<name>co.uk</name>
</retrieveExtensionRequest>
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<reply>
<code>0</code>
<desc></desc>
<data>
<name>co.uk</name>
<minPeriod>2</minPeriod>
<maxPeriod>10</maxPeriod>
<transferAvailable>1</transferAvailable>
<tradeAvailable>0</tradeAvailable>
<isTransferAuthCodeRequired>no</isTransferAuthCodeRequired>
<isTradeAuthCodeRequired>no</isTradeAuthCodeRequired>
<isAuthCodeRequested>0</isAuthCodeRequested>
<isAuthCodeAvailable>0</isAuthCodeAvailable>
<isAuthCodeChangeable>0</isAuthCodeChangeable>
<isPrivateWhoisAllowed>0</isPrivateWhoisAllowed>
<domicileAvailable>0</domicileAvailable>
<quarantinePeriod>0</quarantinePeriod>
<dnssecAllowed>0</dnssecAllowed>
<dnssecAlgorithms>
<array>
<item>3</item>
<item>5</item>
<item>6</item>
<item>7</item>
<item>8</item>
<item>10</item>
<item>12</item>
<item>13</item>
</array>
</dnssecAlgorithms>
<status>ACT</status>
<supportedApplicationMode />
<billingHandleEnabled>0</billingHandleEnabled>
<resellerHandleEnabled>0</resellerHandleEnabled>
<supportedIdnScripts />
<prices>
<minPeriod>2</minPeriod>
<maxPeriod>10</maxPeriod>
<setupPrice>
<product>
<price>0.00</price>
<currency>GBP</currency>
</product>
<reseller>
<price>0.00</price>
<currency>EUR</currency>
</reseller>
</setupPrice>
<domicilePrice>
<product>
<price>0.00</price>
<currency>GBP</currency>
</product>
<reseller>
<price>0.00</price>
<currency>EUR</currency>
</reseller>
</domicilePrice>
<createPrice>
<product>
<price>3.95</price>
<currency>GBP</currency>
</product>
<reseller>
<price>5.65</price>
<currency>EUR</currency>
</reseller>
</createPrice>
<resellerPrice>
<product>
<price>3.95</price>
<currency>GBP</currency>
</product>
<reseller>
<price>5.65</price>
<currency>EUR</currency>
</reseller>
</resellerPrice>
<renewPrice>
<product>
<price>3.95</price>
<currency>GBP</currency>
</product>
<reseller>
<price>5.65</price>
<currency>EUR</currency>
</reseller>
</renewPrice>
<transferPrice>
<product>
<price>0.00</price>
<currency>GBP</currency>
</product>
<reseller>
<price>0.00</price>
<currency>EUR</currency>
</reseller>
</transferPrice>
<restorePrice>
<product>
<price>0.00</price>
<currency>GBP</currency>
</product>
<reseller>
<price>0.00</price>
<currency>EUR</currency>
</reseller>
</restorePrice>
<softRestorePrice>
<product>
<price>0.00</price>
<currency>GBP</currency>
</product>
<reseller>
<price>0.00</price>
<currency>EUR</currency>
</reseller>
</softRestorePrice>
<updatePrice>
<product>
<price>0.00</price>
<currency>GBP</currency>
</product>
<reseller>
<price>0.00</price>
<currency>EUR</currency>
</reseller>
</updatePrice>
</prices>
</data>
</reply>
</openXML>