This documentation has moved

XML API documentation can now be found at developer.openprovider.com. This page will remain available until September 2026, but will no longer be updated.

The XML API itself is not changing. Your existing integration continues to work.

Go to the new documentation

API Module Extension retrieveExtensionRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(→Module Extension > Retrieve)
 
(15 intermediate revisions not shown)
Line 9: Line 9:
|-
|-
|'''Use'''
|'''Use'''
-
|Retrieves information about a specified extension
+
|Retrieves information about specific extension (TLD)
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Input'''
|'''Input'''
Line 21: Line 21:
|Overview of extension details:
|Overview of extension details:
*name
*name
-
*transferAvailable
+
*minPeriod (minimum period of registration in years)
-
*isTransferAuthCodeRequired
+
*maxPeriod (maximum period of registration in years)
-
*domicileAvailable
+
*transferAvailable (if transfer is available for this TLD)
-
*usageCount
+
*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)
 +
*[[API Format Price|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
*description
-
*[[API Format Extension Prices|prices]]
+
*isPrivateWhoisAllowed (if Whois Privacy Protection could be enabled on domains registered in this TLD)
-
*isAuthorizationCodeRequired
+
-
*isLockingAllowed
+
-
*isTradeAllowed
+
-
*restorePrice
+
|}
|}
Line 39: Line 49:
   ->setAuth(array('username' => 'username', 'password' => 'password'))
   ->setAuth(array('username' => 'username', 'password' => 'password'))
   ->setArgs(array(
   ->setArgs(array(
 +
    'withPrice' => 1,
     'withDescription' => 0,
     'withDescription' => 0,
-
    'withDiscounts' => 0,
 
     'name' => 'co.uk',
     'name' => 'co.uk',
   ));
   ));
===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>
+
  <openXML>
   <credentials>
   <credentials>
     <username>username</username>
     <username>username</username>
     <password>password</password>
     <password>password</password>
   </credentials>
   </credentials>
-
   <retrieveextensionrequest>
+
   <retrieveExtensionRequest>
-
     <withdescription>0</withdescription>
+
     <withPrice>1</withPrice>
-
    <withdiscounts>1</withdiscounts>
+
     <name>co.uk</name>
     <name>co.uk</name>
-
   </retrieveextensionrequest>
+
   </retrieveExtensionRequest>
-
  </openxml>
+
  </openXML>
   
   
  <?xml version="1.0" encoding="UTF-8"?>
  <?xml version="1.0" encoding="UTF-8"?>
-
  <openxml>
+
  <openXML>
   <reply>
   <reply>
-
     <code>0</code>
+
     <nowiki><code>0</code></nowiki>
     <desc></desc>
     <desc></desc>
     <data>
     <data>
       <name>co.uk</name>
       <name>co.uk</name>
-
       <transferavailable>1</transferavailable>
+
       <minPeriod>2</minPeriod>
-
       <istransferauthcoderequired>0</istransferauthcoderequired>
+
      <maxPeriod>10</maxPeriod>
-
       <domicileavailable>0</domicileavailable>
+
      <transferAvailable>1</transferAvailable>
-
       <usagecount>0</usagecount>
+
       <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>
       <prices>
-
         <setupprice>0</setupprice>
+
         <minPeriod>2</minPeriod>
-
         <domicileprice>0</domicileprice>
+
         <maxPeriod>10</maxPeriod>
-
         <minperiod>2</minperiod>
+
        <setupPrice>
-
         <maxperiod>2</maxperiod>
+
          <product>
-
         <resellerprice>10.00</resellerprice>
+
            <price>0.00</price>
-
         <prices>
+
            <currency>GBP</currency>
-
           <array>
+
          </product>
-
             <item>
+
          <reseller>
-
              <price>10.00</price>
+
            <price>0.00</price>
-
              <startbound>1</startbound>
+
            <currency>EUR</currency>
-
              <finishbound>24</finishbound>
+
          </reseller>
-
             </item>
+
         </setupPrice>
-
             <item>
+
        <domicilePrice>
-
              <price>9.50</price>
+
          <product>
-
              <startbound>25</startbound>
+
            <price>0.00</price>
-
              <finishbound>49</finishbound>
+
            <currency>GBP</currency>
-
             </item>
+
          </product>
-
             <item>
+
          <reseller>
-
              <price>9.00</price>
+
            <price>0.00</price>
-
              <startbound>50</startbound>
+
            <currency>EUR</currency>
-
              <finishbound>149</finishbound>
+
          </reseller>
-
             </item>
+
         </domicilePrice>
-
             <item>
+
        <createPrice>
-
              <price>8.50</price>
+
          <product>
-
              <startbound>150</startbound>
+
            <price>3.95</price>
-
              <finishbound>0</finishbound>
+
            <currency>GBP</currency>
-
             </item>
+
          </product>
-
           </array>
+
          <reseller>
-
         </prices>
+
            <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>
       </prices>
     </data>
     </data>
   </reply>
   </reply>
-
  </openxml>
+
  </openXML>

Current revision as of 05:19, 22 April 2020

Contents

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>
Retrieved from "https://doc.openprovider.eu/API_Module_Extension_retrieveExtensionRequest"
Views
Personal tools