POST api/private/LetterSections/Add

Request Information

URI Parameters

None.

Body Parameters

Domain.Letter.LetterSection
NameDescriptionTypeAdditional information
TemplateId

integer

None.

Template

Domain.Letter.LetterTemplate

None.

Name

string

None.

Description

string

None.

Id

integer

None.

CreatedDate

date

None.

ModifiedDate

date

None.

Disabled

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "TemplateId": 1,
  "Template": {
    "Name": "sample string 1",
    "Description": "sample string 2",
    "FormTypes": [
      {
        "ApplicationId": 1,
        "Application": {
          "Name": "sample string 1",
          "Id": 2,
          "CreatedDate": "2025-04-25T17:56:16.7127933Z",
          "ModifiedDate": "2025-04-25T17:56:16.7127933Z",
          "Disabled": true
        },
        "Description": "sample string 1",
        "FormSections": [
          {
            "Section": "sample string 1",
            "Order": 2,
            "FormTypes": [],
            "Id": 3,
            "CreatedDate": "2025-04-25T17:56:16.7127933Z",
            "ModifiedDate": "2025-04-25T17:56:16.7127933Z",
            "Disabled": true
          },
          {
            "Section": "sample string 1",
            "Order": 2,
            "FormTypes": [],
            "Id": 3,
            "CreatedDate": "2025-04-25T17:56:16.7127933Z",
            "ModifiedDate": "2025-04-25T17:56:16.7127933Z",
            "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-25T17:56:16.7127933Z",
            "ModifiedDate": "2025-04-25T17:56:16.7127933Z",
            "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-25T17:56:16.7127933Z",
            "ModifiedDate": "2025-04-25T17:56:16.7127933Z",
            "Disabled": true
          }
        ],
        "LetterTemplates": [],
        "Id": 2,
        "CreatedDate": "2025-04-25T17:56:16.7127933Z",
        "ModifiedDate": "2025-04-25T17:56:16.7127933Z",
        "Disabled": true
      },
      {
        "ApplicationId": 1,
        "Application": {
          "Name": "sample string 1",
          "Id": 2,
          "CreatedDate": "2025-04-25T17:56:16.7127933Z",
          "ModifiedDate": "2025-04-25T17:56:16.7127933Z",
          "Disabled": true
        },
        "Description": "sample string 1",
        "FormSections": [
          {
            "Section": "sample string 1",
            "Order": 2,
            "FormTypes": [],
            "Id": 3,
            "CreatedDate": "2025-04-25T17:56:16.7127933Z",
            "ModifiedDate": "2025-04-25T17:56:16.7127933Z",
            "Disabled": true
          },
          {
            "Section": "sample string 1",
            "Order": 2,
            "FormTypes": [],
            "Id": 3,
            "CreatedDate": "2025-04-25T17:56:16.7127933Z",
            "ModifiedDate": "2025-04-25T17:56:16.7127933Z",
            "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-25T17:56:16.7127933Z",
            "ModifiedDate": "2025-04-25T17:56:16.7127933Z",
            "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-25T17:56:16.7127933Z",
            "ModifiedDate": "2025-04-25T17:56:16.7127933Z",
            "Disabled": true
          }
        ],
        "LetterTemplates": [],
        "Id": 2,
        "CreatedDate": "2025-04-25T17:56:16.7127933Z",
        "ModifiedDate": "2025-04-25T17:56:16.7127933Z",
        "Disabled": true
      }
    ],
    "Id": 3,
    "CreatedDate": "2025-04-25T17:56:16.7127933Z",
    "ModifiedDate": "2025-04-25T17:56:16.7127933Z",
    "Disabled": true
  },
  "Name": "sample string 2",
  "Description": "sample string 3",
  "Id": 4,
  "CreatedDate": "2025-04-25T17:56:16.7127933Z",
  "ModifiedDate": "2025-04-25T17:56:16.7127933Z",
  "Disabled": true
}

