GET api/documentgeneration/sackcontent/{sackReference}

Returns the detail of the all outstanding sacks

Request Information

URI Parameters

NameDescriptionTypeAdditional information
sackReference

string

Required

Body Parameters

None.

Response Information

Resource Description

Dezrez.Core.DataContracts.External.Api.DocumentGeneration.Query.GeneratededSackDataContract
NameDescriptionTypeAdditional information
FriendlyName

string

None.

GroupedEnvelopeDataContracts

Collection of Dezrez.Core.DataContracts.External.Api.DocumentGeneration.Query.GroupedEnvelopeDataContract

None.

PreviewOnly

boolean

None.

EnvelopeTemplatePackId

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "FriendlyName": "sample string 1",
  "GroupedEnvelopeDataContracts": [
    {
      "PersonName": "sample string 1",
      "EnvelopeDataContracts": [
        {
          "envelope": {
            "envelopeTemplateId": 1,
            "SackReference": "sample string 2",
            "Reference": "sample string 3",
            "FriendlyName": "sample string 4",
            "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
                },
                "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
                },
                "LetterTemplateId": 6,
                "EnvelopeTemplatePackId": 7
              }
            ],
            "PropertyRoleIds": [
              1,
              2
            ],
            "GroupRoleIds": [
              1,
              2
            ],
            "OwnsRoleId": 5,
            "ParentGroupId": 1,
            "PersonId": 1,
            "ContainsPrintable": true,
            "IsEmailCompatible": true,
            "IsTextCompatible": true,
            "IsBymCompatible": true,
            "PersonName": "sample string 10",
            "OutputPdf": true,
            "Created": "2024-11-14T07:46:30.8727636Z",
            "Expires": "2024-11-14T07:46:30.8727636Z",
            "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,
            "SackReference": "sample string 2",
            "Reference": "sample string 3",
            "FriendlyName": "sample string 4",
            "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
                },
                "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
                },
                "LetterTemplateId": 6,
                "EnvelopeTemplatePackId": 7
              }
            ],
            "PropertyRoleIds": [
              1,
              2
            ],
            "GroupRoleIds": [
              1,
              2
            ],
            "OwnsRoleId": 5,
            "ParentGroupId": 1,
            "PersonId": 1,
            "ContainsPrintable": true,
            "IsEmailCompatible": true,
            "IsTextCompatible": true,
            "IsBymCompatible": true,
            "PersonName": "sample string 10",
            "OutputPdf": true,
            "Created": "2024-11-14T07:46:30.8727636Z",
            "Expires": "2024-11-14T07:46:30.8727636Z",
            "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,
            "SackReference": "sample string 2",
            "Reference": "sample string 3",
            "FriendlyName": "sample string 4",
            "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
                },
                "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
                },
                "LetterTemplateId": 6,
                "EnvelopeTemplatePackId": 7
              }
            ],
            "PropertyRoleIds": [
              1,
              2
            ],
            "GroupRoleIds": [
              1,
              2
            ],
            "OwnsRoleId": 5,
            "ParentGroupId": 1,
            "PersonId": 1,
            "ContainsPrintable": true,
            "IsEmailCompatible": true,
            "IsTextCompatible": true,
            "IsBymCompatible": true,
            "PersonName": "sample string 10",
            "OutputPdf": true,
            "Created": "2024-11-14T07:46:30.8727636Z",
            "Expires": "2024-11-14T07:46:30.8727636Z",
            "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,
            "SackReference": "sample string 2",
            "Reference": "sample string 3",
            "FriendlyName": "sample string 4",
            "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
                },
                "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
                },
                "LetterTemplateId": 6,
                "EnvelopeTemplatePackId": 7
              }
            ],
            "PropertyRoleIds": [
              1,
              2
            ],
            "GroupRoleIds": [
              1,
              2
            ],
            "OwnsRoleId": 5,
            "ParentGroupId": 1,
            "PersonId": 1,
            "ContainsPrintable": true,
            "IsEmailCompatible": true,
            "IsTextCompatible": true,
            "IsBymCompatible": true,
            "PersonName": "sample string 10",
            "OutputPdf": true,
            "Created": "2024-11-14T07:46:30.8727636Z",
            "Expires": "2024-11-14T07:46:30.8727636Z",
            "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
}