License Module API searchPleskAndVirtuozzoLicenseRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 10:44, 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('searchLicenseRequest')
  ->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>
  <searchLicenseRequest />
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    < code>0</code>
    <desc />
    <data>
      <results>
        <array>
          <item>
            <id>1446</id>
            <productId>4</productId>
            <mainKeyType>PLESK9WIN</mainKeyType>
            <keyNumber>PLSK.01489424</keyNumber>
            <title>Linux server APOLLO</title>
            <comment>
            </comment>
            <period>12</period>
            <status>ACT</status>
            <orderDate>2010-12-02 15:01:25</orderDate>
            <expirationDate>2011-12-02 15:01:25</expirationDate>
            <activeDate>2010-12-02 15:01:25</activeDate>
            <options>
              <features>
                <array>
                  <item>POWERPACK</item>
                </array>
              </features>
              <domains>30</domains>
              <period>12</period>
              <keyType>PLESK9WIN</keyType>
            </options>
          </item>
        </array>
      </results>
      <total>1</total>
    </data>
  </reply>
</openXML>

@@ Line 1: / Line 1: @@
-==Module Licenses > Search License==
+==License Module > Search Plesk | Virtuozzo License==
 {| border="1" cellpadding="4"
 |- style="background-color:#BBBBBB;"
@@ Line 6: / Line 6: @@
 |- style="background-color:#EEEEEE;"
 |'''Command name'''
-|searchLicenseRequest
+|searchPleskAndVirtuozzoLicenseRequest
 |-
 |'''Use'''
@@ Line 13: / Line 13: @@
 |'''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;"
 |'''Output'''