API License Module createPleskLicenseRequest

From Openprovider API documentation

Revision as of 05:22, 25 January 2013 (view source) WikiSysop (Talk | contribs) ← Older edit		Revision as of 05:35, 25 January 2013 (view source) WikiSysop (Talk | contribs) Newer edit →
Line 16:		Line 16:
	*comment		*comment
	*'''[[API Format License Options|productId]]'''		*'''[[API Format License Options|productId]]'''
-	*'''os'''
-	*version
	*'''[[API Format License Options|options]]'''		*'''[[API Format License Options|options]]'''
	|- style="vertical-align:top;"		|- style="vertical-align:top;"
Line 32:		Line 30:
	->setArgs(array(		->setArgs(array(
	'productId' => 1,		'productId' => 1,
-	'version' => 10,
-	'os' => 'windows',
	'title' => 'Linux server APOLLO',		'title' => 'Linux server APOLLO',
	'options' => array(		'options' => array(
		+	'version' => 10,
		+	'os' => 'windows',
	'domains' => 30,		'domains' => 30,
	'features' => array('POWERPACK'),		'features' => array('POWERPACK'),
Line 52:		Line 50:
	<createLicenseRequest>		<createLicenseRequest>
	<productId>1</productId>		<productId>1</productId>
-	<version>10</version>
-	<os>windows</os>
	<title>Linux server APOLLO</title>		<title>Linux server APOLLO</title>
	<options>		<options>
		+	<version>10</version>
		+	<os>windows</os>
	<domains>30</domains>		<domains>30</domains>
	<features>		<features>

---

Revision as of 05:35, 25 January 2013

Contents 1 Module Licenses > Create License 2 Examples 2.1 Using PHP class 2.2 Raw XML

Module Licenses > Create License

Module	Licenses
Command name	createLicenseRequest
Use	Order a new license
Input	title comment productId options
Output	id

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('createLicenseRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
      'productId' => 1,
      'title' => 'Linux server APOLLO',
      'options' => array(
        'version' => 10,
        'os' => 'windows',
        'domains' => 30,
        'features' => array('POWERPACK'),
        'period' => 12
      )
  ));

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>
  <createLicenseRequest>
    <productId>1</productId>
    <title>Linux server APOLLO</title>
    <options>
      <version>10</version>
      <os>windows</os>
      <domains>30</domains>
      <features>
        <array>
          <item>POWERPACK</item>
        </array>
      </features>
      <period>12</period>
    </options>
  </createLicenseRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    < code>0</code>
    <desc />
    <data>
      <id>1446</id>
    </data>
  </reply>
</openXML>