RMail API

Back to Template

GET api/V1/Template/GetTemplateDetailList

This method is used to get template list.

Prerequisites

To be implemented

Request Information

Lorem ipsum

URI Parameters

None

Header Parameters

Header Description

Name Description Type
Content-Type This is a request content type application/json
Accept This is a response content type application/json
AuthToken This is user’s authorization token. example@example.com^296f1f85-35d4-4dd4-a350-67131c926546^rps^en-US

Note: From the Header parameters mentioned, “AuthToken” is not required for the below mentioned services.

  • Account/RegisterUser
  • Authentication/AuthenticateUser

Body Parameters

None.

Response Information

Resource Description

Name Description Type ADDITIONAL INFORMATION
TemplateId GUID None
TemplateCode This will return template code. integer None
UserEmail This will return Envelop Id. string
 None
TemplateName This will return template name if any string None
TemplateDescription This will return template description if any string
 None
IsStatic This will return envelope IsCreateStaticLink for template flag boolean None
ExpiryDate date
 None
CreatedDate date
 None
LastModifiedDate date
 None
Subject string None
Body string None
DocumentList This will return flag for signature certificate. Collection of DocumentBasicInfo None
TemplateRoleList Collection of TemplateRoleBasicInfo None

Response Formats

application/json, text/json
Sample:
{
"TemplateId": "f7909e9b-931d-4a6e-b1a4-52e0bf1424d0",
"TemplateCode": 2,
"UserEmail": "sample string 3",
"TemplateName": "sample string 4",
"TemplateDescription": "sample string 5",
"IsStatic": true,
"ExpiryDate": "2020-06-05T10:24:32.1387493+00:00",
"CreatedDate": "2020-06-05T10:24:32.1387493+00:00",
"LastModifiedDate": "2020-06-05T10:24:32.1387493+00:00",
"Subject": "sample string 6",
"Body": "sample string 7",
"DocumentList": [
{
  "DocumentId": "883d1b4e-201d-47eb-a4c1-dbb4af1ad8cf",
  "DocumentName": "sample string 2",
  "Order": 1,
  "documentContentDetails": [
    {
      "ControlID": "eace0320-4731-4daf-b61c-c143bbd26f61",
      "ControlName": "sample string 2",
      "ControlHtmlID": "sample string 3",
      "GroupName": "sample string 4",
      "Label": "sample string 5",
      "PageNo": 1,
      "Required": true,
      "ControlValue": "sample string 7",
      "RoleId": "8ae784f1-e1f3-4fbd-91d2-533b39051506",
      "RoleName": "sample string 8",
      "SelectControlOptions": [
        {
          "ID": "91a07039-b8a7-4f08-b4f9-a12492b658ba",
          "OptionText": "sample string 2",
          "Order": 64
        },
        {
          "ID": "91a07039-b8a7-4f08-b4f9-a12492b658ba",
          "OptionText": "sample string 2",
          "Order": 64
        }
      ]
    },
    {
      "ControlID": "eace0320-4731-4daf-b61c-c143bbd26f61",
      "ControlName": "sample string 2",
      "ControlHtmlID": "sample string 3",
      "GroupName": "sample string 4",
      "Label": "sample string 5",
      "PageNo": 1,
      "Required": true,
      "ControlValue": "sample string 7",
      "RoleId": "8ae784f1-e1f3-4fbd-91d2-533b39051506",
      "RoleName": "sample string 8",
      "SelectControlOptions": [
        {
          "ID": "91a07039-b8a7-4f08-b4f9-a12492b658ba",
          "OptionText": "sample string 2",
          "Order": 64
        },
        {
          "ID": "91a07039-b8a7-4f08-b4f9-a12492b658ba",
          "OptionText": "sample string 2",
          "Order": 64
        }
      ]
    }
  ]
},
{
  "DocumentId": "883d1b4e-201d-47eb-a4c1-dbb4af1ad8cf",
  "DocumentName": "sample string 2",
  "Order": 1,
  "documentContentDetails": [
    {
      "ControlID": "eace0320-4731-4daf-b61c-c143bbd26f61",
      "ControlName": "sample string 2",
      "ControlHtmlID": "sample string 3",
      "GroupName": "sample string 4",
      "Label": "sample string 5",
      "PageNo": 1,
      "Required": true,
      "ControlValue": "sample string 7",
      "RoleId": "8ae784f1-e1f3-4fbd-91d2-533b39051506",
      "RoleName": "sample string 8",
      "SelectControlOptions": [
        {
          "ID": "91a07039-b8a7-4f08-b4f9-a12492b658ba",
          "OptionText": "sample string 2",
          "Order": 64
        },
        {
          "ID": "91a07039-b8a7-4f08-b4f9-a12492b658ba",
          "OptionText": "sample string 2",
          "Order": 64
        }
      ]
    },
    {
      "ControlID": "eace0320-4731-4daf-b61c-c143bbd26f61",
      "ControlName": "sample string 2",
      "ControlHtmlID": "sample string 3",
      "GroupName": "sample string 4",
      "Label": "sample string 5",
      "PageNo": 1,
      "Required": true,
      "ControlValue": "sample string 7",
      "RoleId": "8ae784f1-e1f3-4fbd-91d2-533b39051506",
      "RoleName": "sample string 8",
      "SelectControlOptions": [
        {
          "ID": "91a07039-b8a7-4f08-b4f9-a12492b658ba",
          "OptionText": "sample string 2",
          "Order": 64
        },
        {
          "ID": "91a07039-b8a7-4f08-b4f9-a12492b658ba",
          "OptionText": "sample string 2",
          "Order": 64
        }
      ]
    }
  ]
}
],
"TemplateRoleList": [
{
  "RoleID": "646d030b-33d8-4d66-8fe0-4b1b77c4b342",
  "RoleName": "sample string 2",
  "Order": 1,
  "RecipientEmail": "sample string 3",
  "RecipientName": "sample string 4",
  "RecipientTypeID": "faea119e-5b95-41c2-8fce-81c06b4e3dcd"
},
{
  "RoleID": "646d030b-33d8-4d66-8fe0-4b1b77c4b342",
  "RoleName": "sample string 2",
  "Order": 1,
  "RecipientEmail": "sample string 3",
  "RecipientName": "sample string 4",
  "RecipientTypeID": "faea119e-5b95-41c2-8fce-81c06b4e3dcd"
}
]
}
application/json, text/json
Sample:
<TemplateBasicInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<TemplateId>f7909e9b-931d-4a6e-b1a4-52e0bf1424d0</TemplateId>
<TemplateCode>2</TemplateCode>
<UserEmail>sample string 3</UserEmail>
<TemplateName>sample string 4</TemplateName>
<TemplateDescription>sample string 5</TemplateDescription>
<IsStatic>true</IsStatic>
<ExpiryDate>2020-06-05T10:24:32.1387493+00:00</ExpiryDate>
<CreatedDate>2020-06-05T10:24:32.1387493+00:00</CreatedDate>
<LastModifiedDate>2020-06-05T10:24:32.1387493+00:00</LastModifiedDate>
<Subject>sample string 6</Subject>
<Body>sample string 7</Body>
<DocumentList>
<DocumentBasicInfo>
  <DocumentId>883d1b4e-201d-47eb-a4c1-dbb4af1ad8cf</DocumentId>
  <DocumentName>sample string 2</DocumentName>
  <Order>1</Order>
  <documentContentDetails>
    <DocumentContentBasicInfo>
      <ControlID>eace0320-4731-4daf-b61c-c143bbd26f61</ControlID>
      <ControlName>sample string 2</ControlName>
      <ControlHtmlID>sample string 3</ControlHtmlID>
      <GroupName>sample string 4</GroupName>
      <Label>sample string 5</Label>
      <PageNo>1</PageNo>
      <Required>true</Required>
      <ControlValue>sample string 7</ControlValue>
      <RoleId>8ae784f1-e1f3-4fbd-91d2-533b39051506</RoleId>
      <RoleName>sample string 8</RoleName>
      <SelectControlOptions>
        <SelectControlOptionsPOCO>
          <ID>91a07039-b8a7-4f08-b4f9-a12492b658ba</ID>
          <OptionText>sample string 2</OptionText>
          <Order>64</Order>
        </SelectControlOptionsPOCO>
        <SelectControlOptionsPOCO>
          <ID>91a07039-b8a7-4f08-b4f9-a12492b658ba</ID>
          <OptionText>sample string 2</OptionText>
          <Order>64</Order>
        </SelectControlOptionsPOCO>
      </SelectControlOptions>
    </DocumentContentBasicInfo>
    <DocumentContentBasicInfo>
      <ControlID>eace0320-4731-4daf-b61c-c143bbd26f61</ControlID>
      <ControlName>sample string 2</ControlName>
      <ControlHtmlID>sample string 3</ControlHtmlID>
      <GroupName>sample string 4</GroupName>
      <Label>sample string 5</Label>
      <PageNo>1</PageNo>
      <Required>true</Required>
      <ControlValue>sample string 7</ControlValue>
      <RoleId>8ae784f1-e1f3-4fbd-91d2-533b39051506</RoleId>
      <RoleName>sample string 8</RoleName>
      <SelectControlOptions>
        <SelectControlOptionsPOCO>
          <ID>91a07039-b8a7-4f08-b4f9-a12492b658ba</ID>
          <OptionText>sample string 2</OptionText>
          <Order>64</Order>
        </SelectControlOptionsPOCO>
        <SelectControlOptionsPOCO>
          <ID>91a07039-b8a7-4f08-b4f9-a12492b658ba</ID>
          <OptionText>sample string 2</OptionText>
          <Order>64</Order>
        </SelectControlOptionsPOCO>
      </SelectControlOptions>
    </DocumentContentBasicInfo>
  </documentContentDetails>
