API Module Email Templates searchEmailTemplateRequest

From Openprovider API documentation

Revision as of 12:11, 17 June 2016 by WikiSysop (Talk | contribs)
Jump to: navigation, search

Contents

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, maximum value: 1000)
  • 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>
Views
Personal tools