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

Name	Description	Type	Additional 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	Dezrez.Core.DataContracts.External.Api.Group.Query.PropertyMatches.GroupPropertyMatchSortType	Default value is ScoreDesc

Body Parameters

Match filter

Dezrez.Core.DataContracts.External.Api.Group.Query.PropertyMatches.GroupPropertyMatchFilterDataContract

Name	Type	Additional 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/x-www-form-urlencoded

Sample:

Sample not available.

application/json, text/json

Sample:

{
  "BranchIds": [
    1,
    2
  ],
  "NegotiatorId": 1,
  "ExcludeOfferAccepted": true,
  "ExcludeUnderOffer": true,
  "MarketedFrom": "2024-04-20T14:03:05.2364748Z",
  "IncludedRoleIds": [
    1,
    2
  ],
  "ExcludedRoleIds": [
    1,
    2
  ],
  "ExcludeMailoutDays": 1,
  "OwningTeamId": 1,
  "MinScore": 3,
  "Sort": "sample string 4"
}

Response Information

Resource Description

A list of property roles

PagedCollectionDataContractOfDezrez.Core.DataContracts.External.Api.Group.Query.PropertyMatches.GroupPropertyMatchDataContract

Name	Type	Additional information
TotalCount	integer	None.
CurrentCount	integer	None.
PageSize	integer	None.
PageNumber	integer	None.
Collection	Collection of Dezrez.Core.DataContracts.External.Api.Group.Query.PropertyMatches.GroupPropertyMatchDataContract	None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.