GET 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

integer

Required

roleId

integer

Required

pageSize

integer

Default value is 5

pageNumber

integer

Default value is 1

sort

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

Default value is ScoreDesc

Body Parameters

None.

Response Information

Resource Description

A list of Searching Roles

PagedCollectionDataContractOfDezrez.Core.DataContracts.External.Api.Group.Query.PropertyMatches.GroupPropertyMatchDataContract
NameDescriptionTypeAdditional 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:

An exception has occurred while using the formatter 'Dezrez.Core.Client.Common.Formatters.SanitizingJsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected for property 'Group' with type 'Dezrez.Core.DataContracts.External.Api.Group.Query.Get.GroupDataContract'. Path 'Collection[0].Role.OwningTeam.PreferredCompanies[0]'.

text/json

Sample:

An exception has occurred while using the formatter 'Dezrez.Core.Client.Common.Formatters.SanitizingJsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected for property 'Group' with type 'Dezrez.Core.DataContracts.External.Api.Group.Query.Get.GroupDataContract'. Path 'Collection[0].Role.OwningTeam.PreferredCompanies[0]'.