POST api/documentgeneration/singlelettingspropertymatch
Generates a correspondence to multiple applicants, sending them all the same letting property role
Request Information
URI Parameters
None.
Body Parameters
SendSinglePropertyMatchToApplicantListPackDataContract| Name | Description | Type | Additional information |
|---|---|---|---|
| PropertyRoleId | integer |
None. |
|
| ApplicantRoleIds | Collection of integer |
None. |
|
| ExcludedApplicantRoleIds | Collection of integer |
None. |
|
| Filter | RoleApplicantMatchFilterDataContract |
None. |
|
| SackFriendlyName | string |
None. |
|
| EnvelopeTemplatePackId | integer |
None. |
|
| BrandId | integer |
None. |
|
| BranchId | integer |
None. |
|
| NegotiatorPpId | integer |
None. |
|
| CustomText | string |
None. |
|
| EnvelopeProcessingMethod | EnumDataContract |
None. |
|
| AutoProcessSack | boolean |
None. |
|
| SendToDrafts | boolean |
None. |
|
| PrintedOnHeaded | boolean |
None. |
|
| WorkflowIndex | integer |
None. |
|
| DestinationPrintBagName | string |
None. |
|
| PostDocGenerationHandler | PostDocGenerationHandlerDataContract |
None. |
|
| PreviewOnly | boolean |
None. |
|
| EmailSubject | string |
None. |
|
| Attachments | Collection of DocumentDataContract |
None. |
|
| Id | integer |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json
Sample:
Sample not available.
text/json
Sample:
Sample not available.
Response Information
Resource Description
JobInvocationDetailsDataContract| Name | Description | 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": "5f687ca5-4aca-4f02-b86f-0e86077f140a",
"Success": true
}