API Module Extension retrieveExtensionRequest

From Openprovider API documentation

Contents 1 Module Extension > Retrieve 2 Examples 2.1 Using PHP class 2.2 Raw XML

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