</DocumentBasicInfo>
<DocumentBasicInfo>
  <DocumentId>883d1b4e-201d-47eb-a4c1-dbb4af1ad8cf</DocumentId>
  <DocumentName>sample string 2</DocumentName>
  <Order>1</Order>
  <documentContentDetails>
    <DocumentContentBasicInfo>
      <ControlID>eace0320-4731-4daf-b61c-c143bbd26f61</ControlID>
      <ControlName>sample string 2</ControlName>
      <ControlHtmlID>sample string 3</ControlHtmlID>
      <GroupName>sample string 4</GroupName>
      <Label>sample string 5</Label>
      <PageNo>1</PageNo>
      <Required>true</Required>
      <ControlValue>sample string 7</ControlValue>
      <RoleId>8ae784f1-e1f3-4fbd-91d2-533b39051506</RoleId>
      <RoleName>sample string 8</RoleName>
      <SelectControlOptions>
        <SelectControlOptionsPOCO>
          <ID>91a07039-b8a7-4f08-b4f9-a12492b658ba</ID>
          <OptionText>sample string 2</OptionText>
          <Order>64</Order>
        </SelectControlOptionsPOCO>
        <SelectControlOptionsPOCO>
          <ID>91a07039-b8a7-4f08-b4f9-a12492b658ba</ID>
          <OptionText>sample string 2</OptionText>
          <Order>64</Order>
        </SelectControlOptionsPOCO>
      </SelectControlOptions>
    </DocumentContentBasicInfo>
    <DocumentContentBasicInfo>
      <ControlID>eace0320-4731-4daf-b61c-c143bbd26f61</ControlID>
      <ControlName>sample string 2</ControlName>
      <ControlHtmlID>sample string 3</ControlHtmlID>
      <GroupName>sample string 4</GroupName>
      <Label>sample string 5</Label>
      <PageNo>1</PageNo>
      <Required>true</Required>
      <ControlValue>sample string 7</ControlValue>
      <RoleId>8ae784f1-e1f3-4fbd-91d2-533b39051506</RoleId>
      <RoleName>sample string 8</RoleName>
      <SelectControlOptions>
        <SelectControlOptionsPOCO>
          <ID>91a07039-b8a7-4f08-b4f9-a12492b658ba</ID>
          <OptionText>sample string 2</OptionText>
          <Order>64</Order>
        </SelectControlOptionsPOCO>
        <SelectControlOptionsPOCO>
          <ID>91a07039-b8a7-4f08-b4f9-a12492b658ba</ID>
          <OptionText>sample string 2</OptionText>
          <Order>64</Order>
        </SelectControlOptionsPOCO>
      </SelectControlOptions>
    </DocumentContentBasicInfo>
  </documentContentDetails>
