GET api/list/groups/filters?context={context}&roleType={roleType}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
context

ListContext

Default value is Agency

roleType

string

Default value is

Body Parameters

None.

Response Information

Resource Description

PagedCollectionDataContractOfGroupListFilterDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of GroupListFilterDataContract

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "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": "2018-11-16T20:09:57.6216245Z",
      "LastContactedTo": "2018-11-16T20:09:57.6216245Z",
      "TargetMoveInFrom": "2018-11-16T20:09:57.6216245Z",
      "TargetMoveInTo": "2018-11-16T20:09:57.6216245Z",
      "CreatedFrom": "2018-11-16T20:09:57.6216245Z",
      "CreatedTo": "2018-11-16T20:09:57.6216245Z",
      "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
    },
    {
      "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": "2018-11-16T20:09:57.6216245Z",
      "LastContactedTo": "2018-11-16T20:09:57.6216245Z",
      "TargetMoveInFrom": "2018-11-16T20:09:57.6216245Z",
      "TargetMoveInTo": "2018-11-16T20:09:57.6216245Z",
      "CreatedFrom": "2018-11-16T20:09:57.6216245Z",
      "CreatedTo": "2018-11-16T20:09:57.6216245Z",
      "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
    }
  ]
}