License Module API searchPleskAndVirtuozzoLicenseRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
(Created page with '==Module Licenses > Search License== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |Licenses |- style="background-color:#EEEEEE;" |'''Command nā€¦')
(ā†’Raw XML)
 
(5 intermediate revisions not shown)
Line 1: Line 1:
-
==Module Licenses > Search License==
+
==License Module > Search Plesk | Virtuozzo License==
{| border="1" cellpadding="4"
{| border="1" cellpadding="4"
|- style="background-color:#BBBBBB;"
|- style="background-color:#BBBBBB;"
Line 6: Line 6:
|- style="background-color:#EEEEEE;"
|- style="background-color:#EEEEEE;"
|'''Command name'''
|'''Command name'''
-
|searchLicenseRequest
+
|searchPleskAndVirtuozzoLicenseRequest
|-
|-
|'''Use'''
|'''Use'''
Line 13: Line 13:
|'''Input'''
|'''Input'''
|
|
-
*limit ''default value: 100''
+
*'''limit''' ''default value: 100''
-
*offset ''default value: 0''
+
*'''offset''' ''default value: 0''
-
*productId
+
*'''product''' ''plesk | virtuozzo''
-
*titlePattern
+
*'''titlePattern''' ''text''
 +
*'''textFieldPattern''' ''text''
 +
*'''keyNumberPattern''' ''varchar''
 +
*'''parentKeyId''' ''int''
 +
*'''status''' ''ACT / DEL / EXP''
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Output'''
|'''Output'''
Line 36: Line 40:
===Using PHP class===
===Using PHP class===
  $request = new OP_Request;
  $request = new OP_Request;
-
  $request->setCommand('searchLicenseRequest')
+
  $request->setCommand('searchPleskAndVirtuozzoLicenseRequest')
   ->setAuth(array('username' => 'username', 'password' => 'password'))
   ->setAuth(array('username' => 'username', 'password' => 'password'))
   ->setArgs(array(
   ->setArgs(array(
Line 42: Line 46:
===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 48: Line 53:
     <password>password</password>
     <password>password</password>
   </credentials>
   </credentials>
-
   <searchLicenseRequest />
+
   <searchPleskAndVirtuozzoLicenseRequest>
 +
    <limit>1</limit>
 +
    <offset>0</offset>
 +
  </searchPleskAndVirtuozzoLicenseRequest >
  </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>
-
      <results>
+
  <data>
-
        <array>
+
    <results>
-
          <item>
+
      <array>
-
            <id>1446</id>
+
        <item>
-
            <productId>4</productId>
+
          <title>
-
            <mainKeyType>PLESK9WIN</mainKeyType>
+
          </title>
-
            <keyNumber>PLSK.01489424</keyNumber>
+
          <comment>
-
            <title>Linux server APOLLO</title>
+
          </comment>
-
            <comment>
+
          <product>virtuozzo</product>
-
            </comment>
+
          <contract>2014</contract>
-
            <period>12</period>
+
          <keyId>74350716</keyId>
-
            <status>ACT</status>
+
          <parentKeyId>
-
            <orderDate>2010-12-02 15:01:25</orderDate>
+
          </parentKeyId>
-
            <expirationDate>2011-12-02 15:01:25</expirationDate>
+
          <keyNumber>PCSS.74350716</keyNumber>
-
            <activeDate>2010-12-02 15:01:25</activeDate>
+
          <billingType>lease</billingType>
-
            <options>
+
          <period>1</period>
-
              <features>
+
          <status>DEL</status>
-
                <array>
+
          <orderDate>2018-08-31 10:43:01</orderDate>
-
                  <item>POWERPACK</item>
+
          <expirationDate>0000-00-00 00:00:00</expirationDate>
-
                </array>
+
          <items>
-
              </features>
+
            <array>
-
              <domains>30</domains>
+
              <item>Virtuozzo storage</item>
-
              <period>12</period>
+
              <item>Monthly SUS for Virtuozzo containers/with VMs</item>
-
              <keyType>PLESK9WIN</keyType>
+
            </array>
-
            </options>
+
          </items>
-
          </item>
+
          <skuValues>
-
        </array>
+
            <PCSS-100GB-M>1</PCSS-100GB-M>
-
      </results>
+
          </skuValues>
-
      <total>1</total>
+
          <activationCode>A40E00-******-ZDA035-******-A5X116</activationCode>
-
    </data>
+
          <priceVersion>1</priceVersion>
-
  </reply>
+
        </item>
 +
      </array>
 +
    </results>
 +
    <total>250</total>
 +
  </data>
 +
</reply>
  </openXML>
  </openXML>

Current revision as of 10:54, 5 September 2018

Contents

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>
Retrieved from "https://doc.openprovider.eu/License_Module_API_searchPleskAndVirtuozzoLicenseRequest"
Views
Personal tools