GetEmailTemplates

Description

This method allows you to pull a list of email templates. An array of email template objects is returned.

Syntax

EmailTemplate[] GetEmailTemplates(SecurityToken securityToken, string templateInternalId, string templateName)

Arguments

Type

Name

Description

SecurityToken

securityToken

Merchant security token: used to identify merchant and validate transaction. (required)

string

templateInternalId

Unique template ID assigned by the system (optional).

string

templateName

Template name (optional).

Return Value

Type

Description

EmailTemplate []

Returns array of EmailTemplate objects for the matched templates.

Examples

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ebiz="http://eBizCharge.ServiceModel.SOAP">
   <soapenv:Header/>
   <soapenv:Body>
      <ebiz:GetEmailTemplates>
         <ebiz:securityToken>
            <ebiz:SecurityId>1dc496d1-90b4-4a38-ad78-28a795af78e9</ebiz:SecurityId>
            <ebiz:UserId/>
            <ebiz:Password/>
         </ebiz:securityToken>
         <ebiz:templateInternalId></ebiz:templateInternalId>
         <ebiz:templateName>CBS Template 1</ebiz:templateName>
      </ebiz:GetEmailTemplates>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <GetEmailTemplatesResponse xmlns="http://eBizCharge.ServiceModel.SOAP">
         <GetEmailTemplatesResult>
            <EmailTemplate>
               <TemplateName>CBS Template 1</TemplateName>
               <TemplateInternalId>2</TemplateInternalId>
               <TemplateSubject>New Invoice # {refnum}</TemplateSubject>
               <TemplateDescription>New Invoice</TemplateDescription>
               <TemplateHTML>PHA+RGVhciB7bmFtZX06IDwvcD4NCjxwPllvdSBhcmUgYWJsZSB0byBwYXkgb25saW5lIHdpdGggYSBjcmVkaXQgY2FyZCB5b3VyIGN1cnJlbnQgaW52b2ljZSB7cmVmbnVtfSwgZm9yIHthbW91bnR9IHRoYXQgd2FzIGVtYWlsZWQgdG8geW91LiBBbGwgYW1vdW50cyBpbiBVUyBEb2xsYXJzLiBJZiB5b3UgaGF2ZSBhbnkgcXVlc3Rpb25zIGFib3V0IHRoaXMgaW52b2ljZSwgY29udGFjdCBEYXJsYSBTbXl0aCBhdCBkc215dGhAY2VudHVyeWJpenNvbHV0aW9ucy5jb20gb3IgY2FsbCA4ODgtNTAwLTc3OTguIDwvcD4NCjxwPlRoYW5rIFlvdS48L3A+</TemplateHTML>
               <TemplateText/>
            </EmailTemplate>
         </GetEmailTemplatesResult>
      </GetEmailTemplatesResponse>
   </s:Body>
</s:Envelope>