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
Dezrez.Core.DataContracts.External.Api.Lists.SendBulkPropertyListCommunicationDataContractName | Description | Type | Additional information |
---|---|---|---|
Filter | Dezrez.Core.DataContracts.External.Api.Lists.Property.Filter.PropertyListFilterDataContract |
None. |
|
TargetType | Dezrez.Core.DataContracts.External.Api.System.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 | Dezrez.Core.DataContracts.External.Api.System.EnumDataContract |
None. |
|
AutoProcessSack | boolean |
None. |
|
SendToDrafts | boolean |
None. |
|
PrintedOnHeaded | boolean |
None. |
|
WorkflowIndex | integer |
None. |
|
DestinationPrintBagName | string |
None. |
|
PostDocGenerationHandler | Dezrez.Core.DataContracts.External.Api.DocumentGeneration.Query.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:
{ "Filter": { "Ids": [ 1, 2 ], "NegotiatorIds": [ 1, 2 ], "OwningTeamIds": [ 1, 2 ], "ExchangedRecordedBy": [ 1, 2 ], "ExchangeFrom": "2024-10-15T18:20:21.6808902Z", "ExchangeTo": "2024-10-15T18:20:21.6808902Z", "Exchange": { "FromStaticDate": "2024-10-15T18:20:21.6808902Z", "ToStaticDate": "2024-10-15T18:20:21.6808902Z", "PredefinedDateRange": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FromExpression": "sample string 1", "ToExpression": "sample string 2", "Id": 3 }, "CompletionsFrom": "2024-10-15T18:20:21.6808902Z", "CompletionsTo": "2024-10-15T18:20:21.6808902Z", "Completions": { "FromStaticDate": "2024-10-15T18:20:21.6808902Z", "ToStaticDate": "2024-10-15T18:20:21.6808902Z", "PredefinedDateRange": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FromExpression": "sample string 1", "ToExpression": "sample string 2", "Id": 3 }, "OfferAcceptedFrom": "2024-10-15T18:20:21.6808902Z", "OfferAcceptedTo": "2024-10-15T18:20:21.6808902Z", "OfferAccepted": { "FromStaticDate": "2024-10-15T18:20:21.6808902Z", "ToStaticDate": "2024-10-15T18:20:21.6808902Z", "PredefinedDateRange": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FromExpression": "sample string 1", "ToExpression": "sample string 2", "Id": 3 }, "InstructedFrom": "2024-10-15T18:20:21.6808902Z", "InstructedTo": "2024-10-15T18:20:21.6808902Z", "Instructed": { "FromStaticDate": "2024-10-15T18:20:21.6808902Z", "ToStaticDate": "2024-10-15T18:20:21.6808902Z", "PredefinedDateRange": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FromExpression": "sample string 1", "ToExpression": "sample string 2", "Id": 3 }, "WithdrawnInstructionFrom": "2024-10-15T18:20:21.6808902Z", "WithdrawnInstructionTo": "2024-10-15T18:20:21.6808902Z", "WithdrawnInstruction": { "FromStaticDate": "2024-10-15T18:20:21.6808902Z", "ToStaticDate": "2024-10-15T18:20:21.6808902Z", "PredefinedDateRange": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FromExpression": "sample string 1", "ToExpression": "sample string 2", "Id": 3 }, "ValuedFrom": "2024-10-15T18:20:21.6808902Z", "ValuedTo": "2024-10-15T18:20:21.6808902Z", "Valued": { "FromStaticDate": "2024-10-15T18:20:21.6808902Z", "ToStaticDate": "2024-10-15T18:20:21.6808902Z", "PredefinedDateRange": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FromExpression": "sample string 1", "ToExpression": "sample string 2", "Id": 3 }, "WithdrawnValuationFrom": "2024-10-15T18:20:21.6808902Z", "WithdrawnValuationTo": "2024-10-15T18:20:21.6808902Z", "WithdrawnValuation": { "FromStaticDate": "2024-10-15T18:20:21.6808902Z", "ToStaticDate": "2024-10-15T18:20:21.6808902Z", "PredefinedDateRange": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FromExpression": "sample string 1", "ToExpression": "sample string 2", "Id": 3 }, "CreatedFrom": "2024-10-15T18:20:21.6808902Z", "CreatedTo": "2024-10-15T18:20:21.6808902Z", "Created": { "FromStaticDate": "2024-10-15T18:20:21.6808902Z", "ToStaticDate": "2024-10-15T18:20:21.6808902Z", "PredefinedDateRange": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FromExpression": "sample string 1", "ToExpression": "sample string 2", "Id": 3 }, "UpdatedFrom": "2024-10-15T18:20:21.6808902Z", "UpdatedTo": "2024-10-15T18:20:21.6808902Z", "Updated": { "FromStaticDate": "2024-10-15T18:20:21.6808902Z", "ToStaticDate": "2024-10-15T18:20:21.6808902Z", "PredefinedDateRange": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FromExpression": "sample string 1", "ToExpression": "sample string 2", "Id": 3 }, "ContractEndDateFrom": "2024-10-15T18:20:21.6808902Z", "ContractEndDateTo": "2024-10-15T18:20:21.6808902Z", "ContractEndDate": { "FromStaticDate": "2024-10-15T18:20:21.6808902Z", "ToStaticDate": "2024-10-15T18:20:21.6808902Z", "PredefinedDateRange": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FromExpression": "sample string 1", "ToExpression": "sample string 2", "Id": 3 }, "LetFrom": "2024-10-15T18:20:21.6808902Z", "LetTo": "2024-10-15T18:20:21.6808902Z", "Let": { "FromStaticDate": "2024-10-15T18:20:21.6808902Z", "ToStaticDate": "2024-10-15T18:20:21.6808902Z", "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": "2024-10-15T18:20:21.6808902Z", "ToStaticDate": "2024-10-15T18:20:21.6808902Z", "PredefinedDateRange": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FromExpression": "sample string 1", "ToExpression": "sample string 2", "Id": 3 }, "PropertyMarketingDate": { "FromStaticDate": "2024-10-15T18:20:21.6808902Z", "ToStaticDate": "2024-10-15T18:20:21.6808902Z", "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, "ClosingDate": { "FromStaticDate": "2024-10-15T18:20:21.6808902Z", "ToStaticDate": "2024-10-15T18:20:21.6808902Z", "PredefinedDateRange": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FromExpression": "sample string 1", "ToExpression": "sample string 2", "Id": 3 }, "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": { "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
Details of the job that has been invoked.
Dezrez.Core.DataContracts.External.Api.Job.Query.Get.JobInvocationDetailsDataContractName | 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": "01a73394-9c1d-4a50-b0fa-69561e7d420a", "Success": true }