License Module API searchPleskAndVirtuozzoLicenseRequest

From Openprovider API documentation

(Difference between revisions)

Current revision as of 10:54, 5 September 2018

License Module > Search Plesk | Virtuozzo License

Module	Licenses
Command name	searchPleskAndVirtuozzoLicenseRequest
Use	Search ordered licenses based on certain criteria
Input	limit default value: 100 offset default value: 0 product plesk \| virtuozzo titlePattern text textFieldPattern text keyNumberPattern varchar parentKeyId int status ACT / DEL / EXP
Output	Result set of ordered license details: id productId mainKeyType keyNumber title comment status orderDate activeDate expirationDate options

Examples

Using PHP class

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

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>
  <searchPleskAndVirtuozzoLicenseRequest>
   <limit>1</limit>
   <offset>0</offset>
  </searchPleskAndVirtuozzoLicenseRequest >
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<reply>
 <code>0</code>
 <desc>
 </desc>
 <data>
   <results>
     <array>
       <item>
         <title>
         </title>
         <comment>
         </comment>
         <product>virtuozzo</product>
         <contract>2014</contract>
         <keyId>74350716</keyId>
         <parentKeyId>
         </parentKeyId>
         <keyNumber>PCSS.74350716</keyNumber>
         <billingType>lease</billingType>
         <period>1</period>
         <status>DEL</status>
         <orderDate>2018-08-31 10:43:01</orderDate>
         <expirationDate>0000-00-00 00:00:00</expirationDate>
         <items>
           <array>
             <item>Virtuozzo storage</item>
             <item>Monthly SUS for Virtuozzo containers/with VMs</item>
           </array>
         </items>
         <skuValues>
           <PCSS-100GB-M>1</PCSS-100GB-M>
         </skuValues>
         <activationCode>A40E00-******-ZDA035-******-A5X116</activationCode>
         <priceVersion>1</priceVersion>
       </item>
     </array>
   </results>
   <total>250</total>
 </data>
</reply>
</openXML>