GET api/list/groups/filters?context={context}&roleType={roleType}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
context | Dezrez.Core.DataContracts.External.Api.Lists.Events.ListContext |
Default value is Agency |
|
roleType | string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
PagedCollectionDataContractOfDezrez.Core.DataContracts.External.Api.Lists.Groups.Filter.GroupListFilterDataContractName | Description | 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.Filter.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 1", "sample string 2" ], "LastContactedFrom": "2024-10-11T17:31:47.6687714Z", "LastContactedTo": "2024-10-11T17:31:47.6687714Z", "LastContacted": { "FromStaticDate": "2024-10-11T17:31:47.6687714Z", "ToStaticDate": "2024-10-11T17:31:47.6687714Z", "PredefinedDateRange": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FromExpression": "sample string 1", "ToExpression": "sample string 2", "Id": 3 }, "TargetMoveInFrom": "2024-10-11T17:31:47.6687714Z", "TargetMoveInTo": "2024-10-11T17:31:47.6687714Z", "TargetMoveIn": { "FromStaticDate": "2024-10-11T17:31:47.6687714Z", "ToStaticDate": "2024-10-11T17:31:47.6687714Z", "PredefinedDateRange": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FromExpression": "sample string 1", "ToExpression": "sample string 2", "Id": 3 }, "CreatedFrom": "2024-10-11T17:31:47.6687714Z", "CreatedTo": "2024-10-11T17:31:47.6687714Z", "Created": { "FromStaticDate": "2024-10-11T17:31:47.6687714Z", "ToStaticDate": "2024-10-11T17:31:47.6687714Z", "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 }, { "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-10-11T17:31:47.6687714Z", "LastContactedTo": "2024-10-11T17:31:47.6687714Z", "LastContacted": { "FromStaticDate": "2024-10-11T17:31:47.6687714Z", "ToStaticDate": "2024-10-11T17:31:47.6687714Z", "PredefinedDateRange": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FromExpression": "sample string 1", "ToExpression": "sample string 2", "Id": 3 }, "TargetMoveInFrom": "2024-10-11T17:31:47.6687714Z", "TargetMoveInTo": "2024-10-11T17:31:47.6687714Z", "TargetMoveIn": { "FromStaticDate": "2024-10-11T17:31:47.6687714Z", "ToStaticDate": "2024-10-11T17:31:47.6687714Z", "PredefinedDateRange": { "Id": 1, "Name": "sample string 2", "SystemName": "sample string 3" }, "FromExpression": "sample string 1", "ToExpression": "sample string 2", "Id": 3 }, "CreatedFrom": "2024-10-11T17:31:47.6687714Z", "CreatedTo": "2024-10-11T17:31:47.6687714Z", "Created": { "FromStaticDate": "2024-10-11T17:31:47.6687714Z", "ToStaticDate": "2024-10-11T17:31:47.6687714Z", "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 } ] }