GET api/v1/emailtemplates/overview

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of EmailTemplateOverview
NameDescriptionTypeAdditional information
EmailTemplateId

globally unique identifier

None.

EmailTemplateName

string

Required

String length: inclusive between 0 and 100

Description

string

None.

IsSystemTemplate

boolean

None.

IsCustomizable

boolean

None.

Id

globally unique identifier

None.

CanUpdateRecord

boolean

None.

CanDeleteRecord

boolean

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "EmailTemplateId": "10275348-cbe6-4332-bd6b-fe6f70bd9433",
    "EmailTemplateName": "sample string 2",
    "Description": "sample string 3",
    "IsSystemTemplate": true,
    "IsCustomizable": true,
    "Id": "10275348-cbe6-4332-bd6b-fe6f70bd9433",
    "CanUpdateRecord": true,
    "CanDeleteRecord": true
  },
  {
    "EmailTemplateId": "10275348-cbe6-4332-bd6b-fe6f70bd9433",
    "EmailTemplateName": "sample string 2",
    "Description": "sample string 3",
    "IsSystemTemplate": true,
    "IsCustomizable": true,
    "Id": "10275348-cbe6-4332-bd6b-fe6f70bd9433",
    "CanUpdateRecord": true,
    "CanDeleteRecord": true
  }
]

text/html

Sample:
[{"EmailTemplateId":"10275348-cbe6-4332-bd6b-fe6f70bd9433","EmailTemplateName":"sample string 2","Description":"sample string 3","IsSystemTemplate":true,"IsCustomizable":true,"Id":"10275348-cbe6-4332-bd6b-fe6f70bd9433","CanUpdateRecord":true,"CanDeleteRecord":true},{"EmailTemplateId":"10275348-cbe6-4332-bd6b-fe6f70bd9433","EmailTemplateName":"sample string 2","Description":"sample string 3","IsSystemTemplate":true,"IsCustomizable":true,"Id":"10275348-cbe6-4332-bd6b-fe6f70bd9433","CanUpdateRecord":true,"CanDeleteRecord":true}]

application/xml, text/xml

Sample:
<ArrayOfEmailTemplateOverview xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi.Emails">
  <EmailTemplateOverview>
    <CanDeleteRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanDeleteRecord>
    <CanUpdateRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanUpdateRecord>
    <Id xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">10275348-cbe6-4332-bd6b-fe6f70bd9433</Id>
    <Description>sample string 3</Description>
    <EmailTemplateId>10275348-cbe6-4332-bd6b-fe6f70bd9433</EmailTemplateId>
    <EmailTemplateName>sample string 2</EmailTemplateName>
    <IsCustomizable>true</IsCustomizable>
    <IsSystemTemplate>true</IsSystemTemplate>
  </EmailTemplateOverview>
  <EmailTemplateOverview>
    <CanDeleteRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanDeleteRecord>
    <CanUpdateRecord xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">true</CanUpdateRecord>
    <Id xmlns="http://schemas.datacontract.org/2004/07/FLS.Data.WebApi">10275348-cbe6-4332-bd6b-fe6f70bd9433</Id>
    <Description>sample string 3</Description>
    <EmailTemplateId>10275348-cbe6-4332-bd6b-fe6f70bd9433</EmailTemplateId>
    <EmailTemplateName>sample string 2</EmailTemplateName>
    <IsCustomizable>true</IsCustomizable>
    <IsSystemTemplate>true</IsSystemTemplate>
  </EmailTemplateOverview>
</ArrayOfEmailTemplateOverview>