API Module Extension retrieveExtensionRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
Line 46: Line 46:
===Raw XML===
===Raw XML===
   <?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>
+
     <withDescription>0</withDescription>
-
     <withdiscounts>1</withdiscounts>
+
     <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>
+
     < code>0</code>
     <desc></desc>
     <desc></desc>
     <data>
     <data>
       <name>co.uk</name>
       <name>co.uk</name>
-
       <transferavailable>1</transferavailable>
+
       <transferAvailable>1</transferAvailable>
-
       <istransferauthcoderequired>0</istransferauthcoderequired>
+
       <isTransferAuthCodeRequired>0</isTransferAuthCodeRequired>
-
       <domicileavailable>0</domicileavailable>
+
       <domicileAvailable>0</domicileAvailable>
-
       <usagecount>0</usagecount>
+
       <usageCount>0</usageCount>
       <prices>
       <prices>
-
         <setupprice>0</setupprice>
+
         <setupPrice>0</setupPrice>
-
         <domicileprice>0</domicileprice>
+
         <domicilePrice>0</domicilePrice>
-
         <minperiod>2</minperiod>
+
         <minPeriod>2</minPeriod>
-
         <maxperiod>2</maxperiod>
+
         <maxPeriod>2</maxPeriod>
-
         <resellerprice>10.00</resellerprice>
+
         <resellerPrice>10.00</resellerPrice>
         <prices>
         <prices>
           <array>
           <array>
             <item>
             <item>
               <price>10.00</price>
               <price>10.00</price>
-
               <startbound>1</startbound>
+
               <startBound>1</startBound>
-
               <finishbound>24</finishbound>
+
               <finishBound>24</finishBound>
             </item>
             </item>
             <item>
             <item>
               <price>9.50</price>
               <price>9.50</price>
-
               <startbound>25</startbound>
+
               <startBound>25</startBound>
-
               <finishbound>49</finishbound>
+
               <finishBound>49</finishBound>
             </item>
             </item>
             <item>
             <item>
               <price>9.00</price>
               <price>9.00</price>
-
               <startbound>50</startbound>
+
               <startBound>50</startBound>
-
               <finishbound>149</finishbound>
+
               <finishBound>149</finishBound>
             </item>
             </item>
             <item>
             <item>
               <price>8.50</price>
               <price>8.50</price>
-
               <startbound>150</startbound>
+
               <startBound>150</startBound>
-
               <finishbound>0</finishbound>
+
               <finishBound>0</finishBound>
             </item>
             </item>
           </array>
           </array>
Line 102: Line 102:
     </data>
     </data>
   </reply>
   </reply>
-
  </openxml>
+
  </openXML>

Revision as of 13:52, 1 July 2010

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(
    'withDescription' => 0,
    'withDiscounts' => 0,
    'name' => 'co.uk',
  ));

Raw XML

 <?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <credentials>
    <username>username</username>
    <password>password</password>
  </credentials>
  <retrieveExtensionRequest>
    <withDescription>0</withDescription>
    <withDiscounts>1</withDiscounts>
    <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>
      <transferAvailable>1</transferAvailable>
      <isTransferAuthCodeRequired>0</isTransferAuthCodeRequired>
      <domicileAvailable>0</domicileAvailable>
      <usageCount>0</usageCount>
      <prices>
        <setupPrice>0</setupPrice>
        <domicilePrice>0</domicilePrice>
        <minPeriod>2</minPeriod>
        <maxPeriod>2</maxPeriod>
        <resellerPrice>10.00</resellerPrice>
        <prices>
          <array>
            <item>
              <price>10.00</price>
              <startBound>1</startBound>
              <finishBound>24</finishBound>
            </item>
            <item>
              <price>9.50</price>
              <startBound>25</startBound>
              <finishBound>49</finishBound>
            </item>
            <item>
              <price>9.00</price>
              <startBound>50</startBound>
              <finishBound>149</finishBound>
            </item>
            <item>
              <price>8.50</price>
              <startBound>150</startBound>
              <finishBound>0</finishBound>
            </item>
          </array>
        </prices>
      </prices>
    </data>
  </reply>
</openXML>
Retrieved from "https://doc.openprovider.eu/API_Module_Extension_retrieveExtensionRequest"
Views
Personal tools