API Module Extension retrieveExtensionRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
Line 39: Line 39:
   ->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',
   ));
   ));
Line 53: Line 53:
   </credentials>
   </credentials>
   <retrieveExtensionRequest>
   <retrieveExtensionRequest>
-
     <withDescription>0</withDescription>
+
     <withPrice>1</withPrice>
-
    <withDiscounts>1</withDiscounts>
+
     <name>co.uk</name>
     <name>co.uk</name>
   </retrieveExtensionRequest>
   </retrieveExtensionRequest>
Line 62: Line 61:
  <openXML>
  <openXML>
   <reply>
   <reply>
-
     < code>0</code>
+
     <code >0</code>
     <desc></desc>
     <desc></desc>
     <data>
     <data>
       <name>co.uk</name>
       <name>co.uk</name>
 +
      <minPeriod>2</minPeriod>
 +
      <maxPeriod>10</maxPeriod>
       <transferAvailable>1</transferAvailable>
       <transferAvailable>1</transferAvailable>
-
       <isTransferAuthCodeRequired>0</isTransferAuthCodeRequired>
+
       <tradeAvailable>0</tradeAvailable>
 +
      <isTransferAuthCodeRequired>no</isTransferAuthCodeRequired>
 +
      <isTradeAuthCodeRequired>no</isTradeAuthCodeRequired>
 +
      <isAuthCodeRequested>0</isAuthCodeRequested>
 +
      <isAuthCodeAvailable>0</isAuthCodeAvailable>
 +
      <isAuthCodeChangeable>0</isAuthCodeChangeable>
 +
      <isPrivateWhoisAllowed>0</isPrivateWhoisAllowed>
       <domicileAvailable>0</domicileAvailable>
       <domicileAvailable>0</domicileAvailable>
-
       <usageCount>0</usageCount>
+
       <quarantinePeriod>0</quarantinePeriod>
 +
      <dnssecAllowed>0</dnssecAllowed>
 +
      <status>ACT</status>
 +
      <supportedApplicationMode />
 +
      <billingHandleEnabled>0</billingHandleEnabled>
 +
      <resellerHandleEnabled>0</resellerHandleEnabled>
 +
      <supportedIdnScripts />
       <prices>
       <prices>
-
        <setupPrice>0</setupPrice>
 
-
        <domicilePrice>0</domicilePrice>
 
         <minPeriod>2</minPeriod>
         <minPeriod>2</minPeriod>
-
         <maxPeriod>2</maxPeriod>
+
         <maxPeriod>10</maxPeriod>
-
         <resellerPrice>10.00</resellerPrice>
+
         <setupPrice>
-
         <prices>
+
          <product>
-
           <array>
+
            <price>0.00</price>
-
             <item>
+
            <currency>GBP</currency>
-
              <price>10.00</price>
+
          </product>
-
              <startBound>1</startBound>
+
          <reseller>
-
              <finishBound>24</finishBound>
+
            <price>0.00</price>
-
             </item>
+
            <currency>EUR</currency>
-
             <item>
+
          </reseller>
-
              <price>9.50</price>
+
         </setupPrice>
-
              <startBound>25</startBound>
+
        <domicilePrice>
-
              <finishBound>49</finishBound>
+
           <product>
-
             </item>
+
             <price>0.00</price>
-
             <item>
+
            <currency>GBP</currency>
-
              <price>9.00</price>
+
          </product>
-
              <startBound>50</startBound>
+
          <reseller>
-
              <finishBound>149</finishBound>
+
            <price>0.00</price>
-
             </item>
+
            <currency>EUR</currency>
-
             <item>
+
          </reseller>
-
              <price>8.50</price>
+
        </domicilePrice>
-
              <startBound>150</startBound>
+
        <createPrice>
-
              <finishBound>0</finishBound>
+
          <product>
-
             </item>
+
             <price>3.95</price>
-
           </array>
+
             <currency>GBP</currency>
-
         </prices>
+
          </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>
       </prices>
     </data>
     </data>
   </reply>
   </reply>
  </openXML>
  </openXML>

Revision as of 15:00, 22 July 2015

Contents

Module Extension > Retrieve

Module extension
Command name retrieveExtensionRequest
Use Retrieves information about a specified extension
Input
  • name
  • withDescription
  • withPrice
  • withUsageCount
Output Overview of extension details:
  • name
  • transferAvailable
  • isTransferAuthCodeRequired
  • domicileAvailable
  • usageCount
  • description
  • prices
  • isAuthorizationCodeRequired
  • isLockingAllowed
  • isTradeAllowed
  • restorePrice

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>
    0
    <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>
      <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