POST api/list/groups/csv

Generates a csv file from selected group list items

Request Information

URI Parameters

None.

Body Parameters

GroupListCsvCommandDataContract
NameDescriptionTypeAdditional information
Filter

GroupListFilterDataContract

None.

Ids

Collection of integer

None.

ExcludedIds

Collection of integer

None.

Request Formats

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 3",
    "LastContactedFrom": "2020-07-03T22:48:28.189317Z",
    "LastContactedTo": "2020-07-03T22:48:28.189317Z",
    "LastContacted": {
      "FromStaticDate": "2020-07-03T22:48:28.189317Z",
      "ToStaticDate": "2020-07-03T22:48:28.189317Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "TargetMoveInFrom": "2020-07-03T22:48:28.189317Z",
    "TargetMoveInTo": "2020-07-03T22:48:28.189317Z",
    "TargetMoveIn": {
      "FromStaticDate": "2020-07-03T22:48:28.189317Z",
      "ToStaticDate": "2020-07-03T22:48:28.189317Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "CreatedFrom": "2020-07-03T22:48:28.189317Z",
    "CreatedTo": "2020-07-03T22:48:28.189317Z",
    "Created": {
      "FromStaticDate": "2020-07-03T22:48:28.189317Z",
      "ToStaticDate": "2020-07-03T22:48:28.189317Z",
      "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 5",
    "RegionType": "sample string 6",
    "FindIntersectingRegions": true,
    "ExcludeHasNoEmail": 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
  ]
}

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": "f6e8efb2-241d-45f3-ab82-cda0246594e6",
  "Success": true
}