POST api/role/{id}/matchidsfiltered

Get list of role ids Processes this role API request. The parameter and response sections describe the data exchanged with the API.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The unique identifier of the requested resource.	integer	Required

Body Parameters

The role applicant match filter data contract supplied with the request.

RoleApplicantMatchFilterDataContract

Name	Description	Type	Additional information
Grades	The collection of grades.	Collection of string	None.
FinancialStatus	The collection of financial status.	Collection of string	None.
ExcludeMailoutDays	The exclude mailout days value.	integer	None.
OwningTeamId	The unique identifier of the related owning team resource.	integer	None.
BranchIds	The unique identifiers of the related branch resources.	Collection of integer	None.
IncludedRoleIds	The unique identifiers of the related included role resources.	Collection of integer	None.
ExcludedRoleIds	The unique identifiers of the related excluded role resources.	Collection of integer	None.
InterestedRoleIds	The unique identifiers of the related interested role resources.	Collection of integer	None.
MinScore	The min score value.	integer	None.
MatchSource	The match source classification.	GroupPropertyMatchSource	None.

Request Formats

application/x-www-form-urlencoded

Sample:

Sample not available.

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
  ],
  "InterestedRoleIds": [
    1,
    2
  ],
  "MinScore": 1,
  "MatchSource": 0
}

Response Information

Resource Description

The response returned after the operation completes.

PagedCollectionDataContractOfGroupListPersonDataContract

Name	Description	Type	Additional information
TotalCount	The total count value.	integer	None.
CurrentCount	The current count value.	integer	None.
PageSize	The page size value.	integer	None.
PageNumber	The page number value.	integer	None.
Collection	The collection of collection.	Collection of GroupListPersonDataContract	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalCount": 1,
  "CurrentCount": 2,
  "PageSize": 1,
  "PageNumber": 1,
  "Collection": [
    {
      "GroupId": 1,
      "PersonIds": [
        1,
        2
      ],
      "InterestRoleId": 2
    },
    {
      "GroupId": 1,
      "PersonIds": [
        1,
        2
      ],
      "InterestRoleId": 2
    }
  ]
}