POST api/clienttalentpool/filteredcandidates?clientId={clientId}
get the candidates for the client talent pool section
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| clientId | string |
None. |
Body Parameters
filter and sorting parameters
ClientTalentPoolFilter| Name | Description | Type | Additional information |
|---|---|---|---|
| FetchParameters | ClientTalentPoolFilterFetchParameters |
None. |
|
| FilterParameters | ClientTalentPoolFilterFilterParameters |
None. |
Request Formats
application/json, text/json
Sample:
{
"FetchParameters": {
"Type": 1,
"ReturnAvailability": true,
"ReturnJourneyTime": true,
"OrderBy": 1,
"PageNr": 3,
"PageSize": 4
},
"FilterParameters": {
"Search": "sample string 1",
"AvailabilityFrom": "2025-05-06T13:57:10.2468477Z",
"AvailabilityTo": "2025-05-06T13:57:10.2468477Z",
"AvailabilityDates": [
"2025-05-06T13:57:10.2468477Z",
"2025-05-06T13:57:10.2468477Z"
],
"JobType": 1,
"MaxJourneyTime": 2,
"MinJobs": 3,
"MaxJobs": 4,
"ReturnedMembers": 0,
"FavouriteOnly": true,
"ToExcludeRoleId": "sample string 6",
"RoleGroup": 1,
"SelectedTags": [
"sample string 1",
"sample string 2"
]
}
}
Response Information
Resource Description
TalentPoolResult| Name | Description | Type | Additional information |
|---|---|---|---|
| RoleGroupSets | Collection of RoleGroupSet |
None. |
|
| Candidates | Collection of TalentPoolCandidate |
None. |
Response Formats
application/json, text/json
Sample:
{
"RoleGroupSets": [
{
"RoleGroupId": 1,
"TotalFiltered": 2,
"RoleGroupOrder": 3
},
{
"RoleGroupId": 1,
"TotalFiltered": 2,
"RoleGroupOrder": 3
}
],
"Candidates": [
{
"Id": "sample string 1",
"UserId": "sample string 2",
"FirstName": "sample string 3",
"LastName": "sample string 4",
"DisplayName": "sample string 3 sample string 4",
"DefaultSummary": "sample string 5",
"Photo": "sample string 6",
"Area": "sample string 7",
"JourneyTime": 1,
"JourneyTimes": [
{
"Live": true,
"JourneyTime": 1,
"Distance": 1.1,
"Latitude": 5.1,
"Longitude": 6.1,
"TravelOpt": 0,
"TransitMode": "sample string 7",
"TravelMode": "transit"
},
{
"Live": true,
"JourneyTime": 1,
"Distance": 1.1,
"Latitude": 5.1,
"Longitude": 6.1,
"TravelOpt": 0,
"TransitMode": "sample string 7",
"TravelMode": "transit"
}
],
"Jobs": 1,
"TotalDays": 1,
"JobsAtClient": 1,
"TotalDaysAtClient": 1,
"AvailabilityTypeId": 1,
"AvailableFromDate": "2025-05-06T13:57:10.2468477Z",
"Score": 1,
"Addedby": {
"Name": "sample string 8",
"Type": 9,
"Date": "2025-05-06T13:57:10.2468477Z",
"Photo": "sample string 10"
},
"Tags": [
{
"Id": "sample string 1",
"MemberId": "sample string 2",
"Name": "sample string 3",
"TagCategoryId": "sample string 4",
"TagCategoryName": "sample string 5"
},
{
"Id": "sample string 1",
"MemberId": "sample string 2",
"Name": "sample string 3",
"TagCategoryId": "sample string 4",
"TagCategoryName": "sample string 5"
}
],
"Profiles": [
{
"Id": 1,
"CandidateId": "sample string 2",
"Role": "sample string 3",
"RoleId": "sample string 4",
"IsPrimary": 5,
"Supply": true,
"Longterm": true,
"RoleGroupId": 1,
"Summary": "sample string 8",
"Tags": [
{
"Id": "sample string 1",
"MemberId": "sample string 2",
"Name": "sample string 3",
"TagCategoryId": "sample string 4",
"TagCategoryName": "sample string 5"
},
{
"Id": "sample string 1",
"MemberId": "sample string 2",
"Name": "sample string 3",
"TagCategoryId": "sample string 4",
"TagCategoryName": "sample string 5"
}
],
"DayPayRate": 1.0,
"HalfDayPayRate": 1.0,
"LongTermDayPayRate": 1.0,
"HourlyRate": 1.0
},
{
"Id": 1,
"CandidateId": "sample string 2",
"Role": "sample string 3",
"RoleId": "sample string 4",
"IsPrimary": 5,
"Supply": true,
"Longterm": true,
"RoleGroupId": 1,
"Summary": "sample string 8",
"Tags": [
{
"Id": "sample string 1",
"MemberId": "sample string 2",
"Name": "sample string 3",
"TagCategoryId": "sample string 4",
"TagCategoryName": "sample string 5"
},
{
"Id": "sample string 1",
"MemberId": "sample string 2",
"Name": "sample string 3",
"TagCategoryId": "sample string 4",
"TagCategoryName": "sample string 5"
}
],
"DayPayRate": 1.0,
"HalfDayPayRate": 1.0,
"LongTermDayPayRate": 1.0,
"HourlyRate": 1.0
}
],
"Availability": [
{
"Date": "2025-05-06T13:57:10.2468477Z",
"Type": 0,
"BookedWithCurrentClient": true
},
{
"Date": "2025-05-06T13:57:10.2468477Z",
"Type": 0,
"BookedWithCurrentClient": true
}
],
"LongTermPreference": {
"CandidateId": "sample string 1",
"AllowLongTermInvitations": true,
"LongTermAvailableFrom": "2025-05-06T13:57:10.2468477Z",
"Roles": [
"sample string 1",
"sample string 2"
]
},
"RoleGroups": [
1,
2
],
"FavouriteId": 1,
"Latitude": 1.0,
"Longitude": 1.0,
"DayPayRate": 1.0,
"HalfDayPayRate": 1.0,
"Recommended": true,
"TopMatch": true,
"TagScore": 13,
"ReadyToGo": true,
"ReviewScore": 1.1,
"BookAgain": 1.1,
"IsDeleted": true,
"IsApproved": true,
"IncludeInAll": true,
"CourseCount": 18,
"RecentCourses": [
"sample string 1",
"sample string 2"
],
"SupplyAvailabilityKnown": true,
"TermlyAvailability": 0,
"DailySupplyAvailability": 0
},
{
"Id": "sample string 1",
"UserId": "sample string 2",
"FirstName": "sample string 3",
"LastName": "sample string 4",
"DisplayName": "sample string 3 sample string 4",
"DefaultSummary": "sample string 5",
"Photo": "sample string 6",
"Area": "sample string 7",
"JourneyTime": 1,
"JourneyTimes": [
{
"Live": true,
"JourneyTime": 1,
"Distance": 1.1,
"Latitude": 5.1,
"Longitude": 6.1,
"TravelOpt": 0,
"TransitMode": "sample string 7",
"TravelMode": "transit"
},
{
"Live": true,
"JourneyTime": 1,
"Distance": 1.1,
"Latitude": 5.1,
"Longitude": 6.1,
"TravelOpt": 0,
"TransitMode": "sample string 7",
"TravelMode": "transit"
}
],
"Jobs": 1,
"TotalDays": 1,
"JobsAtClient": 1,
"TotalDaysAtClient": 1,
"AvailabilityTypeId": 1,
"AvailableFromDate": "2025-05-06T13:57:10.2468477Z",
"Score": 1,
"Addedby": {
"Name": "sample string 8",
"Type": 9,
"Date": "2025-05-06T13:57:10.2468477Z",
"Photo": "sample string 10"
},
"Tags": [
{
"Id": "sample string 1",
"MemberId": "sample string 2",
"Name": "sample string 3",
"TagCategoryId": "sample string 4",
"TagCategoryName": "sample string 5"
},
{
"Id": "sample string 1",
"MemberId": "sample string 2",
"Name": "sample string 3",
"TagCategoryId": "sample string 4",
"TagCategoryName": "sample string 5"
}
],
"Profiles": [
{
"Id": 1,
"CandidateId": "sample string 2",
"Role": "sample string 3",
"RoleId": "sample string 4",
"IsPrimary": 5,
"Supply": true,
"Longterm": true,
"RoleGroupId": 1,
"Summary": "sample string 8",
"Tags": [
{
"Id": "sample string 1",
"MemberId": "sample string 2",
"Name": "sample string 3",
"TagCategoryId": "sample string 4",
"TagCategoryName": "sample string 5"
},
{
"Id": "sample string 1",
"MemberId": "sample string 2",
"Name": "sample string 3",
"TagCategoryId": "sample string 4",
"TagCategoryName": "sample string 5"
}
],
"DayPayRate": 1.0,
"HalfDayPayRate": 1.0,
"LongTermDayPayRate": 1.0,
"HourlyRate": 1.0
},
{
"Id": 1,
"CandidateId": "sample string 2",
"Role": "sample string 3",
"RoleId": "sample string 4",
"IsPrimary": 5,
"Supply": true,
"Longterm": true,
"RoleGroupId": 1,
"Summary": "sample string 8",
"Tags": [
{
"Id": "sample string 1",
"MemberId": "sample string 2",
"Name": "sample string 3",
"TagCategoryId": "sample string 4",
"TagCategoryName": "sample string 5"
},
{
"Id": "sample string 1",
"MemberId": "sample string 2",
"Name": "sample string 3",
"TagCategoryId": "sample string 4",
"TagCategoryName": "sample string 5"
}
],
"DayPayRate": 1.0,
"HalfDayPayRate": 1.0,
"LongTermDayPayRate": 1.0,
"HourlyRate": 1.0
}
],
"Availability": [
{
"Date": "2025-05-06T13:57:10.2468477Z",
"Type": 0,
"BookedWithCurrentClient": true
},
{
"Date": "2025-05-06T13:57:10.2468477Z",
"Type": 0,
"BookedWithCurrentClient": true
}
],
"LongTermPreference": {
"CandidateId": "sample string 1",
"AllowLongTermInvitations": true,
"LongTermAvailableFrom": "2025-05-06T13:57:10.2468477Z",
"Roles": [
"sample string 1",
"sample string 2"
]
},
"RoleGroups": [
1,
2
],
"FavouriteId": 1,
"Latitude": 1.0,
"Longitude": 1.0,
"DayPayRate": 1.0,
"HalfDayPayRate": 1.0,
"Recommended": true,
"TopMatch": true,
"TagScore": 13,
"ReadyToGo": true,
"ReviewScore": 1.1,
"BookAgain": 1.1,
"IsDeleted": true,
"IsApproved": true,
"IncludeInAll": true,
"CourseCount": 18,
"RecentCourses": [
"sample string 1",
"sample string 2"
],
"SupplyAvailabilityKnown": true,
"TermlyAvailability": 0,
"DailySupplyAvailability": 0
}
]
}