GET api/role/{id}/matches?pageSize={pageSize}&pageNumber={pageNumber}&adjustedAskingPrice={adjustedAskingPrice}&sort={sort}&minScore={minScore}

Get a list of groups that may be interested in this property role

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The id of the role to get the group matches for	integer	Required
pageSize	Number of results per page	integer	Default value is 5
pageNumber	Page number	integer	Default value is 1
adjustedAskingPrice	Override the asking price to show a different set of potential matches	decimal number	None.
sort	Sort order of results	Dezrez.Core.DataContracts.External.Api.Role.Query.Matches.RoleApplicantMatchSortType	Default value is ScoreDesc
minScore		integer	Default value is 0

Body Parameters

None.

Response Information

Resource Description

A list of applicant match data contracts for each matching group

PagedCollectionDataContractOfDezrez.Core.DataContracts.External.Api.Role.Query.Matches.RoleApplicantMatchDataContract

Name	Description	Type	Additional information
TotalCount		integer	None.
CurrentCount		integer	None.
PageSize		integer	None.
PageNumber		integer	None.
Collection		Collection of Dezrez.Core.DataContracts.External.Api.Role.Query.Matches.RoleApplicantMatchDataContract	None.

Response Formats