API Module Email Templates searchEmailTemplateRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 12:39, 17 September 2015

Module Email Templates > Search

Module	Email Templates
Command name	searchEmailTemplateRequest
Use	Returns a list of email templates matching search criteria
Input	id name group 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',
       'isActive' => true,
    ]);

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.

@@ Line 27: / Line 27: @@
 ===Using PHP class===
   $request = new OP_Request;
-  $request->setCommand('startCustomerEmailVerificationRequest')
+  $request->setCommand('searchEmailTemplateRequest')
     ->setAuth(array('username' => 'username', 'password' => 'password'))
-    ->setArgs(array(
+    ->setArgs([
-     'email' => 'support@openprovider.nl'
+        'group' => 'ive',
-   ));
+        'isActive' => true,
+     ]);
 ===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.''