API Module Email Templates deleteEmailTemplateRequest

From Openprovider API documentation

Revision as of 13:49, 17 September 2015 (view source) WikiSysop (Talk | contribs) (→Raw XML) ← Older edit		Current revision as of 12:27, 17 June 2016 (view source) WikiSysop (Talk | contribs) (→Module Email Templates > Delete)
(2 intermediate revisions not shown)
Line 9:		Line 9:
	|-		|-
	|'''Use'''		|'''Use'''
-	|Deletes an email template.	+	|Delete existing email template
	|- style="vertical-align:top;"		|- style="vertical-align:top;"
	|'''Input'''		|'''Input'''
Line 42:		Line 42:
	</deleteEmailTemplateRequest>		</deleteEmailTemplateRequest>
	</openXML>		</openXML>
		+
		+
		+	<?xml version="1.0" encoding="UTF-8"?>
		+	<openXML>
		+	<reply>
		+	<nowiki><code>0</code></nowiki>
		+	<desc></desc>
		+	<data>1</data>
		+	</reply>
		+	</openXML>

---

Current revision as of 12:27, 17 June 2016

Contents 1 Module Email Templates > Delete 2 Examples 2.1 Using PHP class 2.2 Raw XML

Module Email Templates > Delete

Module	Email Templates
Command name	deleteEmailTemplateRequest
Use	Delete existing email template
Input	id
Output	-

Examples

Using PHP class

$request = new OP_Request; 
$request->setCommand('createEmailTemplateRequest')
   ->setAuth(array('username' => 'username', 'password' => 'password'))
   ->setArgs([
       'id' => 1409,
     ]);

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>
 <deleteEmailTemplateRequest>
   <id>1404</id>   
 </deleteEmailTemplateRequest>
</openXML>

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