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	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.
Id	integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "PropertyRoleId": 1,
  "ApplicantRoleIds": [
    1,
    2
  ],
  "ExcludedApplicantRoleIds": [
    1,
    2
  ],
  "Filter": {
    "Grades": [
      "sample string 1",
      "sample string 2"
    ],
    "FinancialStatus": [
      "sample string 1",
      "sample string 2"
    ],
    "ExcludeMailoutDays": 1,
    "OwningTeamId": 1,
    "BranchIds": [
      1,
      2
    ],
    "IncludedRoleIds": [
      1,
      2
    ],
    "ExcludedRoleIds": [
      1,
      2
    ],
    "MinScore": 1
  },
  "SackFriendlyName": "sample string 2",
  "EnvelopeTemplatePackId": 3,
  "BrandId": 4,
  "BranchId": 1,
  "NegotiatorPpId": 5,
  "CustomText": "sample string 6",
  "EnvelopeProcessingMethod": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "AutoProcessSack": true,
  "SendToDrafts": true,
  "PrintedOnHeaded": true,
  "WorkflowIndex": 10,
  "DestinationPrintBagName": "sample string 11",
  "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 13",
  "Id": 14
}

Response Information

Resource Description

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": "044af16c-bbf9-4d27-a68d-acef2315f7b9",
  "Success": true
}