API Module Extension searchExtensionRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
 
(23 intermediate revisions not shown)
Line 9: Line 9:
|-
|-
|'''Use'''
|'''Use'''
-
|Returns a list of extension objects matching search criteria
+
|Returns a list of extensions (TLDs) matching search criteria
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Input'''
|'''Input'''
|
|
-
*limit
+
*[[API Format Limit|limit]]
-
*offset
+
*[[API Format Offset|offset]] (''default value: 0'')
-
*onlyNames
+
*onlyNames (use to receive only the list of TLDs in the response)
-
*withDescription
+
*withDescription (''default value: 0'')
-
*withPrice
+
*withPrice (''default value: 0'')
-
*withUsageCount
+
*withUsageCount (''default value: 0'')
 +
*extensions (provide an array of extensions to search for specific TLDs)
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Output'''
|'''Output'''
|Result set of extension details:
|Result set of extension details:
*name
*name
-
*transferAvailable
+
*minPeriod (minimum period of registration in years)
-
*isTransferAuthCodeRequired
+
*maxPeriod (maximum period of registration in years)
-
*domicileAvailable
+
*domicilePrice (if domicile service available for this TLD)
-
*usageCount
+
*createPrice (displays current base price vs reseller's Tier price for domain creation, without any other discounts)
 +
*resellerPrice (displays current domain creation price with discounts applicable to reseller (i.e. membership plan or personal promo))
 +
*renewPrice (displays current domain renewal price with discounts applicable to reseller)
 +
*transferPrice (displays current domain transfer price with discounts applicable to reseller)
 +
*restorePrice (displays current domain restore price with discounts applicable to reseller)
 +
*softRestorePrice (displays current domain restore from soft quarantine price with discounts applicable to reseller)
 +
*updatePrice (displays current domain update price with discounts applicable to reseller)
 +
*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)
 +
*quarantinePeriod (period in days that allows to restore domain after deletion)
 +
*dnssecAllowed (if DNSSEC is allowed for this TLD)
 +
*status (ACT - active, PRE - only pre-registrations available)
 +
*supportedIdnScripts (the list of supported IDN scripts)
 +
*[[API Format Price|prices]]
 +
*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 41: Line 58:
   ->setAuth(array('username' => 'username', 'password' => 'password'))
   ->setAuth(array('username' => 'username', 'password' => 'password'))
   ->setArgs(array(
   ->setArgs(array(
-
     'withUsageCount' => true
+
     'extensions' => array("ac","ae","ag")
   ));
   ));
===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>
-
    <password>password</password>
+
      <password>***</password>
   </credentials>
   </credentials>
-
   <searchextensionrequest>
+
   <searchExtensionRequest>
-
    <withusagecount>1</withusagecount>
+
      <extensions>
-
    <limit>3</limit>
+
-
  </searchextensionrequest>
+
-
</openxml>
+
-
+
-
<?xml version="1.0" encoding="UTF-8"?>
+
-
<openxml>
+
-
  <reply>
+
-
    <code>0</code>
+
-
    <desc></desc>
+
-
    <data>
+
-
      <results>
+
         <array>
         <array>
-
          <item>
+
            <item>ac</item>
-
            <name>ac</name>
+
            <item>ae</item>
-
            <transferavailable>0</transferavailable>
+
            <item>ag</item>
-
            <istransferauthcoderequired>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>
         </array>
-
      </results>
+
      </extensions>
-
      <total>117</total>
+
      <withPrice>0</withPrice>
-
    </data>
+
  </searchExtensionRequest>
 +
</openXML>
 +
 
 +
 
 +
