GET api/documentgeneration/headertemplates
Returns a list of header templates associated to this agency with their associated brand info Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
The response returned after the operation completes.
Collection of LetterTemplateDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| TemplateType |
The template type value. |
EnumDataContract |
None. |
| OutputFormat |
The output format value. |
EnumDataContract |
None. |
| TemplateOutputDocumentSubType |
The template output document sub type value. |
EnumDataContract |
None. |
| RequiredTypes |
The collection of required types. |
Collection of EnumDataContract |
None. |
| AnalyticsCampaign |
The analytics campaign value. |
CampaignDataContract |
None. |
| ApplyStyleDocument |
Indicates whether apply style document is true. |
boolean |
None. |
| ReadOnlyInPreview |
Indicates whether read only in preview is true. |
boolean |
None. |
| CreatedById |
The unique identifier of the related created by resource. |
integer |
None. |
| Url |
The url value. |
string |
None. |
| RequiresAuthentication |
Indicates whether requires authentication is true. |
boolean |
None. |
| ExpiryDate |
The expiry date, expressed as a date and time. |
date |
None. |
| Attachments |
The collection of attachments. |
Collection of DocumentDataContract |
None. |
| ProcessedSuccessfully |
Indicates whether processed successfully is true. |
boolean |
None. |
| ErrorMessage |
The error message value. |
string |
None. |
| IsGenerated |
Indicates whether this item is generated. |
boolean |
None. |
| Roles |
The collection of roles. |
Collection of DocumentRoleDataContract |
None. |
| Properties |
The collection of properties. |
Collection of DocumentPropertyDataContract |
None. |
| Groups |
The collection of groups. |
Collection of DocumentGroupDataContract |
None. |
| FileStream |
The file stream value. |
Stream |
None. |
| Tags |
The collection of tags. |
Collection of TagDataContract |
None. |
| ApprovalStatus |
The approval status value. |
DocumentApprovalDataContract |
None. |
| DocumentType |
The document type value. |
EnumDataContract |
None. |
| DocumentSubType |
The document sub type value. |
EnumDataContract |
None. |
| FileName |
The file name value. |
string |
None. |
| ContentType |
The content type value. |
string |
None. |
| FileExtension |
The file extension value. |
string |
None. |
| Description |
The description value. |
string |
None. |
| FileSize |
The file size value. |
string |
None. |
| CreatedDate |
The created date, expressed as a date and time. |
date |
None. |
| CreatedBy |
The created by value. |
CreatedByDataContract |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Response Formats
application/json
Sample not available.
text/json
Sample not available.