License Module API searchPleskLicenseRequest

From Openprovider API documentation

(Difference between revisions)

Current revision as of 09:50, 5 September 2018

Module Licenses > Search Product

Module	License
Command name	searchPleskLicenseRequest
Use	Returns a list of license types matching search criteria
Input	limit default value: 100 offset default value: 0 keyNumber search by key number e.g. PLSK.04867003 titlePattern search by text keyNumberPattern search by key pattern parentKeyId search by parent license number
Output	Set of license's properties

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('searchPleskLicenseRequest')
  ->setAuth(array('username' => $username, 'password' => $password))
  ->setArgs(array(
    'keyNumber' => 'PLSK.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>
  <searchPleskLicenseRequest>
    <keyNumber>PLSK.04879719</keyNumber>
  </searchPleskLicenseRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<reply>
 <code>0</code>
 <desc>
 </desc>
 <data>
   <results>
     <array>
       <item>
         <title>Test</title>
         <comment>
         </comment>
         <product>plesk</product>
         <contract>2014</contract>
         <keyId>4879719</keyId>
         <parentKeyId>
         </parentKeyId>
         <keyNumber>PLSK.04879719</keyNumber>
         <billingType>lease</billingType>
         <period>1</period>
         <status>ACT</status>
         <orderDate>2018-09-05 11:07:35</orderDate>
         <expirationDate>2018-10-04 18: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>A00F00-******-YHDH87-******-9VBS19</activationCode>
         <ipAddressBinding>8.8.8.7</ipAddressBinding>
       </item>
     </array>
   </results>
   <total>1</total>
 </data>
</reply>
</openXML>

@@ Line 3: / Line 3: @@
 |- style="background-color:#BBBBBB;"
 |'''Module'''
-|Licenses
+|License
 |- style="background-color:#EEEEEE;"
 |'''Command name'''
@@ Line 21: / Line 21: @@
 |- style="vertical-align:top;"
 |'''Output'''
-|Set of license properties
+|Set of license's properties
 |}