===Response===
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<openXML>
 +
  <reply>
 +
      <code>0</code>
 +
      <desc></desc>
 +
      <data>
 +
        <results>
 +
            <array>
 +
              <item>
 +
                  <name>ac</name>
 +
                  <minPeriod>1</minPeriod>
 +
                  <maxPeriod>10</maxPeriod>
 +
                  <transferAvailable>1</transferAvailable>
 +
                  <tradeAvailable>0</tradeAvailable>
 +
                  <renewAvailable>1</renewAvailable>
 +
                  <isTransferAuthCodeRequired>yes</isTransferAuthCodeRequired>
 +
                  <isTradeAuthCodeRequired>no</isTradeAuthCodeRequired>
 +
                  <isAuthCodeRequested>0</isAuthCodeRequested>
 +
                  <isAuthCodeAvailable>1</isAuthCodeAvailable>
 +
                  <isAuthCodeChangeable>1</isAuthCodeChangeable>
 +
                  <isPrivateWhoisAllowed>0</isPrivateWhoisAllowed>
 +
                  <domicileAvailable>0</domicileAvailable>
 +
                  <softQuarantinePeriod>0</softQuarantinePeriod>
 +
                  <quarantinePeriod>0</quarantinePeriod>
 +
                  <dnssecAllowed>1</dnssecAllowed>
 +
                  <status>ACT</status>
 +
                  <supportedApplicationMode/>
 +
                  <billingHandleEnabled>0</billingHandleEnabled>
 +
                  <resellerHandleEnabled>0</resellerHandleEnabled>
 +
                  <supportedIdnScripts/>
 +
                  <ownerHandleSupported>1</ownerHandleSupported>
 +
                  <adminHandleSupported>1</adminHandleSupported>
 +
                  <techHandleSupported>1</techHandleSupported>
 +
                  <billingHandleSupported></billingHandleSupported>
 +
                  <resellerHandleSupported></resellerHandleSupported>
 +
                  <dnssecKeysAllowed>1</dnssecKeysAllowed>
 +
                  <dnssecDigestsAllowed>1</dnssecDigestsAllowed>
 +
                  <dnssecMaxRecordsAmount>0</dnssecMaxRecordsAmount>
 +
                  <dnssecAlgorithms>
 +
                    <array>
 +
                        <item>8</item>
 +
                    </array>
 +
                  </dnssecAlgorithms>
 +
              </item>
 +
              <item>
 +
                  <name>ae</name>
 +
                  <minPeriod>1</minPeriod>
 +
                  <maxPeriod>5</maxPeriod>
 +
                  <transferAvailable>1</transferAvailable>
 +
                  <tradeAvailable>0</tradeAvailable>
 +
                  <renewAvailable>1</renewAvailable>
 +
                  <isTransferAuthCodeRequired>yes</isTransferAuthCodeRequired>
 +
                  <isTradeAuthCodeRequired>no</isTradeAuthCodeRequired>
 +
                  <isAuthCodeRequested>1</isAuthCodeRequested>
 +
                  <isAuthCodeAvailable>0</isAuthCodeAvailable>
 +
                  <isAuthCodeChangeable>1</isAuthCodeChangeable>
 +
                  <isPrivateWhoisAllowed>0</isPrivateWhoisAllowed>
 +
                  <domicileAvailable>0</domicileAvailable>
 +
                  <softQuarantinePeriod>30</softQuarantinePeriod>
 +
                  <quarantinePeriod>0</quarantinePeriod>
 +
                  <dnssecAllowed>0</dnssecAllowed>
 +
                  <status>ACT</status>
 +
                  <supportedApplicationMode/>
 +
                  <billingHandleEnabled>0</billingHandleEnabled>
 +
                  <resellerHandleEnabled>0</resellerHandleEnabled>
 +
                  <supportedIdnScripts/>
 +
                  <ownerHandleSupported>1</ownerHandleSupported>
 +
                  <adminHandleSupported>1</adminHandleSupported>
 +
                  <techHandleSupported>1</techHandleSupported>
 +
                  <billingHandleSupported></billingHandleSupported>
 +
                  <resellerHandleSupported></resellerHandleSupported>
 +
              </item>
 +
              <item>
 +
                  <name>ag</name>
 +
                  <minPeriod>1</minPeriod>
 +
                  <maxPeriod>10</maxPeriod>
 +
                  <transferAvailable>1</transferAvailable>
 +
                  <tradeAvailable>0</tradeAvailable>
 +
                  <renewAvailable>1</renewAvailable>
 +
                  <isTransferAuthCodeRequired>yes</isTransferAuthCodeRequired>
 +
                  <isTradeAuthCodeRequired>no</isTradeAuthCodeRequired>
 +
                  <isAuthCodeRequested>0</isAuthCodeRequested>
 +
                  <isAuthCodeAvailable>1</isAuthCodeAvailable>
 +
                  <isAuthCodeChangeable>1</isAuthCodeChangeable>
 +
                  <isPrivateWhoisAllowed>0</isPrivateWhoisAllowed>
 +
                  <domicileAvailable>0</domicileAvailable>
 +
                  <softQuarantinePeriod>44</softQuarantinePeriod>
 +
                  <quarantinePeriod>28</quarantinePeriod>
 +
                  <dnssecAllowed>1</dnssecAllowed>
 +
                  <status>ACT</status>
 +
                  <supportedApplicationMode/>
 +
                  <billingHandleEnabled>1</billingHandleEnabled>
 +
                  <resellerHandleEnabled>0</resellerHandleEnabled>
 +
                  <supportedIdnScripts/>
 +
                  <ownerHandleSupported>1</ownerHandleSupported>
 +
                  <adminHandleSupported>1</adminHandleSupported>
 +
                  <techHandleSupported>1</techHandleSupported>
 +
                  <billingHandleSupported>1</billingHandleSupported>
 +
                  <resellerHandleSupported></resellerHandleSupported>
 +
                  <dnssecKeysAllowed>1</dnssecKeysAllowed>
 +
                  <dnssecDigestsAllowed>1</dnssecDigestsAllowed>
 +
                  <dnssecMaxRecordsAmount>0</dnssecMaxRecordsAmount>
 +
                  <dnssecAlgorithms>
 +
                    <array>
 +
                        <item>6</item>
 +
                        <item>8</item>
 +
                        <item>10</item>
 +
                        <item>12</item>
 +
                        <item>13</item>
 +
                        <item>14</item>
 +
                    </array>
 +
                  </dnssecAlgorithms>
 +
              </item>
 +
            </array>
 +
        </results>
 +
        <total>3</total>
 +
      </data>
   </reply>
   </reply>
