API License Module deletePleskLicenseRequest

From Openprovider API documentation

(Difference between revisions)
Jump to: navigation, search
Line 1: Line 1:
-
==Module Licenses > Delete License==
+
== License Module > Delete 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'''
-
|deleteLicenseRequest
+
|deletePleskLicenseRequest
|-
|-
|'''Use'''
|'''Use'''
Line 13: Line 13:
|'''Input'''
|'''Input'''
|
|
-
*'''id'''
+
*'''keyId'''
|- style="vertical-align:top;"
|- style="vertical-align:top;"
|'''Output'''
|'''Output'''
Line 23: Line 23:
===Using PHP class===
===Using PHP class===
  $request = new OP_Request;
  $request = new OP_Request;
-
  $request->setCommand('deleteLicenseRequest')
+
  $request->setCommand('deletePleskLicenseRequest')
   ->setAuth(array('username' => 'username', 'password' => 'password'))
   ->setAuth(array('username' => 'username', 'password' => 'password'))
   ->setArgs(array(
   ->setArgs(array(
-
       'id' => 1446,
+
       'keyId' => 1446,
   ));
   ));
Line 37: Line 37:
     <password>password</password>
     <password>password</password>
   </credentials>
   </credentials>
-
   <deleteLicenseRequest>
+
   <deletePleskLicenseRequest>
-
     <id>1446</id>
+
     <keyId>1446</keyId>
-
   </deleteLicenseRequest>
+
   </deletePleskLicenseRequest>
  </openXML>
  </openXML>
Line 45: Line 45:
  <openXML>
  <openXML>
   <reply>
   <reply>
-
     < code>0</code>
+
     <nowiki><code>0</code></nowiki>
     <desc />
     <desc />
     <data>1</data>
     <data>1</data>
   </reply>
   </reply>
  </openXML>
  </openXML>

Revision as of 08:51, 11 September 2018

Contents

License Module > Delete License

Module Licenses
Command name deletePleskLicenseRequest
Use Deletes (terminate) an existing license
Input
  • keyId
Output

-

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('deletePleskLicenseRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
      'keyId' => 1446,
  ));

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>
  <deletePleskLicenseRequest>
    <keyId>1446</keyId>
  </deletePleskLicenseRequest>
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    <code>0</code>
    <desc />
    <data>1</data>
  </reply>
</openXML>
Views
Personal tools