API Module Email Templates searchEmailTemplateRequest

From Openprovider API documentation

Revision as of 13:20, 17 September 2015 (view source) WikiSysop (Talk | contribs) (→Raw XML) ← Older edit		Revision as of 13:54, 12 October 2015 (view source) WikiSysop (Talk | contribs) (→Module Email Templates > Search) Newer edit →
Line 16:		Line 16:
	*name		*name
	*group ('ive'| TBD)		*group ('ive'| TBD)
		+	*[[API Format tags|tags]]
	*limit ''default value: 100''		*limit ''default value: 100''
	*offset ''default value: 0''		*offset ''default value: 0''

---

Revision as of 13:54, 12 October 2015

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

Module Email Templates > Search

Module	Email Templates
Command name	searchEmailTemplateRequest
Use	Returns a list of email templates matching search criteria
Input	id name group ('ive'| TBD) tags limit default value: 100 offset default value: 0
Output	id

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('searchEmailTemplateRequest')
  ->setAuth(array('username' => 'username', 'password' => 'password'))
  ->setArgs([
       'group' => 'ive',
    ]);

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>
  <searchEmailTemplateRequest>
    <group>ive</group>
    <limit>10</limit>
    <offset>0</offset>
  </searchEmailTemplateRequest>
</openXML>