-
  </openxml>
+
  </openXML>

Current revision as of 10:39, 1 June 2020

Contents

Module Extension > Search

Module extension
Command name searchExtensionRequest
Use Returns a list of extensions (TLDs) matching search criteria
Input
  • limit
  • offset (default value: 0)
  • onlyNames (use to receive only the list of TLDs in the response)
  • withDescription (default value: 0)
  • withPrice (default value: 0)
  • withUsageCount (default value: 0)
  • extensions (provide an array of extensions to search for specific TLDs)
Output Result set of extension details:
  • name
  • minPeriod (minimum period of registration in years)
  • maxPeriod (maximum period of registration in years)
  • domicilePrice (if domicile service available for this TLD)
  • createPrice (displays current base price vs reseller's Tier price for domain creation, without any other discounts)
  • resellerPrice (displays current domain creation price with discounts applicable to reseller (i.e. membership plan or personal promo))
  • renewPrice (displays current domain renewal price with discounts applicable to reseller)
  • transferPrice (displays current domain transfer price with discounts applicable to reseller)
  • restorePrice (displays current domain restore price with discounts applicable to reseller)
  • softRestorePrice (displays current domain restore from soft quarantine price with discounts applicable to reseller)
  • updatePrice (displays current domain update price with discounts applicable to reseller)
  • 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)
  • quarantinePeriod (period in days that allows to restore domain after deletion)
  • dnssecAllowed (if DNSSEC is allowed for this TLD)
  • status (ACT - active, PRE - only pre-registrations available)
  • supportedIdnScripts (the list of supported IDN scripts)
  • prices
  • 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('searchExtensionRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'extensions' => array("ac","ae","ag")
  ));

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>
     <password>***</password>
  </credentials>
  <searchExtensionRequest>
     <extensions>
        <array>
           <item>ac</item>
           <item>ae</item>
           <item>ag</item>
        </array>
     </extensions>
     <withPrice>0</withPrice>
  </searchExtensionRequest>
</openXML>


