API Module Tutorial retrieveTutorialRequest - Revision history

WikiSysop at 11:16, 23 March 2012

WikiSysop — Fri, 23 Mar 2012 11:16:44 GMT

← Older revision		Revision as of 11:16, 23 March 2012
Line 39:		Line 39:

	===Raw XML===		===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"?>		<?xml version="1.0" encoding="UTF-8"?>
	<openXML>		<openXML>

WikiSysop at 09:26, 3 September 2010

WikiSysop — Fri, 03 Sep 2010 09:26:07 GMT

← Older revision		Revision as of 09:26, 3 September 2010
Line 17:		Line 17:
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"
	\|'''Output'''		\|'''Output'''
-	\|~~The tutorial product's details:~~	+	\|
	*id		*id
	*name		*name

WikiSysop at 09:24, 3 September 2010

WikiSysop — Fri, 03 Sep 2010 09:24:37 GMT

← Older revision		Revision as of 09:24, 3 September 2010
Line 13:		Line 13:
	\|'''Input'''		\|'''Input'''
	\|		\|
-	*id	+	*'''id'''
	*withSeries (0 or 1)		*withSeries (0 or 1)
	\|- style="vertical-align:top;"		\|- style="vertical-align:top;"

WikiSysop: Created page with '==Module Tutorials > Retrieve Product== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |Tutorials |- style="background-color:#EEEEEE;" |'''Comma…'

WikiSysop — Fri, 03 Sep 2010 09:23:20 GMT

Created page with '==Module Tutorials > Retrieve Product== {| border="1" cellpadding="4" |- style="background-color:#BBBBBB;" |'''Module''' |Tutorials |- style="background-color:#EEEEEE;" |'''Comma…'

New page

==Module Tutorials > Retrieve Product==
{| border="1" cellpadding="4"
|- style="background-color:#BBBBBB;"
|'''Module'''
|Tutorials
|- style="background-color:#EEEEEE;"
|'''Command name'''
|retrieveTutorialRequest
|-
|'''Use'''
|Returns information about a tutorial product
|- style="vertical-align:top;"
|'''Input'''
|
*id
*withSeries (0 or 1)
|- style="vertical-align:top;"
|'''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>