License Module API searchPleskLicenseRequest

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''' |Licenses |- style="background-color:#EEEEEE;" |'''Command n…')
 
(11 intermediate revisions not shown)
Line 3: Line 3:
|- style="background-color:#BBBBBB;"
|- style="background-color:#BBBBBB;"
|'''Module'''
|'''Module'''
-
|Licenses
+
|License
|- style="background-color:#EEEEEE;"
|- style="background-color:#EEEEEE;"
|'''Command name'''
|'''Command name'''
-
|retrieveKeyLicenseRequest
+
|searchPleskLicenseRequest
|-
|-
|'''Use'''
|'''Use'''
-
|Returns the license key for the requested license
+
|Returns a list of license types matching search criteria
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Input'''
|'''Input'''
|
|
-
*limit ''default value: 100''
+
*'''limit''' ''default value: 100''
-
*offset ''default value: 0''
+
*'''offset''' ''default value: 0''
-
*category ''array of one or more of those categories: plesk, virtuozzo, sitebuilder''
+
*'''keyNumber''' ''search by key number e.g. PLSK.04867003''
-
*withOptions ''default value: 0''
+
*'''titlePattern''' ''search by text''
 +
*'''keyNumberPattern''' ''search by key pattern''
 +
*'''parentKeyId''' ''search by parent license number''
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Output'''
|'''Output'''
-
|Result set of license product details:
+
|Set of license's properties
-
*id
+
-
*title
+
-
*options
+
|}
|}
Line 28: Line 27:
===Using PHP class===
===Using PHP class===
  $request = new OP_Request;
  $request = new OP_Request;
-
  $request->setCommand('searchProductLicenseRequest')
+
  $request->setCommand('searchPleskLicenseRequest')
-
   ->setAuth(array('username' => 'username', 'password' => 'password'))
+
   ->setAuth(array('username' => $username, 'password' => $password))
   ->setArgs(array(
   ->setArgs(array(
-
     'withOptions' => 1,
+
     'keyNumber' => 'PLSK.04879719'
-
    'category' => 'virtuozzo'
+
));
-
  ));
+
===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 42: Line 41:
     <password>password</password>
     <password>password</password>
   </credentials>
   </credentials>
-
   <searchProductLicenseRequest>
+
   <searchPleskLicenseRequest>
-
     <withOptions>1</withOptions>
+
     <keyNumber>PLSK.04879719</keyNumber>
-
    <category>virtuozzo</category>
+
   </searchPleskLicenseRequest>
-
   </searchProductLicenseRequest>
+
  </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>9</id>
+
        <item>
-
            <title>Parallels Virtuozzo 4.0 for Linux/Unix</title>
+
          <title>Test</title>
-
            <category>virtuozzo</category>
+
          <comment>
-
            <minimalPrice>
+
          </comment>
-
              <product>
+
          <product>plesk</product>
-
                <price>12.00</price>
+
          <contract>2014</contract>
-
                <currency>EUR</currency>
+
          <keyId>4879719</keyId>
-
              </product>
+
          <parentKeyId>
-
              <reseller>
+
          </parentKeyId>
-
                <price>12.00</price>
+
          <keyNumber>PLSK.04879719</keyNumber>
-
                <currency>EUR</currency>
+
          <billingType>lease</billingType>
-
              </reseller>
+
          <period>1</period>
-
            </minimalPrice>
+
          <status>ACT</status>
-
            <options>
+
          <orderDate>2018-09-05 11:07:35</orderDate>
-
              <keyType>
+
          <expirationDate>2018-10-04 18:00:00</expirationDate>
-
                <title>Key type</title>
+
          <items>
-
                <options>
+
            <array>
-
                  <array>
+
              <item>PLESK-12-VPS-WEB-ADMIN-1M</item>
-
                    <item>
+
            </array>
-
                      <id>VIRTUOZZO4</id>
+
          </items>
-
                      <title>Parallels Virtuozzo 4.0 for Linux/Unix</title>
+
          <skuValues>
-
                    </item>
+
            <PLSKVPS-ADM-M>1</PLSKVPS-ADM-M>
-
                  </array>
+
          </skuValues>
-
                </options>
+
          <activationCode>A00F00-******-YHDH87-******-9VBS19</activationCode>
-
              </keyType>
+
          <ipAddressBinding>8.8.8.7</ipAddressBinding>
-
              <containers>
+
        </item>
-
                <title>Containers</title>
+
      </array>
-
                <options>
+
    </results>
-
                  <array>
+
    <total>1</total>
-
                    <item>
+
  </data>
-
                      <id>1</id>
+
</reply>
-
                      <title>1</title>
+
-
                    </item>
+
-
                    <item>
+
-
                      <id>3</id>
+
-
                      <title>3</title>
+
-
                    </item>
+
-
                    <item>
+
-
                      <id>10</id>
+
-
                      <title>10</title>
+
-
                    </item>
+
-
                    <item>
+
-
                      <id>20</id>
+
-
                      <title>20</title>
+
-
                    </item>
+
-
                    <item>
+
-
                      <id>30</id>