text/xml

Sample:

Sample not available.

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Domain.Letter.LetterSection
NameDescriptionTypeAdditional information
TemplateId

integer

None.

Template

Domain.Letter.LetterTemplate

None.

Name

string

None.

Description

string

None.

Id

integer

None.

CreatedDate

date

None.

ModifiedDate

date

None.

Disabled

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "TemplateId": 1,
  "Template": {
    "Name": "sample string 1",
    "Description": "sample string 2",
    "FormTypes": [
      {
        "ApplicationId": 1,
        "Application": {
          "Name": "sample string 1",
          "Id": 2,
          "CreatedDate": "2025-04-25T17:56:16.795721Z",
          "ModifiedDate": "2025-04-25T17:56:16.795721Z",
          "Disabled": true
        },
        "Description": "sample string 1",
        "FormSections": [
          {
            "Section": "sample string 1",
            "Order": 2,
            "FormTypes": [],
            "Id": 3,
            "CreatedDate": "2025-04-25T17:56:16.795721Z",
            "ModifiedDate": "2025-04-25T17:56:16.795721Z",
            "Disabled": true
          },
          {
            "Section": "sample string 1",
            "Order": 2,
            "FormTypes": [],
            "Id": 3,
            "CreatedDate": "2025-04-25T17:56:16.795721Z",
            "ModifiedDate": "2025-04-25T17:56:16.795721Z",
            "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-25T17:56:16.795721Z",
            "ModifiedDate": "2025-04-25T17:56:16.795721Z",
            "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-25T17:56:16.795721Z",
            "ModifiedDate": "2025-04-25T17:56:16.795721Z",
            "Disabled": true
          }
        ],
        "LetterTemplates": [],
        "Id": 2,
        "CreatedDate": "2025-04-25T17:56:16.795721Z",
        "ModifiedDate": "2025-04-25T17:56:16.795721Z",
        "Disabled": true
      },
      {
        "ApplicationId": 1,
        "Application": {
          "Name": "sample string 1",
          "Id": 2,
          "CreatedDate": "2025-04-25T17:56:16.795721Z",
          "ModifiedDate": "2025-04-25T17:56:16.795721Z",
          "Disabled": true
        },
        "Description": "sample string 1",
        "FormSections": [
          {
            "Section": "sample string 1",
            "Order": 2,
            "FormTypes": [],
            "Id": 3,
            "CreatedDate": "2025-04-25T17:56:16.795721Z",
            "ModifiedDate": "2025-04-25T17:56:16.795721Z",
            "Disabled": true
          },
          {
            "Section": "sample string 1",
            "Order": 2,
            "FormTypes": [],
            "Id": 3,
            "CreatedDate": "2025-04-25T17:56:16.795721Z",
            "ModifiedDate": "2025-04-25T17:56:16.795721Z",
            "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-25T17:56:16.795721Z",
            "ModifiedDate": "2025-04-25T17:56:16.795721Z",
            "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-25T17:56:16.795721Z",
            "ModifiedDate": "2025-04-25T17:56:16.795721Z",
            "Disabled": true
          }
        ],
        "LetterTemplates": [],
        "Id": 2,
        "CreatedDate": "2025-04-25T17:56:16.795721Z",
        "ModifiedDate": "2025-04-25T17:56:16.795721Z",
        "Disabled": true
      }
    ],
    "Id": 3,
    "CreatedDate": "2025-04-25T17:56:16.795721Z",
    "ModifiedDate": "2025-04-25T17:56:16.795721Z",
    "Disabled": true
  },
  "Name": "sample string 2",
  "Description": "sample string 3",
  "Id": 4,
  "CreatedDate": "2025-04-25T17:56:16.795721Z",
  "ModifiedDate": "2025-04-25T17:56:16.795721Z",
  "Disabled": true
}

text/xml

Sample:

Sample not available.