POST api/progression/bulkwithdrawvaluations

Bulk withdrawal valuations from a property role

Request Information

URI Parameters

None.

Body Parameters

BulkWithdrawInstructionDataContract
NameDescriptionTypeAdditional information
Filter

EventListFilterDataContract

None.

Ids

Collection of integer

None.

ExcludedIds

Collection of integer

None.

Request Formats

application/json, text/json

Sample:
{
  "Filter": {
    "CreatedBy": [
      1,
      2
    ],
    "NegotiatorIds": [
      1,
      1
    ],
    "OwningTeamIds": [
      1,
      1
    ],
    "RoleIds": [
      1,
      2
    ],
    "GroupId": 1,
    "From": "2020-07-02T14:44:30.4123846Z",
    "To": "2020-07-02T14:44:30.4123846Z",
    "Date": {
      "FromStaticDate": "2020-07-02T14:44:30.4123846Z",
      "ToStaticDate": "2020-07-02T14:44:30.4123846Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "UpcomingOnly": true,
    "CreatedFrom": "2020-07-02T14:44:30.4123846Z",
    "CreatedTo": "2020-07-02T14:44:30.4123846Z",
    "Created": {
      "FromStaticDate": "2020-07-02T14:44:30.4123846Z",
      "ToStaticDate": "2020-07-02T14:44:30.4123846Z",
      "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
    ],
    "Name": "sample string 5",
    "CustomFilterConfig": "sample string 6",
    "BranchId": 1,
    "BranchIds": [
      1,
      2
    ],
    "EventBranchIds": [
      1,
      2
    ],
    "Order": 0,
    "SearchTerm": "sample string 7",
    "FilterType": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "ShowDeleted": true,
    "ShowCancelled": true,
    "OwningTeamId": 10,
    "Id": 11
  },
  "Ids": [
    1,
    2
  ],
  "ExcludedIds": [
    1,
    2
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

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": "85b124f1-942e-4324-9413-1f150c9328d3",
  "Success": true
}