+
-
                      <title>30</title>
+
-
                    </item>
+
-
                    <item>
+
-
                      <id>50</id>
+
-
                      <title>50</title>
+
-
                    </item>
+
-
                    <item>
+
-
                      <id>60</id>
+
-
                      <title>60</title>
+
-
                    </item>
+
-
                    <item>
+
-
                      <id>70</id>
+
-
                      <title>70</title>
+
-
                    </item>
+
-
                    <item>
+
-
                      <id>100</id>
+
-
                      <title>100</title>
+
-
                    </item>
+
-
                    <item>
+
-
                      <id>300</id>
+
-
                      <title>300</title>
+
-
                    </item>
+
-
                  </array>
+
-
                </options>
+
-
              </containers>
+
-
              <features>
+
-
                <title>Application(s)</title>
+
-
                <options>
+
-
                </options>
+
-
              </features>
+
-
              <periods>
+
-
                <options>
+
-
                  <array>
+
-
                    <item>
+
-
                      <id>1</id>
+
-
                      <title>1 month</title>
+
-
                    </item>
+
-
                    <item>
+
-
                      <id>3</id>
+
-
                      <title>3 months</title>
+
-
                    </item>
+
-
                    <item>
+
-
                      <id>6</id>
+
-
                      <title>6 months</title>
+
-
                    </item>
+
-
                    <item>
+
-
                      <id>12</id>
+
-
                      <title>1 year</title>
+
-
                    </item>
+
-
                    <item>
+
-
                      <id>24</id>
+
-
                      <title>2 years</title>
+
-
                    </item>
+
-
                  </array>
+
-
                </options>
+
-
              </periods>
+
-
            </options>
+
-
          </item>
+
-
          <item>
+
-
            <id>10</id>
+
-
            <title>Parallels Virtuozzo 4.0 for Windows</title>
+
-
            <category>virtuozzo</category>
+
-
            <minimalPrice>
+
-
              <product>
+
-
                <price>12.00</price>
+
-
                <currency>EUR</currency>
+
-
              </product>
+
-
              <reseller>
+
-
                <price>12.00</price>
+
-
                <currency>EUR</currency>
+
-
              </reseller>
+
-
            </minimalPrice>
+
-
            <options>
+
-
              <keyType>
+
-
                <title>Key type</title>
+
-
                <options>
+
-
                  <array>
+
-
                    <item>
+
-
                      <id>VIRTUOZZO4WIN</id>
+
-
                      <title>Parallels Virtuozzo 4.0 for Windows</title>
+
-
                    </item>
+
-
                  </array>
+
-
                </options>
+
-
              </keyType>
+
-
              <containers>
+
-
                <title>Containers</title>
+
-
                <options>
+
-
                  <array>
+
-
                    <item>
+
-
                      <id>1</id>
+
-
                      <title>1</title>
+
-
                    </item>
+
-
                    <item>
+
-
                      <id>3</id>
+
-
                      <title>3</title>
+
-
                    </item>
+
-
                    <item>
+
-
                      <id>10</id>
+
-
                      <title>10</title>
+
-
                    </item>
+
-
                    <item>
+
-
                      <id>20</id>
+
-
                      <title>20</title>
+
-
                    </item>
+
-
                    <item>
+
-
                      <id>30</id>
+
-
                      <title>30</title>
+
-
                    </item>
+
-
                    <item>
+
-
                      <id>50</id>
+
-
                      <title>50</title>
+
-
                    </item>
+
-
                    <item>
+
-
                      <id>60</id>
+
-
                      <title>60</title>
+
-
                    </item>
+
-
                    <item>
+
-
                      <id>70</id>
+
-
                      <title>70</title>
+
-
                    </item>
+
-
                    <item>
+
-
                      <id>100</id>
+
-
                      <title>100</title>
+
-
                    </item>
+
-
                  </array>
+
-
                </options>
+
-
              </containers>
+
-
              <features>
+
-
                <title>Application(s)</title>
+
-
                <options>
+
-
                </options>
+
-
              </features>
+
-
              <periods>
+
-
                <options>
+
-
                  <array>
+
-
                    <item>
+
-
                      <id>1</id>
+
-
                      <title>1 month</title>
+
-
                    </item>
+
-
                    <item>
+
-
                      <id>3</id>
+
-
                      <title>3 months</title>
+
-
                    </item>
+
-
                    <item>
+
-
                      <id>6</id>
+
-
                      <title>6 months</title>
+
-
                    </item>
+
-
                    <item>
+
-
                      <id>12</id>
+
-
                      <title>1 year</title>
+
-
                    </item>
+
-
                    <item>
+
-
                      <id>24</id>
+
-
                      <title>2 years</title>
+
-
                    </item>
+
-
                  </array>
+
-
                </options>
+
-
              </periods>
+
-
            </options>
+
-
          </item>
+
-
        </array>
+
-
      </results>
+
-
      <total>2</total>
+
-
    </data>
+
-
  </reply>
+
  </openXML>
  </openXML>

Current revision as of 09:50, 5 September 2018

Contents

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