POST api/documentgeneration/multipropertymatch

Request Information

URI Parameters

None.

Body Parameters

SendMultiplePropertyMatchToApplicantListPackDataContract
NameDescriptionTypeAdditional information
GroupSearchingRoleIds

Collection of integer

None.

ExcludedGroupSearchingRoleIds

Collection of integer

None.

MinNumberOfProperties

integer

None.

MaxNumberOfProperties

integer

None.

MinScore

decimal number

None.

IncludePropertiesSentBefore

boolean

None.

WithinDays

integer

None.

ExcludeOfferAccepted

boolean

None.

Filter

GroupListFilterDataContract

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/json, text/json

Sample:
{
  "GroupSearchingRoleIds": [
    1,
    2
  ],
  "ExcludedGroupSearchingRoleIds": [
    1,
    2
  ],
  "MinNumberOfProperties": 1,
  "MaxNumberOfProperties": 2,
  "MinScore": 3.1,
  "IncludePropertiesSentBefore": true,
  "WithinDays": 5,
  "ExcludeOfferAccepted": true,
  "Filter": {
    "BedroomsMin": 1,
    "PriceFrom": 1,
    "PriceTo": 1,
    "PriceType": "sample string 2",
    "TagIds": [
      1,
      2
    ],
    "Grades": [
      "sample string 1",
      "sample string 2"
    ],
    "RoleTypes": [
      "sample string 1",
      "sample string 2"
    ],
    "SourceId": 1,
    "OwningTeamIds": [
      1,
      2
    ],
    "MatchType": 0,
    "FinancialStatus": "sample string 3",
    "LastContactedFrom": "2018-11-12T19:43:18.9554862Z",
    "LastContactedTo": "2018-11-12T19:43:18.9554862Z",
    "TargetMoveInFrom": "2018-11-12T19:43:18.9554862Z",
    "TargetMoveInTo": "2018-11-12T19:43:18.9554862Z",
    "CreatedFrom": "2018-11-12T19:43:18.9554862Z",
    "CreatedTo": "2018-11-12T19:43:18.9554862Z",
    "SearchStatuses": [
      "sample string 1",
      "sample string 2"
    ],
    "Sort": 0,
    "Ids": [
      1,
      2
    ],
    "GroupIds": [
      1,
      2
    ],
    "ExcludeInactive": true,
    "AdditionalIds": [
      1,
      2
    ],
    "ExcludedIds": [
      1,
      2
    ],
    "RegionIds": [
      1,
      2
    ],
    "RegionSource": "sample string 5",
    "RegionType": "sample string 6",
    "FindIntersectingRegions": true,
    "ExcludeHasNoEmail": true,
    "Name": "sample string 8",
    "CustomFilterConfig": "sample string 9",
    "BranchId": 1,
    "BranchIds": [
      1,
      2
    ],
    "EventBranchIds": [
      1,
      2
    ],
    "Order": 0,
    "SearchTerm": "sample string 10",
    "FilterType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "ShowDeleted": true,
    "ShowCancelled": true,
    "OwningTeamId": 13,
    "Id": 14
  },
  "SackFriendlyName": "sample string 7",
  "EnvelopeTemplatePackId": 8,
  "BrandId": 9,
  "BranchId": 1,
  "NegotiatorPpId": 10,
  "CustomText": "sample string 11",
  "EnvelopeProcessingMethod": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "AutoProcessSack": true,
  "SendToDrafts": true,
  "PrintedOnHeaded": true,
  "WorkflowIndex": 15,
  "DestinationPrintBagName": "sample string 16",
  "PostDocGenerationHandler": {
    "EntityType": "sample string 1",
    "EntityId": 2,
    "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"
    }
  },
  "PreviewOnly": true,
  "EmailSubject": "sample string 18",
  "Id": 19
}

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 'SendMultiplePropertyMatchToApplicantListPackDataContract'.

Response Information

Resource Description

JobInvocationDetailsDataContract
NameDescriptionTypeAdditional 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": "e0c37fb1-3c12-4a46-9a79-cf338b03e95a",
  "Success": true
}