GET api/documentgeneration/envelopetemplate/{id}
Returns a envelope template
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Dezrez.Core.DataContracts.External.Api.DocumentGeneration.Query.EnvelopeTemplateDataContractName | Description | Type | Additional information |
---|---|---|---|
FriendlyName | string |
None. |
|
LetterTemplates | Collection of Dezrez.Core.DataContracts.External.Api.DocumentGeneration.Query.LetterTemplateDataContract |
None. |
|
CanBeSplit | boolean |
None. |
|
EnvelopeTemplateTargetType | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
Description | string |
None. |
|
PreventDigitalSignature | boolean |
None. |
|
EnvelopeCCdNegotiators | integer |
None. |
|
Id | integer |
None. |
Response Formats
application/json, text/json
Sample:
{ "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": "2024-10-30T15:16:52.5760907Z", "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": "2024-10-30T15:16:52.5760907Z", "FileStream": null, "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", "FileSize": "sample string 10", "CreatedDate": "2024-10-30T15:16:52.5760907Z", "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": 12 }, { "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": "2024-10-30T15:16:52.5760907Z", "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": "2024-10-30T15:16:52.5760907Z", "FileStream": null, "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", "FileSize": "sample string 10", "CreatedDate": "2024-10-30T15:16:52.5760907Z", "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": 12 } ], "CanBeSplit": true, "EnvelopeTemplateTargetType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "Description": "sample string 3", "PreventDigitalSignature": true, "EnvelopeCCdNegotiators": 5, "Id": 6 }