API Module Tutorial retrieveTutorialRequest

From Openprovider API documentation

---

Revision as of 09:23, 3 September 2010

Contents 1 Module Tutorials > Retrieve Product 2 Examples 2.1 Using PHP class 2.2 Raw XML

Module Tutorials > Retrieve Product

Module	Tutorials
Command name	retrieveTutorialRequest
Use	Returns information about a tutorial product
Input	id withSeries (0 or 1)
Output	The tutorial product's details: id name category language type seriesCount prices series (if withSeries = 1)

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('retrieveTutorialRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs(array(
    'id' => '62',
    'withSeries' => 0
  ));

Raw XML

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <credentials>
    <username>username</username>
    <password>password</password>
  </credentials>
  <retrieveTutorialRequest>
    <id>62</id>
    <withSeries>0</withSeries>
  </retrieveTutorialRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <reply>
    < code>0</code>
    <desc />
    <data>
      <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>
    </data>
  </reply>
</openXML>