POST api/progression/bulkwithdrawvaluations
Bulk withdrawal valuations from a property role
Request Information
URI Parameters
None.
Body Parameters
Dezrez.Core.DataContracts.External.Api.Group.Command.Delete.BulkWithdrawInstructionDataContractName | Description | Type | Additional information |
---|---|---|---|
Filter | Dezrez.Core.DataContracts.External.Api.Lists.Events.Filter.EventListFilterDataContract |
None. |
|
Ids | Collection of integer |
None. |
|
ExcludedIds | Collection of integer |
None. |
Request Formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{ "Filter": { "CreatedBy": [ 1, 2 ], "NegotiatorIds": [ 1, 1 ], "OwningTeamIds": [ 1, 1 ], "RoleIds": [ 1, 2 ], "GroupId": 1, "From": "2024-10-08T09:16:52.5492259Z", "To": "2024-10-08T09:16:52.5492259Z", "Date": { "FromStaticDate": "2024-10-08T09:16:52.5492259Z", "ToStaticDate": "2024-10-08T09:16:52.5492259Z", "PredefinedDateRange": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FromExpression": "sample string 1", "ToExpression": "sample string 2", "Id": 3 }, "UpcomingOnly": true, "CreatedFrom": "2024-10-08T09:16:52.5492259Z", "CreatedTo": "2024-10-08T09:16:52.5492259Z", "Created": { "FromStaticDate": "2024-10-08T09:16:52.5492259Z", "ToStaticDate": "2024-10-08T09:16:52.5492259Z", "PredefinedDateRange": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FromExpression": "sample string 1", "ToExpression": "sample string 2", "Id": 3 }, "OfferStatuses": [ { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" } ], "EventCategories": [ { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" } ], "EventTypes": [ { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" } ], "EventStatuses": [ { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" } ], "IncludeDrafts": true, "IncludeOnlyOriginalNotes": true, "ExcludedRevisedOffers": true, "ExcludedTypes": [ { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" } ], "RoleTypes": [ "sample string 1", "sample string 2" ], "ExcludeRoleTypes": [ "sample string 1", "sample string 2" ], "RoleStatuses": [ "sample string 1", "sample string 2" ], "PropertyId": 1, "Descriptions": { "sample string 1": "sample string 2", "sample string 3": "sample string 4" }, "FeedbackTaken": true, "FeedbackReported": true, "MethodsOfContact": [ { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" } ], "SortType": 0, "EventIds": [ 1, 2 ], "AdditionalIds": [ 1, 2 ], "ExcludedIds": [ 1, 2 ], "CleanInactiveAppointments": true, "UseMinimalMapping": true, "FilterNotes": 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 }, "Ids": [ 1, 2 ], "ExcludedIds": [ 1, 2 ] }
Response Information
Resource Description
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": "753f6587-8fe3-427b-a689-0979f8c0cb05", "Success": true }