POST api/documentgeneration/custompack
Generates any correspondence and can allow you to overpost information to the correspondence 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
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
GeneratePackJobDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| OwnsRoleId |
The unique identifier of the related owns role resource. |
integer |
None. |
| PrimaryCompanyGroupRoleIds |
The unique identifiers of the related primary company group role resources. |
Collection of integer |
None. |
| SelectedPrimaryCompanyPersonId |
The unique identifier of the related selected primary company person resource. |
integer |
None. |
| SecondaryCompanyGroupRoleIds |
The unique identifiers of the related secondary company group role resources. |
Collection of integer |
None. |
| SelectedSecondaryCompanyPersonId |
The unique identifier of the related selected secondary company person resource. |
integer |
None. |
| PropertyRoleIds |
The unique identifiers of the related property role resources. |
Collection of integer |
None. |
| OwnerGroupRoleIds |
The unique identifiers of the related owner group role resources. |
Collection of integer |
None. |
| SelectedOwnerPersonId |
The unique identifier of the related selected owner person resource. |
integer |
None. |
| TenantGroupRoleIds |
The unique identifiers of the related tenant group role resources. |
Collection of integer |
None. |
| SelectedTenantPersonId |
The unique identifier of the related selected tenant person resource. |
integer |
None. |
| ApplicantGroupRoleIds |
The unique identifiers of the related applicant group role resources. |
Collection of integer |
None. |
| SelectedApplicantPersonId |
The unique identifier of the related selected applicant person resource. |
integer |
None. |
| GuarantorGroupRoleIds |
The unique identifiers of the related guarantor group role resources. |
Collection of integer |
None. |
| SelectedGuarantorPersonId |
The unique identifier of the related selected guarantor person resource. |
integer |
None. |
| EventId |
The unique identifier of the related event resource. |
integer |
None. |
| AgreementId |
The unique identifier of the related agreement resource. |
integer |
None. |
| ReferenceAgreementId |
The unique identifier of the related reference agreement resource. |
integer |
None. |
| PMBaseEntityJSONObject |
The pm base entity json object value. |
string |
None. |
| CertificateId |
The unique identifier of the related certificate resource. |
integer |
None. |
| SackFriendlyName |
The sack friendly name value. |
string |
None. |
| EnvelopeTemplatePackId |
The unique identifier of the related envelope template pack resource. |
integer |
None. |
| BrandId |
The unique identifier of the related brand resource. |
integer |
None. |
| BranchId |
The unique identifier of the related branch resource. |
integer |
None. |
| NegotiatorPpId |
The unique identifier of the related negotiator pp resource. |
integer |
None. |
| CustomText |
The custom text value. |
string |
None. |
| EnvelopeProcessingMethod |
The envelope processing method value. |
EnumDataContract |
None. |
| AutoProcessSack |
Indicates whether auto process sack is true. |
boolean |
None. |
| SendToDrafts |
Indicates whether send to drafts is true. |
boolean |
None. |
| SendToConveyancing |
Indicates whether send to conveyancing is true. |
boolean |
None. |
| PrintedOnHeaded |
Indicates whether printed on headed is true. |
boolean |
None. |
| WorkflowIndex |
The workflow index value. |
integer |
None. |
| DestinationPrintBagName |
The destination print bag name value. |
string |
None. |
| PostDocGenerationHandler |
The post doc generation handler value. |
PostDocGenerationHandlerDataContract |
None. |
| PreviewOnly |
Indicates whether preview only is true. |
boolean |
None. |
| EmailSubject |
The email subject value. |
string |
None. |
| Attachments |
The collection of attachments. |
Collection of DocumentDataContract |
None. |
| Id |
The unique identifier of this resource. |
integer |
None. |
Request Formats
application/x-www-form-urlencoded
Sample not available.
application/json
Sample not available.
text/json
Sample not available.
Response Information
Resource Description
Details of the job that has been invoked.
JobInvocationDetailsDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| SupportsCancellation |
Indicates whether supports cancellation is true. |
boolean |
None. |
| ReportsProgress |
Indicates whether reports progress is true. |
boolean |
None. |
| InitialStatusText |
The initial status text value. |
string |
None. |
| JobReference |
The job reference globally unique identifier. |
globally unique identifier |
None. |
| Success |
Indicates whether success is true. |
boolean |
None. |
Response Formats
application/json, text/json
{
"SupportsCancellation": true,
"ReportsProgress": true,
"InitialStatusText": "sample string 3",
"JobReference": "db08d733-2d6b-4a32-8366-d83d56db2cf7",
"Success": true
}