License Module API searchVirtuozzoLicenseRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(Created page with '==Module Licenses > Search Product== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |License |- style="background-color:#EEEEEE;" |'''Command na…')
(→Module Licenses > Search Product)
Line 15: Line 15:
*'''limit''' ''default value: 100''
*'''limit''' ''default value: 100''
*'''offset''' ''default value: 0''
*'''offset''' ''default value: 0''
-
*'''keyNumber''' ''search by key number e.g. 74351955''
+
*'''keyId''' ''search by key number e.g. 74351955''
*'''titlePattern''' ''search by text''
*'''titlePattern''' ''search by text''
-
*'''keyNumberPattern''' ''search by key pattern''
+
*'''keyIdPattern''' ''search by key pattern''
*'''parentKeyId''' ''search by parent license number''
*'''parentKeyId''' ''search by parent license number''
|- style="vertical-align:top;"
|- style="vertical-align:top;"
Line 23: Line 23:
|Set of license's properties
|Set of license's properties
|}
|}
 +
 +
==Examples==
 +
===Using PHP class===
 +
$request = new OP_Request;
 +
$request->setCommand('searchVirtuozzoLicenseRequest')
 +
  ->setAuth(array('username' => $username, 'password' => $password))
 +
  ->setArgs(array(
 +
    'keyId' => '74351955'
 +
));
 +
 +
===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>
 +
  < searchVirtuozzoLicenseRequest >
 +
    <keyId>74351955</keyId>
 +
  </searchPleskLicenseRequest>
 +
</openXML>
 +
 +
<?xml version="1.0" encoding="UTF-8"?>
 +
<openXML>
 +
<reply>
 +
  <nowiki><code>0</code></nowiki>
 +
  <desc>
 +
  </desc>
 +
  <data>
 +
    <results>
 +
      <array>
 +
        <item>
 +
          <title>
 +
          </title>
 +
          <comment>
 +
          </comment>
 +
          <product>virtuozzo</product>
 +
          <contract>2014</contract>
 +
          <keyId>74351955</keyId>
 +
          <parentKeyId>
 +
          </parentKeyId>
 +
          <keyNumber>VZ.74351955</keyNumber>
 +
          <billingType>lease</billingType>
 +
          <period>1</period>
 +
          <status>ACT</status>
 +
          <orderDate>2018-09-13 10:06:46</orderDate>
 +
          <expirationDate>2018-10-12 18:00:00</expirationDate>
 +
          <items>
 +
            <array>
 +
              <item>VIRTUOZZO-7-LOW-DENSITY-2CPU-1M</item>
 +
            </array>
 +
          </items>
 +
          <skuValues>
 +
            <VZ-LD-2-M>1</VZ-LD-2-M>
 +
          </skuValues>
 +
          <activationCode>A40X00-******-E0MJ35-******-M56Z55</activationCode>
 +
          <ipAddressBinding>
 +
          </ipAddressBinding>
 +
        </item>
 +
      </array>
 +
    </results>
 +
    <total>1</total>
 +
  </data>
 +
</reply>
 +
</openXML>

Revision as of 08:16, 13 September 2018

Contents

Module Licenses > Search Product

Module License
Command name searchVirtuozzoLicenseRequest
Use Returns a list of license types matching search criteria
Input
  • limit default value: 100
  • offset default value: 0
  • keyId search by key number e.g. 74351955
  • titlePattern search by text
  • keyIdPattern 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('searchVirtuozzoLicenseRequest')
  ->setAuth(array('username' => $username, 'password' => $password))
  ->setArgs(array(
    'keyId' => '74351955'
));

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>
  < searchVirtuozzoLicenseRequest >
    <keyId>74351955</keyId>
  </searchPleskLicenseRequest>
</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>74351955</keyId>
         <parentKeyId>
         </parentKeyId>
         <keyNumber>VZ.74351955</keyNumber>
         <billingType>lease</billingType>
         <period>1</period>
         <status>ACT</status>
         <orderDate>2018-09-13 10:06:46</orderDate>
         <expirationDate>2018-10-12 18:00:00</expirationDate>
         <items>
           <array>
             <item>VIRTUOZZO-7-LOW-DENSITY-2CPU-1M</item>
           </array>
         </items>
         <skuValues>
           <VZ-LD-2-M>1</VZ-LD-2-M>
         </skuValues>
         <activationCode>A40X00-******-E0MJ35-******-M56Z55</activationCode>
         <ipAddressBinding>
         </ipAddressBinding>
       </item>
     </array>
   </results>
   <total>1</total>
 </data>
</reply>
</openXML>
Retrieved from "https://doc.openprovider.eu/License_Module_API_searchVirtuozzoLicenseRequest"
Views
Personal tools