</DocumentBasicInfo>
</DocumentList>
<TemplateRoleList>
<TemplateRoleBasicInfo>
  <RoleID>646d030b-33d8-4d66-8fe0-4b1b77c4b342</RoleID>
  <RoleName>sample string 2</RoleName>
  <Order>1</Order>
  <RecipientEmail>sample string 3</RecipientEmail>
  <RecipientName>sample string 4</RecipientName>
  <RecipientTypeID>faea119e-5b95-41c2-8fce-81c06b4e3dcd</RecipientTypeID>
</TemplateRoleBasicInfo>
<TemplateRoleBasicInfo>
  <RoleID>646d030b-33d8-4d66-8fe0-4b1b77c4b342</RoleID>
  <RoleName>sample string 2</RoleName>
  <Order>1</Order>
  <RecipientEmail>sample string 3</RecipientEmail>
  <RecipientName>sample string 4</RecipientName>
  <RecipientTypeID>faea119e-5b95-41c2-8fce-81c06b4e3dcd</RecipientTypeID>
</TemplateRoleBasicInfo>
</TemplateRoleList>
</TemplateBasicInfo>

Was this page helpful?

Yes No

About Us

Features

Related Websites

Success Stories

Customer Videos

Insights

More Insights

Industries

Pricing

Apps

Support

Sitemap

Training Videos

© 1999-2024 RPost. All Rights Reserved. Terms & Conditions, RMail | Gmail App Compliance.
RPost Patented (click for patent list).