This documentation has moved

XML API documentation can now be found at developer.openprovider.com. This page will remain available until September 2026, but will no longer be updated.

The XML API itself is not changing. Your existing integration continues to work.

API Module Tutorial retrieveTutorialRequest

From Openprovider API documentation

Revision as of 11:16, 23 March 2012 by WikiSysop (Talk | contribs)
(diff) ← Older revision | Current revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Contents

Module Tutorials > Retrieve Product

Module Tutorials
Command name retrieveTutorialRequest
Use Returns information about a tutorial product
Input
  • id
  • withSeries (0 or 1)
Output
  • 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

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>
  <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>
Views
Personal tools