POST api/list/groups/csv

Generates a csv file from selected group list items

Request Information

URI Parameters

None.

Body Parameters

Dezrez.Core.DataContracts.External.Api.Lists.GroupListCsvCommandDataContract

Name	Type	Additional information
Filter	Dezrez.Core.DataContracts.External.Api.Lists.Groups.Filter.GroupListFilterDataContract	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": {
    "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-11-21T09:39:21.7782128Z",
    "LastContactedTo": "2024-11-21T09:39:21.7782128Z",
    "LastContacted": {
      "FromStaticDate": "2024-11-21T09:39:21.7782128Z",
      "ToStaticDate": "2024-11-21T09:39:21.7782128Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "TargetMoveInFrom": "2024-11-21T09:39:21.7782128Z",
    "TargetMoveInTo": "2024-11-21T09:39:21.7782128Z",
    "TargetMoveIn": {
      "FromStaticDate": "2024-11-21T09:39:21.7782128Z",
      "ToStaticDate": "2024-11-21T09:39:21.7782128Z",
      "PredefinedDateRange": {
        "Id": 1,
        "Name": "sample string 2",
        "SystemName": "sample string 3"
      },
      "FromExpression": "sample string 1",
      "ToExpression": "sample string 2",
      "Id": 3
    },
    "CreatedFrom": "2024-11-21T09:39:21.7782128Z",
    "CreatedTo": "2024-11-21T09:39:21.7938348Z",
    "Created": {
      "FromStaticDate": "2024-11-21T09:39:21.7782128Z",
      "ToStaticDate": "2024-11-21T09:39:21.7782128Z",
      "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
  },
  "Ids": [
    1,
    2
  ],
  "ExcludedIds": [
    1,
    2
  ]
}

Response Information

Resource Description

Dezrez.Core.DataContracts.External.Api.Job.Query.Get.JobInvocationDetailsDataContract

Name	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": "867848ac-ff07-41e1-baa2-024df7a234d9",
  "Success": true
}