POST api/documentgeneration/bulkgrouplistcommunication
Generates a bulk communication pack out to multiple clients in a list.
Request Information
URI Parameters
None.
Body Parameters
Dezrez.Core.DataContracts.External.Api.Lists.SendBulkGroupListCommunicationDataContractName | Description | Type | Additional information |
---|---|---|---|
Filter | Dezrez.Core.DataContracts.External.Api.Lists.Groups.Filter.GroupListFilterDataContract |
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": { "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 1", "sample string 2" ], "LastContactedFrom": "2024-10-29T00:17:58.0786666Z", "LastContactedTo": "2024-10-29T00:17:58.0786666Z", "LastContacted": { "FromStaticDate": "2024-10-29T00:17:58.0786666Z", "ToStaticDate": "2024-10-29T00:17:58.0786666Z", "PredefinedDateRange": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FromExpression": "sample string 1", "ToExpression": "sample string 2", "Id": 3 }, "TargetMoveInFrom": "2024-10-29T00:17:58.0786666Z", "TargetMoveInTo": "2024-10-29T00:17:58.0786666Z", "TargetMoveIn": { "FromStaticDate": "2024-10-29T00:17:58.0786666Z", "ToStaticDate": "2024-10-29T00:17:58.0786666Z", "PredefinedDateRange": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FromExpression": "sample string 1", "ToExpression": "sample string 2", "Id": 3 }, "CreatedFrom": "2024-10-29T00:17:58.0786666Z", "CreatedTo": "2024-10-29T00:17:58.0786666Z", "Created": { "FromStaticDate": "2024-10-29T00:17:58.0786666Z", "ToStaticDate": "2024-10-29T00:17:58.0786666Z", "PredefinedDateRange": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FromExpression": "sample string 1", "ToExpression": "sample string 2", "Id": 3 }, "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 4", "RegionType": "sample string 5", "FindIntersectingRegions": true, "ExcludeHasNoEmail": true, "Name": "sample string 7", "CustomFilterConfig": "sample string 8", "BranchId": 1, "BranchIds": [ 1, 2 ], "EventBranchIds": [ 1, 2 ], "Order": 0, "SearchTerm": "sample string 9", "FilterType": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "ShowDeleted": true, "ShowCancelled": true, "OwningTeamId": 12, "Id": 13 }, "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": "ddf4f23f-97aa-430f-a442-565f7dc017a5", "Success": true }