License Module API retrievePleskLicenseRequest

From Openprovider API documentation

Revision as of 08:55, 11 September 2018 (view source) WikiSysop (Talk | contribs) (→Raw XML) ← Older edit		Current revision as of 08:56, 11 September 2018 (view source) WikiSysop (Talk | contribs) (→License Module > Retrieve Product)
Line 9:		Line 9:
	|-		|-
	|'''Use'''		|'''Use'''
-	|Returns details about the requested license type	+	|Returns details about the requested license
	|- style="vertical-align:top;"		|- style="vertical-align:top;"
	|'''Input'''		|'''Input'''

---

Current revision as of 08:56, 11 September 2018

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

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>