Response

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
     0
     <desc></desc>
     <data>
        <results>
           <array>
              <item>
                 <name>ac</name>
                 <minPeriod>1</minPeriod>
                 <maxPeriod>10</maxPeriod>
                 <transferAvailable>1</transferAvailable>
                 <tradeAvailable>0</tradeAvailable>
                 <renewAvailable>1</renewAvailable>
                 <isTransferAuthCodeRequired>yes</isTransferAuthCodeRequired>
                 <isTradeAuthCodeRequired>no</isTradeAuthCodeRequired>
                 <isAuthCodeRequested>0</isAuthCodeRequested>
                 <isAuthCodeAvailable>1</isAuthCodeAvailable>
                 <isAuthCodeChangeable>1</isAuthCodeChangeable>
                 <isPrivateWhoisAllowed>0</isPrivateWhoisAllowed>
                 <domicileAvailable>0</domicileAvailable>
                 <softQuarantinePeriod>0</softQuarantinePeriod>
                 <quarantinePeriod>0</quarantinePeriod>
                 <dnssecAllowed>1</dnssecAllowed>
                 <status>ACT</status>
                 <supportedApplicationMode/>
                 <billingHandleEnabled>0</billingHandleEnabled>
                 <resellerHandleEnabled>0</resellerHandleEnabled>
                 <supportedIdnScripts/>
                 <ownerHandleSupported>1</ownerHandleSupported>
                 <adminHandleSupported>1</adminHandleSupported>
                 <techHandleSupported>1</techHandleSupported>
                 <billingHandleSupported></billingHandleSupported>
                 <resellerHandleSupported></resellerHandleSupported>
                 <dnssecKeysAllowed>1</dnssecKeysAllowed>
                 <dnssecDigestsAllowed>1</dnssecDigestsAllowed>
                 <dnssecMaxRecordsAmount>0</dnssecMaxRecordsAmount>
                 <dnssecAlgorithms>
                    <array>
                       <item>8</item>
                    </array>
                 </dnssecAlgorithms>
              </item>
              <item>
                 <name>ae</name>
                 <minPeriod>1</minPeriod>
                 <maxPeriod>5</maxPeriod>
                 <transferAvailable>1</transferAvailable>
                 <tradeAvailable>0</tradeAvailable>
                 <renewAvailable>1</renewAvailable>
                 <isTransferAuthCodeRequired>yes</isTransferAuthCodeRequired>
                 <isTradeAuthCodeRequired>no</isTradeAuthCodeRequired>
                 <isAuthCodeRequested>1</isAuthCodeRequested>
                 <isAuthCodeAvailable>0</isAuthCodeAvailable>
                 <isAuthCodeChangeable>1</isAuthCodeChangeable>
                 <isPrivateWhoisAllowed>0</isPrivateWhoisAllowed>
                 <domicileAvailable>0</domicileAvailable>
                 <softQuarantinePeriod>30</softQuarantinePeriod>
                 <quarantinePeriod>0</quarantinePeriod>
                 <dnssecAllowed>0</dnssecAllowed>
                 <status>ACT</status>
                 <supportedApplicationMode/>
                 <billingHandleEnabled>0</billingHandleEnabled>
                 <resellerHandleEnabled>0</resellerHandleEnabled>
                 <supportedIdnScripts/>
                 <ownerHandleSupported>1</ownerHandleSupported>
                 <adminHandleSupported>1</adminHandleSupported>
                 <techHandleSupported>1</techHandleSupported>
                 <billingHandleSupported></billingHandleSupported>
                 <resellerHandleSupported></resellerHandleSupported>
              </item>
              <item>
                 <name>ag</name>
                 <minPeriod>1</minPeriod>
                 <maxPeriod>10</maxPeriod>
                 <transferAvailable>1</transferAvailable>
                 <tradeAvailable>0</tradeAvailable>
                 <renewAvailable>1</renewAvailable>
                 <isTransferAuthCodeRequired>yes</isTransferAuthCodeRequired>
                 <isTradeAuthCodeRequired>no</isTradeAuthCodeRequired>
                 <isAuthCodeRequested>0</isAuthCodeRequested>
                 <isAuthCodeAvailable>1</isAuthCodeAvailable>
                 <isAuthCodeChangeable>1</isAuthCodeChangeable>
                 <isPrivateWhoisAllowed>0</isPrivateWhoisAllowed>
                 <domicileAvailable>0</domicileAvailable>
                 <softQuarantinePeriod>44</softQuarantinePeriod>
                 <quarantinePeriod>28</quarantinePeriod>
                 <dnssecAllowed>1</dnssecAllowed>
                 <status>ACT</status>
                 <supportedApplicationMode/>
                 <billingHandleEnabled>1</billingHandleEnabled>
                 <resellerHandleEnabled>0</resellerHandleEnabled>
                 <supportedIdnScripts/>
                 <ownerHandleSupported>1</ownerHandleSupported>
                 <adminHandleSupported>1</adminHandleSupported>
                 <techHandleSupported>1</techHandleSupported>
                 <billingHandleSupported>1</billingHandleSupported>
                 <resellerHandleSupported></resellerHandleSupported>
                 <dnssecKeysAllowed>1</dnssecKeysAllowed>
                 <dnssecDigestsAllowed>1</dnssecDigestsAllowed>
                 <dnssecMaxRecordsAmount>0</dnssecMaxRecordsAmount>
                 <dnssecAlgorithms>
                    <array>
                       <item>6</item>
                       <item>8</item>
                       <item>10</item>
                       <item>12</item>
                       <item>13</item>
                       <item>14</item>
                    </array>
                 </dnssecAlgorithms>
              </item>
           </array>
        </results>
        <total>3</total>
     </data>
  </reply>
</openXML>
Retrieved from "https://doc.openprovider.eu/API_Module_Extension_searchExtensionRequest"
Views
Personal tools