POST api/group/{id}/searching/{roleId}/matches?pageSize={pageSize}&pageNumber={pageNumber}&sort={sort}

Get property matches for a Searching Role for a Group

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Group Id

integer

Required

roleId

Role Id

integer

Required

pageSize

Amount of results per page

integer

Default value is 5

pageNumber

Page number

integer

Default value is 1

sort

How to sort the results

GroupPropertyMatchSortType

Default value is ScoreDesc

Body Parameters

Match filter

GroupPropertyMatchFilterDataContract
NameDescriptionTypeAdditional information
BranchIds

Collection of integer

None.

NegotiatorId

integer

None.

ExcludeOfferAccepted

boolean

None.

ExcludeUnderOffer

boolean

None.

MarketedFrom

date

None.

IncludedRoleIds

Collection of integer

None.

ExcludedRoleIds

Collection of integer

None.

ExcludeMailoutDays

integer

None.

OwningTeamId

integer

None.

MinScore

integer

None.

Sort

string

None.

Request Formats

application/json, text/json

Sample:
{
  "BranchIds": [
    1,
    2
  ],
  "NegotiatorId": 1,
  "ExcludeOfferAccepted": true,
  "ExcludeUnderOffer": true,
  "MarketedFrom": "2020-11-25T02:28:58.0994835Z",
  "IncludedRoleIds": [
    1,
    2
  ],
  "ExcludedRoleIds": [
    1,
    2
  ],
  "ExcludeMailoutDays": 1,
  "OwningTeamId": 1,
  "MinScore": 3,
  "Sort": "sample string 4"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A list of property roles

PagedCollectionDataContractOfGroupPropertyMatchDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of GroupPropertyMatchDataContract

None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.