GET api/documentgeneration/envelopetemplatepack/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

None.

Response Information

Resource Description

EnvelopeTemplatePackDataContract
NameDescriptionTypeAdditional information
FriendlyName

string

None.

EnvelopeTemplates

Collection of EnvelopeTemplateDataContract

None.

EnvelopeTemplatePackType

EnumDataContract

None.

IsDefault

boolean

None.

NotReady

boolean

None.

CustomPrompt

string

None.

Endpoint

string

None.

Contract

string

None.

EventType

string

None.

Description

string

None.

WorkflowIndex

integer

None.

Id

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "FriendlyName": "sample string 1",
  "EnvelopeTemplates": [
    {
      "FriendlyName": "sample string 1",
      "LetterTemplates": [
        {
          "TemplateType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "OutputFormat": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "TemplateOutputDocumentSubType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "RequiredTypes": [
            {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            }
          ],
          "AnalyticsCampaign": {
            "Name": "sample string 1",
            "CreatedDate": "2018-11-16T14:26:39.4305149Z",
            "CreatedBy": {
              "Initials": "sample string 1",
              "ContactName": "sample string 2",
              "Gender": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Title": "sample string 3",
              "FirstName": "sample string 4",
              "LastName": "sample string 5",
              "PrimaryTelephone": {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Value": "sample string 1",
                "Notes": "sample string 2",
                "ContactOrder": 3,
                "AllowContact": true,
                "MarketingContactStatus": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 5",
                "Id": 6
              },
              "PrimaryEmail": {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Value": "sample string 1",
                "Notes": "sample string 2",
                "ContactOrder": 3,
                "AllowContact": true,
                "MarketingContactStatus": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 5",
                "Id": 6
              },
              "JobTitle": "sample string 6",
              "Id": 7
            },
            "Id": 3
          },
          "ApplyStyleDocument": true,
          "ReadOnlyInPreview": true,
          "CreatedById": 3,
          "Url": "sample string 4",
          "RequiresAuthentication": true,
          "ExpiryDate": "2018-11-16T14:26:39.4305149Z",
          "Tags": [
            {
              "Name": "sample string 1",
              "SystemStatusName": "sample string 2",
              "TagType": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Id": 3
            },
            {
              "Name": "sample string 1",
              "SystemStatusName": "sample string 2",
              "TagType": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Id": 3
            }
          ],
          "DocumentType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "DocumentSubType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "FileName": "sample string 6",
          "ContentType": "sample string 7",
          "FileExtension": "sample string 8",
          "Description": "sample string 9",
          "CreatedDate": "2018-11-16T14:26:39.4305149Z",
          "CreatedBy": {
            "Initials": "sample string 1",
            "ContactName": "sample string 2",
            "Gender": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Title": "sample string 3",
            "FirstName": "sample string 4",
            "LastName": "sample string 5",
            "PrimaryTelephone": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "PrimaryEmail": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "JobTitle": "sample string 6",
            "Id": 7
          },
          "Id": 11
        },
        {
          "TemplateType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "OutputFormat": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "TemplateOutputDocumentSubType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "RequiredTypes": [
            {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            }
          ],
          "AnalyticsCampaign": {
            "Name": "sample string 1",
            "CreatedDate": "2018-11-16T14:26:39.4305149Z",
            "CreatedBy": {
              "Initials": "sample string 1",
              "ContactName": "sample string 2",
              "Gender": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Title": "sample string 3",
              "FirstName": "sample string 4",
              "LastName": "sample string 5",
              "PrimaryTelephone": {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Value": "sample string 1",
                "Notes": "sample string 2",
                "ContactOrder": 3,
                "AllowContact": true,
                "MarketingContactStatus": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 5",
                "Id": 6
              },
              "PrimaryEmail": {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Value": "sample string 1",
                "Notes": "sample string 2",
                "ContactOrder": 3,
                "AllowContact": true,
                "MarketingContactStatus": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 5",
                "Id": 6
              },
              "JobTitle": "sample string 6",
              "Id": 7
            },
            "Id": 3
          },
          "ApplyStyleDocument": true,
          "ReadOnlyInPreview": true,
          "CreatedById": 3,
          "Url": "sample string 4",
          "RequiresAuthentication": true,
          "ExpiryDate": "2018-11-16T14:26:39.4305149Z",
          "Tags": [
            {
              "Name": "sample string 1",
              "SystemStatusName": "sample string 2",
              "TagType": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Id": 3
            },
            {
              "Name": "sample string 1",
              "SystemStatusName": "sample string 2",
              "TagType": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Id": 3
            }
          ],
          "DocumentType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "DocumentSubType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "FileName": "sample string 6",
          "ContentType": "sample string 7",
          "FileExtension": "sample string 8",
          "Description": "sample string 9",
          "CreatedDate": "2018-11-16T14:26:39.4305149Z",
          "CreatedBy": {
            "Initials": "sample string 1",
            "ContactName": "sample string 2",
            "Gender": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Title": "sample string 3",
            "FirstName": "sample string 4",
            "LastName": "sample string 5",
            "PrimaryTelephone": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "PrimaryEmail": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "JobTitle": "sample string 6",
            "Id": 7
          },
          "Id": 11
        }
      ],
      "CanBeSplit": true,
      "EnvelopeTemplateTargetType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Description": "sample string 3",
      "Id": 4
    },
    {
      "FriendlyName": "sample string 1",
      "LetterTemplates": [
        {
          "TemplateType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "OutputFormat": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "TemplateOutputDocumentSubType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "RequiredTypes": [
            {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            }
          ],
          "AnalyticsCampaign": {
            "Name": "sample string 1",
            "CreatedDate": "2018-11-16T14:26:39.4305149Z",
            "CreatedBy": {
              "Initials": "sample string 1",
              "ContactName": "sample string 2",
              "Gender": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Title": "sample string 3",
              "FirstName": "sample string 4",
              "LastName": "sample string 5",
              "PrimaryTelephone": {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Value": "sample string 1",
                "Notes": "sample string 2",
                "ContactOrder": 3,
                "AllowContact": true,
                "MarketingContactStatus": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 5",
                "Id": 6
              },
              "PrimaryEmail": {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Value": "sample string 1",
                "Notes": "sample string 2",
                "ContactOrder": 3,
                "AllowContact": true,
                "MarketingContactStatus": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 5",
                "Id": 6
              },
              "JobTitle": "sample string 6",
              "Id": 7
            },
            "Id": 3
          },
          "ApplyStyleDocument": true,
          "ReadOnlyInPreview": true,
          "CreatedById": 3,
          "Url": "sample string 4",
          "RequiresAuthentication": true,
          "ExpiryDate": "2018-11-16T14:26:39.4305149Z",
          "Tags": [
            {
              "Name": "sample string 1",
              "SystemStatusName": "sample string 2",
              "TagType": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Id": 3
            },
            {
              "Name": "sample string 1",
              "SystemStatusName": "sample string 2",
              "TagType": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Id": 3
            }
          ],
          "DocumentType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "DocumentSubType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "FileName": "sample string 6",
          "ContentType": "sample string 7",
          "FileExtension": "sample string 8",
          "Description": "sample string 9",
          "CreatedDate": "2018-11-16T14:26:39.4305149Z",
          "CreatedBy": {
            "Initials": "sample string 1",
            "ContactName": "sample string 2",
            "Gender": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Title": "sample string 3",
            "FirstName": "sample string 4",
            "LastName": "sample string 5",
            "PrimaryTelephone": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "PrimaryEmail": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "JobTitle": "sample string 6",
            "Id": 7
          },
          "Id": 11
        },
        {
          "TemplateType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "OutputFormat": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "TemplateOutputDocumentSubType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "RequiredTypes": [
            {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            }
          ],
          "AnalyticsCampaign": {
            "Name": "sample string 1",
            "CreatedDate": "2018-11-16T14:26:39.4305149Z",
            "CreatedBy": {
              "Initials": "sample string 1",
              "ContactName": "sample string 2",
              "Gender": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Title": "sample string 3",
              "FirstName": "sample string 4",
              "LastName": "sample string 5",
              "PrimaryTelephone": {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Value": "sample string 1",
                "Notes": "sample string 2",
                "ContactOrder": 3,
                "AllowContact": true,
                "MarketingContactStatus": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 5",
                "Id": 6
              },
              "PrimaryEmail": {
                "Type": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Value": "sample string 1",
                "Notes": "sample string 2",
                "ContactOrder": 3,
                "AllowContact": true,
                "MarketingContactStatus": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "Name": "sample string 5",
                "Id": 6
              },
              "JobTitle": "sample string 6",
              "Id": 7
            },
            "Id": 3
          },
          "ApplyStyleDocument": true,
          "ReadOnlyInPreview": true,
          "CreatedById": 3,
          "Url": "sample string 4",
          "RequiresAuthentication": true,
          "ExpiryDate": "2018-11-16T14:26:39.4305149Z",
          "Tags": [
            {
              "Name": "sample string 1",
              "SystemStatusName": "sample string 2",
              "TagType": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Id": 3
            },
            {
              "Name": "sample string 1",
              "SystemStatusName": "sample string 2",
              "TagType": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Id": 3
            }
          ],
          "DocumentType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "DocumentSubType": {
            "Id": 1,
            "Name": "sample string 2",
            "SystemName": "sample string 3"
          },
          "FileName": "sample string 6",
          "ContentType": "sample string 7",
          "FileExtension": "sample string 8",
          "Description": "sample string 9",
          "CreatedDate": "2018-11-16T14:26:39.4305149Z",
          "CreatedBy": {
            "Initials": "sample string 1",
            "ContactName": "sample string 2",
            "Gender": {
              "Id": 1,
              "Name": "sample string 2",
              "SystemName": "sample string 3"
            },
            "Title": "sample string 3",
            "FirstName": "sample string 4",
            "LastName": "sample string 5",
            "PrimaryTelephone": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "PrimaryEmail": {
              "Type": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Value": "sample string 1",
              "Notes": "sample string 2",
              "ContactOrder": 3,
              "AllowContact": true,
              "MarketingContactStatus": {
                "Id": 1,
                "Name": "sample string 2",
                "SystemName": "sample string 3"
              },
              "Name": "sample string 5",
              "Id": 6
            },
            "JobTitle": "sample string 6",
            "Id": 7
          },
          "Id": 11
        }
      ],
      "CanBeSplit": true,
      "EnvelopeTemplateTargetType": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "Description": "sample string 3",
      "Id": 4
    }
  ],
  "EnvelopeTemplatePackType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "IsDefault": true,
  "NotReady": true,
  "CustomPrompt": "sample string 4",
  "Endpoint": "sample string 5",
  "Contract": "sample string 6",
  "EventType": "sample string 7",
  "Description": "sample string 8",
  "WorkflowIndex": 9,
  "Id": 10
}