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

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

Request Information

URI Parameters

NameDescriptionTypeAdditional 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

RoleApplicantMatchSortType

Default value is ScoreDesc

Body Parameters

RoleApplicantMatchFilterDataContract
NameDescriptionTypeAdditional information
Grades

Collection of string

None.

FinancialStatus

Collection of string

None.

ExcludeMailoutDays

integer

None.

OwningTeamId

integer

None.

BranchIds

Collection of integer

None.

IncludedRoleIds

Collection of integer

None.

ExcludedRoleIds

Collection of integer

None.

MinScore

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "Grades": [
    "sample string 1",
    "sample string 2"
  ],
  "FinancialStatus": [
    "sample string 1",
    "sample string 2"
  ],
  "ExcludeMailoutDays": 1,
  "OwningTeamId": 1,
  "BranchIds": [
    1,
    2
  ],
  "IncludedRoleIds": [
    1,
    2
  ],
  "ExcludedRoleIds": [
    1,
    2
  ],
  "MinScore": 1
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

A list of applicant match data contracts for each matching group

PagedCollectionDataContractOfRoleApplicantMatchDataContract
NameDescriptionTypeAdditional information
TotalCount

integer

None.

CurrentCount

integer

None.

PageSize

integer

None.

PageNumber

integer

None.

Collection

Collection of RoleApplicantMatchDataContract

None.

Response Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.