API Module Extension retrieveExtensionRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 11:12, 23 March 2012

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

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

@@ Line 45: / Line 45: @@
 ===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>