From Openprovider API documentation
Module Tutorials > Search Product
| Module
| Tutorials
|
| Command name
| searchTutorialRequest
|
| Use
| Returns a list of tutorial products matching search criteria
|
| Input
|
- limit default value: 100
- offset default value: 0
- namePattern
- withSeries default value: 0
|
| Output
| Result set of tutorial product details:
- id
- name
- category
- language
- type
- seriesCount
- prices
- series (if withSeries = 1)
|
Examples
Using PHP class
$request = new OP_Request;
$request->setCommand('searchTutorialRequest')
->setAuth(array('username' => 'username', 'password' => 'password'))
->setArgs(array(
'namePattern' => '*Direct Admin*',
'withSeries' => 1,
'limit' => 2
));
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>
<searchTutorialRequest>
<namePattern>*Direct Admin*</namePattern>
<withSeries>1</withSeries>
<limit>2</limit>
</searchTutorialRequest>
</openXML>
<?xml version="1.0" encoding="UTF-8"?>
<openXML>
<reply>
< code>0</code>
<desc />
<data>
<results>
<control_panel>
<array>
<item>
<id>62</id>
<name>Direct Admin end-user series</name>
<category>control_panel</category>
<language>EN</language>
<isAvailable>1</isAvailable>
<type>normal</type>
<seriesCount>26</seriesCount>
<prices>
<sell>
<product>
<price>39.98</price>
<currency>USD</currency>
</product>
<reseller>
<price>30.57</price>
<currency>EUR</currency>
</reseller>
</sell>
</prices>
<series>
<array>
<item>
<title>How to use Installatron</title>
</item>
<item>
<title>How to setup a Cronjob</title>
</item>
<item>
<title>How to view your website statistics</title>
</item>
<item>
<title>How to install an SSL certificate</title>
</item>
<item>
<title>How to create a spam filter</title>
</item>
<item>
<title>How to use WebMail</title>
</item>
<item>
<title>How to backup your website</title>
</item>
<item>
<title>How to create additional FTP accounts</title>
</item>
<item>
<title>How to create a mailing list</title>
</item>
<item>
<title>How to use File Manager</title>
</item>
<item>
<title>How to install FrontPage extensions</title>
</item>
<item>
<title>Managing MySQL databases with PHPMyAdmin</title>
</item>
<item>
<title>How to create a MySQL database</title>
</item>
<item>
<title>How to create custom error pages</title>
</item>
<item>
<title>How to password protect a directory</title>
</item>
<item>
<title>How to change your password</title>
</item>
<item>
<title>How to create vacation messages</title>
</item>
<item>
<title>How to create an autoresponder</title>
</item>
<item>
<title>How to manage URL redirects</title>
</item>
<item>
<title>Hosting additional domains</title>
</item>
<item>
<title>How to create a domain pointer</title>
</item>
<item>
<title>How to create a subdomain</title>
</item>
<item>
<title>How to setup email forwarding</title>
</item>
<item>
<title>How to create a catch-all email account</title>
</item>
<item>
<title>How to create a POP email account</title>
</item>
<item>
<title>Navigating around in Direct Admin</title>
</item>
</array>
</series>
</item>
<item>
<id>63</id>
<name>Direct Admin reseller series</name>
<category>control_panel</category>
<language>EN</language>
<isAvailable>1</isAvailable>
<type>normal</type>
<seriesCount>15</seriesCount>
<prices>
<sell>
<product>
<price>31.98</price>
<currency>USD</currency>
</product>
<reseller>
<price>24.45</price>
<currency>EUR</currency>
</reseller>
</sell>
</prices>
<series>
<array>
<item>
<title>Administering Installatron installations</title>
</item>
<item>
<title>How to view reseller statistics</title>
</item>
<item>
<title>How to send messages to users</title>
</item>
<item>
<title>Managing support tickets</title>
</item>
<item>
<title>Managing user backups</title>
</item>
<item>
<title>How to change control panel skins</title>
</item>
<item>
<title>How to manage nameservers</title>
</item>
<item>
<title>How to manage your IP address pool</title>
</item>
<item>
<title>How to change a user's password</title>
</item>
<item>
<title>How to change your reseller password</title>
</item>
<item>
<title>How to suspend a user</title>
</item>
<item>
<title>How to create a new user</title>
</item>
<item>
<title>How to manage user packages</title>
</item>
<item>
<title>How to create a hosting package</title>
</item>
<item>
<title>Becoming familiar with Direct Admin for Resellers</title>
</item>
</array>
</series>
</item>
</array>
</control_panel>
</results>
<total>6</total>
</data>
</reply>
</openXML>