GET api/private/LetterTemplates/GetByName?name={name}

Request Information

URI Parameters

Name	Description	Type	Additional information
name		string	Required

Body Parameters

None.

Response Information

Resource Description

Domain.Letter.LetterTemplate

Name	Type	Additional information
Name	string	None.
Description	string	None.
FormTypes	Collection of Domain.Form.FormType	None.
Id	integer	None.
CreatedDate	date	None.
ModifiedDate	date	None.
Disabled	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "Name": "sample string 1",
  "Description": "sample string 2",
  "FormTypes": [
    {
      "ApplicationId": 1,
      "Application": {
        "Name": "sample string 1",
        "Id": 2,
        "CreatedDate": "2025-04-25T18:27:19.4261053Z",
        "ModifiedDate": "2025-04-25T18:27:19.4261053Z",
        "Disabled": true
      },
      "Description": "sample string 1",
      "FormSections": [
        {
          "Section": "sample string 1",
          "Order": 2,
          "FormTypes": [],
          "Id": 3,
          "CreatedDate": "2025-04-25T18:27:19.4261053Z",
          "ModifiedDate": "2025-04-25T18:27:19.4261053Z",
          "Disabled": true
        },
        {
          "Section": "sample string 1",
          "Order": 2,
          "FormTypes": [],
          "Id": 3,
          "CreatedDate": "2025-04-25T18:27:19.4261053Z",
          "ModifiedDate": "2025-04-25T18:27:19.4261053Z",
          "Disabled": true
        }
      ],
      "FeeTypes": [
        {
          "Code": "sample string 1",
          "Description": "sample string 2",
          "Summary": "sample string 3",
          "Amount": 4.1,
          "Order": 5,
          "IsFederalFeeType": true,
          "IsProjectFeeType": true,
          "IsCustomAmountAccepted": true,
          "FormTypes": [],
          "Id": 9,
          "CreatedDate": "2025-04-25T18:27:19.4261053Z",
          "ModifiedDate": "2025-04-25T18:27:19.4261053Z",
          "Disabled": true
        },
        {
          "Code": "sample string 1",
          "Description": "sample string 2",
          "Summary": "sample string 3",
          "Amount": 4.1,
          "Order": 5,
          "IsFederalFeeType": true,
          "IsProjectFeeType": true,
          "IsCustomAmountAccepted": true,
          "FormTypes": [],
          "Id": 9,
          "CreatedDate": "2025-04-25T18:27:19.4261053Z",
          "ModifiedDate": "2025-04-25T18:27:19.4261053Z",
          "Disabled": true
        }
      ],
      "LetterTemplates": [],
      "Id": 2,
      "CreatedDate": "2025-04-25T18:27:19.4261053Z",
      "ModifiedDate": "2025-04-25T18:27:19.4261053Z",
      "Disabled": true
    },
    {
      "ApplicationId": 1,
      "Application": {
        "Name": "sample string 1",
        "Id": 2,
        "CreatedDate": "2025-04-25T18:27:19.4261053Z",
        "ModifiedDate": "2025-04-25T18:27:19.4261053Z",
        "Disabled": true
      },
      "Description": "sample string 1",
      "FormSections": [
        {
          "Section": "sample string 1",
          "Order": 2,
          "FormTypes": [],
          "Id": 3,
          "CreatedDate": "2025-04-25T18:27:19.4261053Z",
          "ModifiedDate": "2025-04-25T18:27:19.4261053Z",
          "Disabled": true
        },
        {
          "Section": "sample string 1",
          "Order": 2,
          "FormTypes": [],
          "Id": 3,
          "CreatedDate": "2025-04-25T18:27:19.4261053Z",
          "ModifiedDate": "2025-04-25T18:27:19.4261053Z",
          "Disabled": true
        }
      ],
      "FeeTypes": [
        {
          "Code": "sample string 1",
          "Description": "sample string 2",
          "Summary": "sample string 3",
          "Amount": 4.1,
          "Order": 5,
          "IsFederalFeeType": true,
          "IsProjectFeeType": true,
          "IsCustomAmountAccepted": true,
          "FormTypes": [],
          "Id": 9,
          "CreatedDate": "2025-04-25T18:27:19.4261053Z",
          "ModifiedDate": "2025-04-25T18:27:19.4261053Z",
          "Disabled": true
        },
        {
          "Code": "sample string 1",
          "Description": "sample string 2",
          "Summary": "sample string 3",
          "Amount": 4.1,
          "Order": 5,
          "IsFederalFeeType": true,
          "IsProjectFeeType": true,
          "IsCustomAmountAccepted": true,
          "FormTypes": [],
          "Id": 9,
          "CreatedDate": "2025-04-25T18:27:19.4261053Z",
          "ModifiedDate": "2025-04-25T18:27:19.4261053Z",
          "Disabled": true
        }
      ],
      "LetterTemplates": [],
      "Id": 2,
      "CreatedDate": "2025-04-25T18:27:19.4261053Z",
      "ModifiedDate": "2025-04-25T18:27:19.4261053Z",
      "Disabled": true
    }
  ],
  "Id": 3,
  "CreatedDate": "2025-04-25T18:27:19.4261053Z",
  "ModifiedDate": "2025-04-25T18:27:19.4261053Z",
  "Disabled": true
}

text/xml

Sample:

Sample not available.