GET api/documentgeneration/sackcontent/{sackReference}

Returns the detail of the all outstanding sacks Processes this document generation API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
sackReference

The sack reference value supplied with the request.

string

Required

Body Parameters

None.

Response Information

Resource Description

The response returned after the operation completes.

GeneratededSackDataContract
NameDescriptionTypeAdditional information
FriendlyName

The friendly name value.

string

None.

GroupedEnvelopeDataContracts

The collection of grouped envelope data contracts.

Collection of GroupedEnvelopeDataContract

None.

PreviewOnly

Indicates whether preview only is true.

boolean

None.

EnvelopeTemplatePackId

The unique identifier of the related envelope template pack resource.

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "FriendlyName": "sample string 1",
  "GroupedEnvelopeDataContracts": [
    {
      "PersonName": "sample string 1",
      "EnvelopeDataContracts": [
        {
          "envelope": {
            "envelopeTemplateId": 1,
            "parentPackId": 2,
            "SackReference": "sample string 3",
            "Reference": "sample string 4",
            "FriendlyName": "sample string 5",
            "Letters": [
              {
                "Partition": 1,
                "Reference": "sample string 2",
                "Filename": "sample string 3",
                "FileExtension": "sample string 4",
                "TemplateType": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "TemplateOutputDocumentSubType": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "ContentType": "sample string 5",
                "PostDocGenerationHandler": {
                  "EntityType": {
                    "Id": 1,
                    "Name": "sample string 2",
                    "SystemName": "sample string 3"
                  },
                  "EntityId": 1,
                  "JobHandlerType": {
                    "Id": 1,
                    "Name": "sample string 2",
                    "SystemName": "sample string 3"
                  },
                  "Options": {
                    "sample string 1": "sample string 2",
                    "sample string 3": "sample string 4"
                  },
                  "DocumentSubType": {
                    "Id": 1,
                    "Name": "sample string 2",
                    "SystemName": "sample string 3"
                  },
                  "AccountingSystemId": 2,
                  "AgencyId": 3,
                  "JobHandlerName": "sample string 4"
                },
                "LetterTemplateId": 6,
                "EnvelopeTemplatePackId": 7
              },
              {
                "Partition": 1,
                "Reference": "sample string 2",
                "Filename": "sample string 3",
                "FileExtension": "sample string 4",
                "TemplateType": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "TemplateOutputDocumentSubType": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "ContentType": "sample string 5",
                "PostDocGenerationHandler": {
                  "EntityType": {
                    "Id": 1,
                    "Name": "sample string 2",
                    "SystemName": "sample string 3"
                  },
                  "EntityId": 1,
                  "JobHandlerType": {
                    "Id": 1,
                    "Name": "sample string 2",
                    "SystemName": "sample string 3"
                  },
                  "Options": {
                    "sample string 1": "sample string 2",
                    "sample string 3": "sample string 4"
                  },
                  "DocumentSubType": {
                    "Id": 1,
                    "Name": "sample string 2",
                    "SystemName": "sample string 3"
                  },
                  "AccountingSystemId": 2,
                  "AgencyId": 3,
                  "JobHandlerName": "sample string 4"
                },
                "LetterTemplateId": 6,
                "EnvelopeTemplatePackId": 7
              }
            ],
            "PropertyRoleIds": [
              1,
              2
            ],
            "GroupRoleIds": [
              1,
              2
            ],
            "OwnsRoleId": 6,
            "ParentGroupId": 1,
            "PersonId": 1,
            "ContainsPrintable": true,
            "IsEmailCompatible": true,
            "IsTextCompatible": true,
            "IsBymCompatible": true,
            "PersonName": "sample string 11",
            "OutputPdf": true,
            "Created": "2026-08-04T22:21:29.1206613Z",
            "Expires": "2026-08-04T22:21:29.1206613Z",
            "CreatedByWorkflow": true,
            "GeneratedDocs": [
              1,
              2
            ]
          },
          "AlternateContactItemDataContract": [
            {
              "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
            },
            {
              "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
            }
          ]
        },
        {
          "envelope": {
            "envelopeTemplateId": 1,
            "parentPackId": 2,
            "SackReference": "sample string 3",
            "Reference": "sample string 4",
            "FriendlyName": "sample string 5",
            "Letters": [
              {
                "Partition": 1,
                "Reference": "sample string 2",
                "Filename": "sample string 3",
                "FileExtension": "sample string 4",
                "TemplateType": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "TemplateOutputDocumentSubType": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "ContentType": "sample string 5",
                "PostDocGenerationHandler": {
                  "EntityType": {
                    "Id": 1,
                    "Name": "sample string 2",
                    "SystemName": "sample string 3"
                  },
                  "EntityId": 1,
                  "JobHandlerType": {
                    "Id": 1,
                    "Name": "sample string 2",
                    "SystemName": "sample string 3"
                  },
                  "Options": {
                    "sample string 1": "sample string 2",
                    "sample string 3": "sample string 4"
                  },
                  "DocumentSubType": {
                    "Id": 1,
                    "Name": "sample string 2",
                    "SystemName": "sample string 3"
                  },
                  "AccountingSystemId": 2,
                  "AgencyId": 3,
                  "JobHandlerName": "sample string 4"
                },
                "LetterTemplateId": 6,
                "EnvelopeTemplatePackId": 7
              },
              {
                "Partition": 1,
                "Reference": "sample string 2",
                "Filename": "sample string 3",
                "FileExtension": "sample string 4",
                "TemplateType": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "TemplateOutputDocumentSubType": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "ContentType": "sample string 5",
                "PostDocGenerationHandler": {
                  "EntityType": {
                    "Id": 1,
                    "Name": "sample string 2",
                    "SystemName": "sample string 3"
                  },
                  "EntityId": 1,
                  "JobHandlerType": {
                    "Id": 1,
                    "Name": "sample string 2",
                    "SystemName": "sample string 3"
                  },
                  "Options": {
                    "sample string 1": "sample string 2",
                    "sample string 3": "sample string 4"
                  },
                  "DocumentSubType": {
                    "Id": 1,
                    "Name": "sample string 2",
                    "SystemName": "sample string 3"
                  },
                  "AccountingSystemId": 2,
                  "AgencyId": 3,
                  "JobHandlerName": "sample string 4"
                },
                "LetterTemplateId": 6,
                "EnvelopeTemplatePackId": 7
              }
            ],
            "PropertyRoleIds": [
              1,
              2
            ],
            "GroupRoleIds": [
              1,
              2
            ],
            "OwnsRoleId": 6,
            "ParentGroupId": 1,
            "PersonId": 1,
            "ContainsPrintable": true,
            "IsEmailCompatible": true,
            "IsTextCompatible": true,
            "IsBymCompatible": true,
            "PersonName": "sample string 11",
            "OutputPdf": true,
            "Created": "2026-08-04T22:21:29.1206613Z",
            "Expires": "2026-08-04T22:21:29.1206613Z",
            "CreatedByWorkflow": true,
            "GeneratedDocs": [
              1,
              2
            ]
          },
          "AlternateContactItemDataContract": [
            {
              "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
            },
            {
              "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
            }
          ]
        }
      ]
    },
    {
      "PersonName": "sample string 1",
      "EnvelopeDataContracts": [
        {
          "envelope": {
            "envelopeTemplateId": 1,
            "parentPackId": 2,
            "SackReference": "sample string 3",
            "Reference": "sample string 4",
            "FriendlyName": "sample string 5",
            "Letters": [
              {
                "Partition": 1,
                "Reference": "sample string 2",
                "Filename": "sample string 3",
                "FileExtension": "sample string 4",
                "TemplateType": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "TemplateOutputDocumentSubType": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "ContentType": "sample string 5",
                "PostDocGenerationHandler": {
                  "EntityType": {
                    "Id": 1,
                    "Name": "sample string 2",
                    "SystemName": "sample string 3"
                  },
                  "EntityId": 1,
                  "JobHandlerType": {
                    "Id": 1,
                    "Name": "sample string 2",
                    "SystemName": "sample string 3"
                  },
                  "Options": {
                    "sample string 1": "sample string 2",
                    "sample string 3": "sample string 4"
                  },
                  "DocumentSubType": {
                    "Id": 1,
                    "Name": "sample string 2",
                    "SystemName": "sample string 3"
                  },
                  "AccountingSystemId": 2,
                  "AgencyId": 3,
                  "JobHandlerName": "sample string 4"
                },
                "LetterTemplateId": 6,
                "EnvelopeTemplatePackId": 7
              },
              {
                "Partition": 1,
                "Reference": "sample string 2",
                "Filename": "sample string 3",
                "FileExtension": "sample string 4",
                "TemplateType": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "TemplateOutputDocumentSubType": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "ContentType": "sample string 5",
                "PostDocGenerationHandler": {
                  "EntityType": {
                    "Id": 1,
                    "Name": "sample string 2",
                    "SystemName": "sample string 3"
                  },
                  "EntityId": 1,
                  "JobHandlerType": {
                    "Id": 1,
                    "Name": "sample string 2",
                    "SystemName": "sample string 3"
                  },
                  "Options": {
                    "sample string 1": "sample string 2",
                    "sample string 3": "sample string 4"
                  },
                  "DocumentSubType": {
                    "Id": 1,
                    "Name": "sample string 2",
                    "SystemName": "sample string 3"
                  },
                  "AccountingSystemId": 2,
                  "AgencyId": 3,
                  "JobHandlerName": "sample string 4"
                },
                "LetterTemplateId": 6,
                "EnvelopeTemplatePackId": 7
              }
            ],
            "PropertyRoleIds": [
              1,
              2
            ],
            "GroupRoleIds": [
              1,
              2
            ],
            "OwnsRoleId": 6,
            "ParentGroupId": 1,
            "PersonId": 1,
            "ContainsPrintable": true,
            "IsEmailCompatible": true,
            "IsTextCompatible": true,
            "IsBymCompatible": true,
            "PersonName": "sample string 11",
            "OutputPdf": true,
            "Created": "2026-08-04T22:21:29.1206613Z",
            "Expires": "2026-08-04T22:21:29.1206613Z",
            "CreatedByWorkflow": true,
            "GeneratedDocs": [
              1,
              2
            ]
          },
          "AlternateContactItemDataContract": [
            {
              "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
            },
            {
              "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
            }
          ]
        },
        {
          "envelope": {
            "envelopeTemplateId": 1,
            "parentPackId": 2,
            "SackReference": "sample string 3",
            "Reference": "sample string 4",
            "FriendlyName": "sample string 5",
            "Letters": [
              {
                "Partition": 1,
                "Reference": "sample string 2",
                "Filename": "sample string 3",
                "FileExtension": "sample string 4",
                "TemplateType": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "TemplateOutputDocumentSubType": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "ContentType": "sample string 5",
                "PostDocGenerationHandler": {
                  "EntityType": {
                    "Id": 1,
                    "Name": "sample string 2",
                    "SystemName": "sample string 3"
                  },
                  "EntityId": 1,
                  "JobHandlerType": {
                    "Id": 1,
                    "Name": "sample string 2",
                    "SystemName": "sample string 3"
                  },
                  "Options": {
                    "sample string 1": "sample string 2",
                    "sample string 3": "sample string 4"
                  },
                  "DocumentSubType": {
                    "Id": 1,
                    "Name": "sample string 2",
                    "SystemName": "sample string 3"
                  },
                  "AccountingSystemId": 2,
                  "AgencyId": 3,
                  "JobHandlerName": "sample string 4"
                },
                "LetterTemplateId": 6,
                "EnvelopeTemplatePackId": 7
              },
              {
                "Partition": 1,
                "Reference": "sample string 2",
                "Filename": "sample string 3",
                "FileExtension": "sample string 4",
                "TemplateType": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "TemplateOutputDocumentSubType": {
                  "Id": 1,
                  "Name": "sample string 2",
                  "SystemName": "sample string 3"
                },
                "ContentType": "sample string 5",
                "PostDocGenerationHandler": {
                  "EntityType": {
                    "Id": 1,
                    "Name": "sample string 2",
                    "SystemName": "sample string 3"
                  },
                  "EntityId": 1,
                  "JobHandlerType": {
                    "Id": 1,
                    "Name": "sample string 2",
                    "SystemName": "sample string 3"
                  },
                  "Options": {
                    "sample string 1": "sample string 2",
                    "sample string 3": "sample string 4"
                  },
                  "DocumentSubType": {
                    "Id": 1,
                    "Name": "sample string 2",
                    "SystemName": "sample string 3"
                  },
                  "AccountingSystemId": 2,
                  "AgencyId": 3,
                  "JobHandlerName": "sample string 4"
                },
                "LetterTemplateId": 6,
                "EnvelopeTemplatePackId": 7
              }
            ],
            "PropertyRoleIds": [
              1,
              2
            ],
            "GroupRoleIds": [
              1,
              2
            ],
            "OwnsRoleId": 6,
            "ParentGroupId": 1,
            "PersonId": 1,
            "ContainsPrintable": true,
            "IsEmailCompatible": true,
            "IsTextCompatible": true,
            "IsBymCompatible": true,
            "PersonName": "sample string 11",
            "OutputPdf": true,
            "Created": "2026-08-04T22:21:29.1206613Z",
            "Expires": "2026-08-04T22:21:29.1206613Z",
            "CreatedByWorkflow": true,
            "GeneratedDocs": [
              1,
              2
            ]
          },
          "AlternateContactItemDataContract": [
            {
              "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
            },
            {
              "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
            }
          ]
        }
      ]
    }
  ],
  "PreviewOnly": true,
  "EnvelopeTemplatePackId": 3
}