API Module Extension retrieveExtensionRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 15:04, 22 July 2015

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 minPeriod maxPeriod transferAvailable tradeAvailable isTransferAuthCodeRequired isTradeAuthCodeRequired isAuthCodeRequested isAuthCodeAvailable isAuthCodeChangeable domicileAvailable quarantinePeriod dnssecAllowed status supportedIdnScripts prices usageCount description isLockingAllowed

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>

@@ Line 21: / Line 21: @@
 |Overview of extension details:
 *name
+*minPeriod
+*maxPeriod
 *transferAvailable
+*tradeAvailable
 *isTransferAuthCodeRequired
+*isTradeAuthCodeRequired
+*isAuthCodeRequested
+*isAuthCodeAvailable
+*isAuthCodeChangeable
 *domicileAvailable
+*quarantinePeriod
+*dnssecAllowed
+*status
+*supportedIdnScripts
+*[[API Format Extension Prices|prices]]
 *usageCount
 *description
-*[[API Format Extension Prices|prices]]
-*isAuthorizationCodeRequired
 *isLockingAllowed
-*isTradeAllowed
-*restorePrice
 |}