POST api/documentgeneration/bulkpropertyownercommunication

Generates a bulk communication pack out to multiple vendors of properties. This will ignore the target type set, as the document could only ever find the vendor as the contact item, so it always defaults to a target type of vendor/owner

Request Information

URI Parameters

None.

Body Parameters

SendBulkPropertyListCommunicationDataContract
NameDescriptionTypeAdditional information
Filter

PropertyListFilterDataContract

None.

TargetType

EnumDataContract

None.

Subject

string

None.

RoleIds

Collection of integer

None.

ExcludedRoleIds

Collection of integer

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:
{
  "Filter": {
    "Ids": [
      1,
      2
    ],
    "NegotiatorIds": [
      1,
      2
    ],
    "OwningTeamIds": [
      1,
      2
    ],
    "ExchangedRecordedBy": [
      1,
      2
    ],
    "ExchangeFrom": "2020-12-01T15:51:25.1569763Z",
    "ExchangeTo": "2020-12-01T15:51:25.1569763Z",
    "Exchange": {
      "FromStaticDate": "2020-12-01T15:51:25.1569763Z",
      "ToStaticDate": "2020-12-01T15:51:25.1569763Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "CompletionsFrom": "2020-12-01T15:51:25.1569763Z",
    "CompletionsTo": "2020-12-01T15:51:25.1569763Z",
    "Completions": {
      "FromStaticDate": "2020-12-01T15:51:25.1569763Z",
      "ToStaticDate": "2020-12-01T15:51:25.1569763Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "OfferAcceptedFrom": "2020-12-01T15:51:25.1569763Z",
    "OfferAcceptedTo": "2020-12-01T15:51:25.1569763Z",
    "OfferAccepted": {
      "FromStaticDate": "2020-12-01T15:51:25.1569763Z",
      "ToStaticDate": "2020-12-01T15:51:25.1569763Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "InstructedFrom": "2020-12-01T15:51:25.1569763Z",
    "InstructedTo": "2020-12-01T15:51:25.1569763Z",
    "Instructed": {
      "FromStaticDate": "2020-12-01T15:51:25.1569763Z",
      "ToStaticDate": "2020-12-01T15:51:25.1569763Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "WithdrawnInstructionFrom": "2020-12-01T15:51:25.1569763Z",
    "WithdrawnInstructionTo": "2020-12-01T15:51:25.1569763Z",
    "WithdrawnInstruction": {
      "FromStaticDate": "2020-12-01T15:51:25.1569763Z",
      "ToStaticDate": "2020-12-01T15:51:25.1569763Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "ValuedFrom": "2020-12-01T15:51:25.1569763Z",
    "ValuedTo": "2020-12-01T15:51:25.1569763Z",
    "Valued": {
      "FromStaticDate": "2020-12-01T15:51:25.1569763Z",
      "ToStaticDate": "2020-12-01T15:51:25.1569763Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "WithdrawnValuationFrom": "2020-12-01T15:51:25.1726295Z",
    "WithdrawnValuationTo": "2020-12-01T15:51:25.1726295Z",
    "WithdrawnValuation": {
      "FromStaticDate": "2020-12-01T15:51:25.1569763Z",
      "ToStaticDate": "2020-12-01T15:51:25.1569763Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "CreatedFrom": "2020-12-01T15:51:25.1726295Z",
    "CreatedTo": "2020-12-01T15:51:25.1726295Z",
    "Created": {
      "FromStaticDate": "2020-12-01T15:51:25.1569763Z",
      "ToStaticDate": "2020-12-01T15:51:25.1569763Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "UpdatedFrom": "2020-12-01T15:51:25.1726295Z",
    "UpdatedTo": "2020-12-01T15:51:25.1726295Z",
    "Updated": {
      "FromStaticDate": "2020-12-01T15:51:25.1569763Z",
      "ToStaticDate": "2020-12-01T15:51:25.1569763Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "ContractEndDateFrom": "2020-12-01T15:51:25.1726295Z",
    "ContractEndDateTo": "2020-12-01T15:51:25.1726295Z",
    "ContractEndDate": {
      "FromStaticDate": "2020-12-01T15:51:25.1569763Z",
      "ToStaticDate": "2020-12-01T15:51:25.1569763Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "LetFrom": "2020-12-01T15:51:25.1726295Z",
    "LetTo": "2020-12-01T15:51:25.1726295Z",
    "Let": {
      "FromStaticDate": "2020-12-01T15:51:25.1569763Z",
      "ToStaticDate": "2020-12-01T15:51:25.1569763Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "BedroomsMin": 1,
    "PriceRangeMin": 1,
    "PriceRangeMax": 1,
    "PriceType": "sample string 2",
    "TagIds": [
      1,
      2
    ],
    "RoleTypes": [
      "sample string 1",
      "sample string 2"
    ],
    "RoleStatuses": [
      "sample string 1",
      "sample string 2"
    ],
    "PropertyTypes": [
      "sample string 1",
      "sample string 2"
    ],
    "MarketingFlags": {
      "sample string 1": true,
      "sample string 3": true
    },
    "Latitude": 1.1,
    "Longitude": 1.1,
    "MileRadius": 1.1,
    "Sort": 0,
    "RegionIds": [
      1,
      2
    ],
    "RegionId": 1,
    "RegionSource": "sample string 3",
    "RegionType": "sample string 4",
    "ReferralType": "sample string 5",
    "AdditionalIds": [
      1,
      2
    ],
    "ExcludedIds": [
      1,
      2
    ],
    "PropertyIds": [
      1,
      2
    ],
    "PropertyAddressIds": [
      "sample string 1",
      "sample string 2"
    ],
    "IsThereEpcValuesRecorded": true,
    "SearchOwnersWithTerm": true,
    "EpcExpiryDate": {
      "FromStaticDate": "2020-12-01T15:51:25.1569763Z",
      "ToStaticDate": "2020-12-01T15:51:25.1569763Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "PropertyMarketingDate": {
      "FromStaticDate": "2020-12-01T15:51:25.1569763Z",
      "ToStaticDate": "2020-12-01T15:51:25.1569763Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "IsEmbeddedSearchList": true,
    "PreviousPage": 7,
    "PreviousElasticSearchIndex": 8,
    "Name": "sample string 9",
    "CustomFilterConfig": "sample string 10",
    "BranchId": 1,
    "BranchIds": [
      1,
      2
    ],
    "EventBranchIds": [
      1,
      2
    ],
    "Order": 0,
    "SearchTerm": "sample string 11",
    "FilterType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "ShowDeleted": true,
    "ShowCancelled": true,
    "OwningTeamId": 14,
    "Id": 15
  },
  "TargetType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "Subject": "sample string 1",
  "RoleIds": [
    1,
    2
  ],
  "ExcludedRoleIds": [
    1,
    2
  ],
  "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": "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 13",
  "Id": 14
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Details of the job that has been invoked.

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": "3db20eb5-ca3c-4b68-bcfc-2757357df6ef",
  "Success": true
}