POST api/list/groupinterests/groupinterestidsfiltered

Get list of groups and what they are interested in.

Request Information

URI Parameters

None.

Body Parameters

Dezrez.Core.DataContracts.External.Api.Lists.GroupInterests.GroupInterestListFilterDataContract

Name	Type	Additional information
InterestFlags	Collection of string	None.
Origins	Collection of string	None.
Grades	Collection of string	None.
RoleTypes	Collection of string	None.
RoleStatuses	Collection of string	None.
LastContactedFrom	date	None.
LastContactedTo	date	None.
LastContacted	Dezrez.Core.DataContracts.External.Api.Lists.DateRangeFilterDataContract	None.
CreatedFrom	date	None.
CreatedTo	date	None.
Created	Dezrez.Core.DataContracts.External.Api.Lists.DateRangeFilterDataContract	None.
LandlordVendorFrom	date	None.
LandlordVendorTo	date	None.
LandlordVendor	Dezrez.Core.DataContracts.External.Api.Lists.DateRangeFilterDataContract	None.
Sort	Dezrez.Core.DataContracts.External.Api.Lists.GroupInterests.GroupInterestListSort	None.
GroupIds	Collection of integer	None.
OwningTeamIds	Collection of integer	None.
RoleIds	Collection of integer	None.
AdditionalIds	Collection of integer	None.
ExcludedIds	Collection of integer	None.
ExcludeHasNoEmail	boolean	None.
IsMarketingRoleTypeSearch	boolean	None.
HasValuationBooked	boolean	None.
HasSearch	boolean	None.
CompanyTypes	Collection of string	None.
Archived	boolean	None.
Name	string	None.
CustomFilterConfig	string	None.
BranchId	integer	None.
BranchIds	Collection of integer	None.
EventBranchIds	Collection of integer	None.
Order	Dezrez.Core.DataContracts.External.Api.Lists.ListOrder	None.
SearchTerm	string	None.
FilterType	Dezrez.Core.DataContracts.External.Api.System.EnumDataContract	None.
ShowDeleted	boolean	None.
ShowCancelled	boolean	None.
OwningTeamId	integer	None.
Id	integer	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "InterestFlags": [
    "sample string 1",
    "sample string 2"
  ],
  "Origins": [
    "sample string 1",
    "sample string 2"
  ],
  "Grades": [
    "sample string 1",
    "sample string 2"
  ],
  "RoleTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "RoleStatuses": [
    "sample string 1",
    "sample string 2"
  ],
  "LastContactedFrom": "2024-11-21T09:31:17.6663222Z",
  "LastContactedTo": "2024-11-21T09:31:17.6663222Z",
  "LastContacted": {
    "FromStaticDate": "2024-11-21T09:31:17.6663222Z",
    "ToStaticDate": "2024-11-21T09:31:17.6663222Z",
    "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:31:17.68195Z",
  "CreatedTo": "2024-11-21T09:31:17.68195Z",
  "Created": {
    "FromStaticDate": "2024-11-21T09:31:17.6663222Z",
    "ToStaticDate": "2024-11-21T09:31:17.6663222Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "LandlordVendorFrom": "2024-11-21T09:31:17.68195Z",
  "LandlordVendorTo": "2024-11-21T09:31:17.68195Z",
  "LandlordVendor": {
    "FromStaticDate": "2024-11-21T09:31:17.6663222Z",
    "ToStaticDate": "2024-11-21T09:31:17.6663222Z",
    "PredefinedDateRange": {
      "Id": 1,
      "Name": "sample string 2",
      "SystemName": "sample string 3"
    },
    "FromExpression": "sample string 1",
    "ToExpression": "sample string 2",
    "Id": 3
  },
  "Sort": 0,
  "GroupIds": [
    1,
    2
  ],
  "OwningTeamIds": [
    1,
    2
  ],
  "RoleIds": [
    1,
    2
  ],
  "AdditionalIds": [
    1,
    2
  ],
  "ExcludedIds": [
    1,
    2
  ],
  "ExcludeHasNoEmail": true,
  "IsMarketingRoleTypeSearch": true,
  "HasValuationBooked": true,
  "HasSearch": true,
  "CompanyTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "Archived": true,
  "Name": "sample string 2",
  "CustomFilterConfig": "sample string 3",
  "BranchId": 1,
  "BranchIds": [
    1,
    2
  ],
  "EventBranchIds": [
    1,
    2
  ],
  "Order": 0,
  "SearchTerm": "sample string 4",
  "FilterType": {
    "Id": 1,
    "Name": "sample string 2",
    "SystemName": "sample string 3"
  },
  "ShowDeleted": true,
  "ShowCancelled": true,
  "OwningTeamId": 7,
  "Id": 8
}

Response Information

Resource Description

PagedCollectionDataContractOfDezrez.Core.DataContracts.External.Api.Lists.Groups.GroupListPersonDataContract

Name	Type	Additional information
TotalCount	integer	None.
CurrentCount	integer	None.
PageSize	integer	None.
PageNumber	integer	None.
Collection	Collection of Dezrez.Core.DataContracts.External.Api.Lists.Groups.GroupListPersonDataContract	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "GroupId": 1,
      "PersonIds": [
        1,
        2
      ],
      "InterestRoleId": 2
    },
    {
      "GroupId": 1,
      "PersonIds": [
        1,
        2
      ],
      "InterestRoleId": 2
    }
  ]
}