License Module API retrievePleskLicenseRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(Created page with '==Module Licenses > Retrieve Product== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |Licenses |- style="background-color:#EEEEEE;" |'''Command…')
(→License Module > Retrieve Product)
 
(14 intermediate revisions not shown)
Line 1: Line 1:
-
==Module Licenses > Retrieve Product==
+
==License Module > Retrieve Product==
{| border="1" cellpadding="4"
{| border="1" cellpadding="4"
|- style="background-color:#BBBBBB;"
|- style="background-color:#BBBBBB;"
|'''Module'''
|'''Module'''
-
|Licenses
+
|License
|- style="background-color:#EEEEEE;"
|- style="background-color:#EEEEEE;"
|'''Command name'''
|'''Command name'''
-
|retrieveProductLicenseRequest
+
|retrievePleskLicenseRequest
|-
|-
|'''Use'''
|'''Use'''
-
|Returns the license key for the requested license
+
|Returns details about the requested license
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Input'''
|'''Input'''
|
|
-
*'''id'''
+
*'''keyId'''
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Output'''
|'''Output'''
Line 25: Line 25:
===Using PHP class===
===Using PHP class===
  $request = new OP_Request;
  $request = new OP_Request;
-
  $request->setCommand('retrieveProductLicenseRequest')
+
  $request->setCommand('retrievePleskLicenseRequest')
   ->setAuth(array('username' => 'username', 'password' => 'password'))
   ->setAuth(array('username' => 'username', 'password' => 'password'))
   ->setArgs(array(
   ->setArgs(array(
-
       'id' => 4,
+
       'keyId' => 04879719,
   ));
   ));
===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>
Line 38: Line 39:
     <password>password</password>
     <password>password</password>
   </credentials>
   </credentials>
-
   <retrieveProductLicenseRequest>
+
   <retrievePleskLicenseRequest>
-
     <id>4</id>
+
     <keyId>04867003</keyId >
-
   </retrieveProductLicenseRequest>
+
   </retrievePleskLicenseRequest>
  </openXML>
  </openXML>
  <?xml version="1.0" encoding="UTF-8"?>
  <?xml version="1.0" encoding="UTF-8"?>
  <openXML>
  <openXML>
-
  <reply>
+
<reply>
-
    < code>0</code>
+
  <nowiki><code>0</code></nowiki>
-
    <desc />
+
  <desc>
-
    <data>
+
  </desc>
-
      <id>4</id>
+
  <data>
-
      <title>Parallels Plesk Control Panel 9.x for Windows</title>
+
    <title>test</title>
-
      <category>plesk</category>
+
    <comment>comment</comment>
-
      <minimalPrice>
+
    <product>plesk</product>
-
        <product>
+
    <contract>2014</contract>
-
          <price>4.50</price>
+
    <keyId>4867003</keyId>
-
          <currency>EUR</currency>
+
    <parentKeyId>
-
        </product>
+
    </parentKeyId>
-
        <reseller>
+
    <keyNumber>PLSK.04867003</keyNumber>
-
          <price>4.50</price>
+
    <billingType>lease</billingType>
-
          <currency>EUR</currency>
+
    <period>1</period>
-
        </reseller>
+
    <status>DEL</status>
-
      </minimalPrice>
+
    <orderDate>2018-08-28 07:18:54</orderDate>
-
      <options>
+
    <expirationDate>0000-00-00 00:00:00</expirationDate>
-
        <keyType>
+
    <items>
-
          <title>Key type</title>
+
      <array>
-
          <options>
+
        <item>PLESK-12-VPS-WEB-ADMIN-1M</item>
-
            <array>
+
      </array>
-
              <item>
+
    </items>
-
                <id>PLESK9WIN</id>
+
    <skuValues>
-
                <title>Parallels Plesk Control Panel 9.x for Windows</title>
+
      <PLSKVPS-ADM-M>1</PLSKVPS-ADM-M>
-
              </item>
+
    </skuValues>
-
            </array>
+
    <activationCode>A00B00-******-4MDN86-******-DVE103</activationCode>
-
          </options>
+
    <ipAddressBinding>127.0.0.33</ipAddressBinding>
-
        </keyType>
+
    <key>
-
        <domains>
+
      <product>plesk</product>
-
          <title>Number of domains</title>
+
      <title>Plesk for VPS Web Admin Edition</title>
-
          <options>
+
      <item>PLESK-12-VPS-WEB-ADMIN-1M</item>
-
            <array>
+
      <group>
-
              <item>
+
        <product>plesk</product>
-
                <id>10</id>
+
        <name>plesk-12-onyx-keys</name>
-
                <title>10</title>
+
        <description>Plesk 12/Onyx keys</description>
-
              </item>
+
        <itemsType>key</itemsType>
-
              <item>
+
      </group>
-
                <id>30</id>
+
      <subgroup>
-
                <title>30</title>
+
        <id>
-
              </item>
+
        </id>
-
              <item>
+
        <title>
-
                <id>100</id>
+
        </title>
-
                <title>100</title>
+
      </subgroup>
-
              </item>
+
      <compatibility>
-
              <item>
+
        <vps>1</vps>
-
                <id>300</id>
+
        <standalone>0</standalone>
-
                <title>300</title>
+
      </compatibility>
-
              </item>
+
      <skuValues>
-
              <item>
+
        <PLSKVPS-ADM-M>1</PLSKVPS-ADM-M>
-
                <id>UNLIMITED</id>
+
      </skuValues>
-
                <title>Unlimited</title>
+
    </key>
-
              </item>
+
    <features/>
-
            </array>
+
    <extensions/>
-
          </options>
+
  </data>
-
        </domains>
+
</reply>
-
        <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>
  </openXML>

Current revision as of 08:56, 11 September 2018

Contents

License Module > Retrieve Product

Module License
Command name retrievePleskLicenseRequest
Use Returns details about the requested license
Input
  • keyId
Output
  • id
  • title
  • options

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('retrievePleskLicenseRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
      'keyId' => 04879719,
  ));

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>
  <retrievePleskLicenseRequest>
    <keyId>04867003</keyId >
  </retrievePleskLicenseRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<reply>
 <code>0</code>
 <desc>
 </desc>
 <data>
   <title>test</title>
   <comment>comment</comment>
   <product>plesk</product>
   <contract>2014</contract>
   <keyId>4867003</keyId>
   <parentKeyId>
   </parentKeyId>
   <keyNumber>PLSK.04867003</keyNumber>
   <billingType>lease</billingType>
   <period>1</period>
   <status>DEL</status>
   <orderDate>2018-08-28 07:18:54</orderDate>
   <expirationDate>0000-00-00 00:00:00</expirationDate>
   <items>
     <array>
       <item>PLESK-12-VPS-WEB-ADMIN-1M</item>
     </array>
   </items>
   <skuValues>
     <PLSKVPS-ADM-M>1</PLSKVPS-ADM-M>
   </skuValues>
   <activationCode>A00B00-******-4MDN86-******-DVE103</activationCode>
   <ipAddressBinding>127.0.0.33</ipAddressBinding>
   <key>
     <product>plesk</product>
     <title>Plesk for VPS Web Admin Edition</title>
     <item>PLESK-12-VPS-WEB-ADMIN-1M</item>
     <group>
       <product>plesk</product>
       <name>plesk-12-onyx-keys</name>
       <description>Plesk 12/Onyx keys</description>
       <itemsType>key</itemsType>
     </group>
     <subgroup>
       <id>
       </id>
       <title>
       </title>
     </subgroup>
     <compatibility>
       <vps>1</vps>
       <standalone>0</standalone>
     </compatibility>
     <skuValues>
       <PLSKVPS-ADM-M>1</PLSKVPS-ADM-M>
     </skuValues>
   </key>
   <features/>
   <extensions/>
 </data>
</reply>
</openXML>
Retrieved from "https://doc.openprovider.eu/License_Module_API_retrievePleskLicenseRequest"
Views
Personal tools