License Module API retrievePleskLicenseRequest

From Openprovider API documentation

Revision as of 15:04, 2 December 2010 (view source) WikiSysop (Talk | contribs) ← Older edit		Revision as of 11:14, 23 March 2012 (view source) WikiSysop (Talk | contribs) Newer edit →
Line 32:		Line 32:
	===Raw XML===		===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"?>		<?xml version="1.0" encoding="UTF-8"?>
	<openXML>		<openXML>

---

Revision as of 11:14, 23 March 2012

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

Module Licenses > Retrieve Product

Module	Licenses
Command name	retrieveProductLicenseRequest
Use	Returns details about the requested license type
Input	id
Output	id title options

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('retrieveProductLicenseRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
      'id' => 4,
  ));

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>
  <retrieveProductLicenseRequest>
    <id>4</id>
  </retrieveProductLicenseRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    < code>0</code>
    <desc />
    <data>
      <id>4</id>
      <title>Parallels Plesk Control Panel 9.x for Windows</title>
      <category>plesk</category>
      <minimalPrice>
        <product>
          <price>4.50</price>
          <currency>EUR</currency>
        </product>
        <reseller>
          <price>4.50</price>
          <currency>EUR</currency>
        </reseller>
      </minimalPrice>
      <options>
        <keyType>
          <title>Key type</title>
          <options>
            <array>
              <item>
                <id>PLESK9WIN</id>
                <title>Parallels Plesk Control Panel 9.x for Windows</title>
              </item>
            </array>
          </options>
        </keyType>
        <domains>
          <title>Number of domains</title>
          <options>
            <array>
              <item>
                <id>10</id>
                <title>10</title>
              </item>
              <item>
                <id>30</id>
                <title>30</title>
              </item>
              <item>
                <id>100</id>
                <title>100</title>
              </item>
              <item>
                <id>300</id>
                <title>300</title>
              </item>
              <item>
                <id>UNLIMITED</id>
                <title>Unlimited</title>
              </item>
            </array>
          </options>
        </domains>
        <langPacks>
          <title>Number of language packs</title>
          <options>
            <array>
              <item>
                <id>none</id>
                <title>none</title>
              </item>
              <item>
                <id>1</id>
                <title>1</title>
              </item>
              <item>
                <id>2</id>
                <title>2</title>
              </item>
              <item>
                <id>3</id>
                <title>3</title>
              </item>
              <item>
                <id>4</id>
                <title>4</title>
              </item>
              <item>
                <id>5</id>
                <title>5</title>
              </item>
            </array>
          </options>
        </langPacks>
        <features>
          <title>Application(s)</title>
          <options>
            <array>
              <item>
                <id>POWERPACK</id>
                <title>Plesk(TM) Power Pack</title>
              </item>
              <item>
                <id>DRWEB</id>
                <title>Plesk(TM) Anti-Virus by Dr.Web</title>
              </item>
              <item>
                <id>SPAMASSASSIN</id>
                <title>SpamAssassin</title>
              </item>
            </array>
          </options>
        </features>
        <periods>
          <options>
            <array>
              <item>
                <id>1</id>
                <title>1 month</title>
              </item>
              <item>
                <id>3</id>
                <title>3 months</title>
              </item>
              <item>
                <id>6</id>
                <title>6 months</title>
              </item>
              <item>
                <id>12</id>
                <title>1 year</title>
              </item>
              <item>
                <id>24</id>
                <title>2 years</title>
              </item>
            </array>
          </options>
        </periods>
      </options>
    </data>
  </reply>
</openXML>