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

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

GroupPropertyMatchSortType

Default value is ScoreDesc

Body Parameters

GroupPropertyMatchFilterDataContract
NameDescriptionTypeAdditional information
BranchIds

Collection of integer

None.

NegotiatorId

integer

None.

ExcludeOfferAccepted

boolean

None.

ExcludeUnderOffer

boolean

None.

IncludedRoleIds

Collection of integer

None.

ExcludedRoleIds

Collection of integer

None.

ExcludeMailoutDays

integer

None.

OwningTeamId

integer

None.

MinScore

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "BranchIds": [
    1,
    2
  ],
  "NegotiatorId": 1,
  "ExcludeOfferAccepted": true,
  "ExcludeUnderOffer": true,
  "IncludedRoleIds": [
    1,
    2
  ],
  "ExcludedRoleIds": [
    1,
    2
  ],
  "ExcludeMailoutDays": 1,
  "OwningTeamId": 1,
  "MinScore": 3
}

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 'GroupPropertyMatchFilterDataContract'.

Response Information

Resource Description

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:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' 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 'JsonMediaTypeFormatter' 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]'.