POST api/list/stats/groups

Request Information

URI Parameters

None.

Body Parameters

Collection of GroupListFilterDataContract
NameDescriptionTypeAdditional information
BedroomsMin

integer

None.

PriceFrom

integer

None.

PriceTo

integer

None.

PriceType

string

None.

TagIds

Collection of integer

None.

Grades

Collection of string

None.

RoleTypes

Collection of string

None.

SourceId

integer

None.

OwningTeamIds

Collection of integer

None.

MatchType

MatchType

None.

FinancialStatus

string

None.

LastContactedFrom

date

None.

LastContactedTo

date

None.

TargetMoveInFrom

date

None.

TargetMoveInTo

date

None.

CreatedFrom

date

None.

CreatedTo

date

None.

SearchStatuses

Collection of string

None.

Sort

GroupListSort

None.

Ids

Collection of integer

None.

GroupIds

Collection of integer

None.

ExcludeInactive

boolean

None.

AdditionalIds

Collection of integer

None.

ExcludedIds

Collection of integer

None.

RegionIds

Collection of integer

None.

RegionSource

string

None.

RegionType

string

None.

FindIntersectingRegions

boolean

None.

ExcludeHasNoEmail

boolean

None.

Name

string

None.

CustomFilterConfig

string

None.

BranchId

integer

None.

BranchIds

Collection of integer

None.

EventBranchIds

Collection of integer

None.

Order

ListOrder

None.

SearchTerm

string

None.

FilterType

EnumDataContract

None.

ShowDeleted

boolean

None.

ShowCancelled

boolean

None.

OwningTeamId

integer

None.

Id

integer

None.

Request Formats

application/json, text/json

Sample:
[
  {
    "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-16T22:27:15.6616608Z",
    "LastContactedTo": "2018-11-16T22:27:15.6616608Z",
    "TargetMoveInFrom": "2018-11-16T22:27:15.6616608Z",
    "TargetMoveInTo": "2018-11-16T22:27:15.6616608Z",
    "CreatedFrom": "2018-11-16T22:27:15.6616608Z",
    "CreatedTo": "2018-11-16T22:27:15.6616608Z",
    "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-16T22:27:15.6616608Z",
    "LastContactedTo": "2018-11-16T22:27:15.6616608Z",
    "TargetMoveInFrom": "2018-11-16T22:27:15.6616608Z",
    "TargetMoveInTo": "2018-11-16T22:27:15.6616608Z",
    "CreatedFrom": "2018-11-16T22:27:15.6616608Z",
    "CreatedTo": "2018-11-16T22:27:15.6616608Z",
    "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
  }
]

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'IList`1'.

Response Information

Resource Description

PagedCollectionDataContractOfListStatsDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of ListStatsDataContract

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "Name": "sample string 1",
      "Value": 2
    },
    {
      "Name": "sample string 1",
      "Value": 2
    }
  ]
}