POST api/documentgeneration/custompack

Generates any correspondence and can allow you to overpost information to the correspondence

Request Information

URI Parameters

None.

Body Parameters

broad contract that allows for overposting and underposting, however you must specify a correspondence Id you must then follow the validation rules for the for that individual correspondence type, each route to the controller is named in the same way as the enumerated correspondence type system name, and the mappings for the specific class to the GeneratePackJobDataContract are detailed in the each individual simplified contract

Dezrez.Core.DataContracts.External.Api.DocumentGeneration.Commands.GeneratePackJobDataContract

Name	Type	Additional information
OwnsRoleId	integer	None.
PrimaryCompanyGroupRoleIds	Collection of integer	None.
SelectedPrimaryCompanyPersonId	integer	None.
SecondaryCompanyGroupRoleIds	Collection of integer	None.
SelectedSecondaryCompanyPersonId	integer	None.
PropertyRoleIds	Collection of integer	None.
OwnerGroupRoleIds	Collection of integer	None.
SelectedOwnerPersonId	integer	None.
TenantGroupRoleIds	Collection of integer	None.
SelectedTenantPersonId	integer	None.
ApplicantGroupRoleIds	Collection of integer	None.
SelectedApplicantPersonId	integer	None.
GuarantorGroupRoleIds	Collection of integer	None.
SelectedGuarantorPersonId	integer	None.
EventId	integer	None.
AgreementId	integer	None.
ReferenceAgreementId	integer	None.
PMBaseEntityJSONObject	string	None.
SackFriendlyName	string	None.
EnvelopeTemplatePackId	integer	None.
BrandId	integer	None.
BranchId	integer	None.
NegotiatorPpId	integer	None.
CustomText	string	None.
EnvelopeProcessingMethod	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
AutoProcessSack	boolean	None.
SendToDrafts	boolean	None.
PrintedOnHeaded	boolean	None.
WorkflowIndex	integer	None.
DestinationPrintBagName	string	None.
PostDocGenerationHandler	Dezrez.Core.DataContracts.External.Api.DocumentGeneration.Query.PostDocGenerationHandlerDataContract	None.
PreviewOnly	boolean	None.
EmailSubject	string	None.
Id	integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'GeneratePackJobDataContract'.

application/json, text/json

Sample:

{
  "OwnsRoleId": 1,
  "PrimaryCompanyGroupRoleIds": [
    1,
    2
  ],
  "SelectedPrimaryCompanyPersonId": 1,
  "SecondaryCompanyGroupRoleIds": [
    1,
    2
  ],
  "SelectedSecondaryCompanyPersonId": 1,
  "PropertyRoleIds": [
    1,
    2
  ],
  "OwnerGroupRoleIds": [
    1,
    2
  ],
  "SelectedOwnerPersonId": 1,
  "TenantGroupRoleIds": [
    1,
    2
  ],
  "SelectedTenantPersonId": 1,
  "ApplicantGroupRoleIds": [
    1,
    2
  ],
  "SelectedApplicantPersonId": 1,
  "GuarantorGroupRoleIds": [
    1,
    2
  ],
  "SelectedGuarantorPersonId": 1,
  "EventId": 2,
  "AgreementId": 3,
  "ReferenceAgreementId": 4,
  "PMBaseEntityJSONObject": "sample string 5",
  "SackFriendlyName": "sample string 6",
  "EnvelopeTemplatePackId": 7,
  "BrandId": 8,
  "BranchId": 1,
  "NegotiatorPpId": 9,
  "CustomText": "sample string 10",
  "EnvelopeProcessingMethod": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "AutoProcessSack": true,
  "SendToDrafts": true,
  "PrintedOnHeaded": true,
  "WorkflowIndex": 14,
  "DestinationPrintBagName": "sample string 15",
  "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
  },
  "PreviewOnly": true,
  "EmailSubject": "sample string 17",
  "Id": 18
}

Response Information

Resource Description

Details of the job that has been invoked.

Dezrez.Core.DataContracts.External.Api.Job.Query.Get.JobInvocationDetailsDataContract

Name	Type	Additional information
SupportsCancellation	boolean	None.
ReportsProgress	boolean	None.
InitialStatusText	string	None.
JobReference	globally unique identifier	None.
Success	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "SupportsCancellation": true,
  "ReportsProgress": true,
  "InitialStatusText": "sample string 3",
  "JobReference": "06aef1c9-b0f0-448d-962b-1c3251df5433",
  "Success": true
}