POST api/ClientTalentPool/CandidateDetails?clientId={clientId}
get all the details for a talent pool candidate
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
clientId | string |
None. |
Body Parameters
CandidateDetailsRequestName | Description | Type | Additional information |
---|---|---|---|
CandidateId | string |
None. |
|
IncludeGeneralDetails | boolean |
None. |
|
IncludeTestimonials | boolean |
None. |
|
IncludeAvailability | boolean |
None. |
|
AvailabilityFrom | date |
None. |
|
AvailabilityTo | date |
None. |
|
IncludeJobs | boolean |
None. |
|
JobsCompletedAtMySchool | boolean |
None. |
|
IncludeCourses | boolean |
None. |
Request Formats
application/json, text/json
Sample:
{ "CandidateId": "sample string 1", "IncludeGeneralDetails": true, "IncludeTestimonials": true, "IncludeAvailability": true, "AvailabilityFrom": "2025-05-06T13:14:28.5593681Z", "AvailabilityTo": "2025-05-06T13:14:28.5593681Z", "IncludeJobs": true, "JobsCompletedAtMySchool": true, "IncludeCourses": true }
Response Information
Resource Description
TalentPoolCandidateDetailedName | Description | Type | Additional information |
---|---|---|---|
TotalAvailabilityDays | integer |
None. |
|
CompliancePercentage | integer |
None. |
|
MemberSince | date |
None. |
|
About | string |
None. |
|
CVAssetId | integer |
None. |
|
TagCategories | Collection of MemberTagCategory |
None. |
|
JobList | Collection of TalentPoolCandidateJob |
None. |
|
Reviews | CandidateReviews |
None. |
|
VideoURL | string |
None. |
|
Courses | Collection of CandidateCourse |
None. |
|
InTalentPool | boolean |
None. |
|
IsBankStaff | boolean |
None. |
|
Id | string |
None. |
|
UserId | string |
None. |
|
FirstName | string |
None. |
|
LastName | string |
None. |
|
DisplayName | string |
None. |
|
DefaultSummary | string |
None. |
|
Photo | string |
None. |
|
Area | string |
None. |
|
JourneyTime | integer |
None. |
|
JourneyTimes | Collection of LocationTravelResponse |
None. |
|
Jobs | integer |
None. |
|
TotalDays | integer |
None. |
|
JobsAtClient | integer |
None. |
|
TotalDaysAtClient | integer |
None. |
|
AvailabilityTypeId | integer |
None. |
|
AvailableFromDate | date |
None. |
|
Score | integer |
None. |
|
Addedby | TalentPoolCandidateAddedBy |
None. |
|
Tags | Collection of MemberTag |
None. |
|
Profiles | Collection of TalentPoolCandidateProfile |
None. |
|
Availability | Collection of TalentPoolCandidateAvailability |
None. |
|
LongTermPreference | CandidateLongTermPreferenceForClient |
None. |
|
RoleGroups | Collection of integer |
None. |
|
FavouriteId | integer |
None. |
|
Latitude | decimal number |
None. |
|
Longitude | decimal number |
None. |
|
DayPayRate | decimal number |
None. |
|
HalfDayPayRate | decimal number |
None. |
|
Recommended | boolean |
None. |
|
TopMatch | boolean |
None. |
|
TagScore | integer |
None. |
|
ReadyToGo | boolean |
None. |
|
ReviewScore | decimal number |
None. |
|
BookAgain | decimal number |
None. |
|
IsDeleted | boolean |
None. |
|
IsApproved | boolean |
None. |
|
IncludeInAll | boolean |
None. |
|
CourseCount | integer |
None. |
|
RecentCourses | Collection of string |
None. |
|
SupplyAvailabilityKnown | boolean |
None. |
|
TermlyAvailability | TermlyClientAvailabilityType |
None. |
|
DailySupplyAvailability | TermlyClientAvailabilityType |
None. |
Response Formats
application/json, text/json
Sample:
{ "TotalAvailabilityDays": 1, "CompliancePercentage": 1, "MemberSince": "2025-05-06T13:14:28.5593681Z", "About": "sample string 3", "CVAssetId": 1, "TagCategories": [ { "Id": "sample string 1", "Name": "sample string 2", "Description": "sample string 3", "OrderNo": 1, "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" } ] }, { "Id": "sample string 1", "Name": "sample string 2", "Description": "sample string 3", "OrderNo": 1, "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" } ] } ], "JobList": [ { "Id": "sample string 1", "CandidateId": "sample string 2", "Title": "sample string 3", "JobType": "sample string 4", "FirstDayDate": "2025-05-06T13:14:28.5593681Z", "FirstDayType": 0, "Area": "sample string 6", "DaysCount": 7, "Tags": [ { "VacancyId": "sample string 1", "TagId": "sample string 2", "TagName": "sample string 3" }, { "VacancyId": "sample string 1", "TagId": "sample string 2", "TagName": "sample string 3" } ] }, { "Id": "sample string 1", "CandidateId": "sample string 2", "Title": "sample string 3", "JobType": "sample string 4", "FirstDayDate": "2025-05-06T13:14:28.5593681Z", "FirstDayType": 0, "Area": "sample string 6", "DaysCount": 7, "Tags": [ { "VacancyId": "sample string 1", "TagId": "sample string 2", "TagName": "sample string 3" }, { "VacancyId": "sample string 1", "TagId": "sample string 2", "TagName": "sample string 3" } ] } ], "Reviews": { "TotalReviews": 1, "AverageScore": 1.1, "PunctualityScore": 1.1, "ProfessionalismScore": 1.1, "CommunicationScore": 1.1, "TopTestimonials": [ { "ReviewerPhotoURL": "sample string 1", "ReviewerName": "sample string 2", "ReviewerJobTitle": "sample string 3", "ClientName": "sample string 4", "Testimonial": "sample string 5", "Score": 1.1 }, { "ReviewerPhotoURL": "sample string 1", "ReviewerName": "sample string 2", "ReviewerJobTitle": "sample string 3", "ClientName": "sample string 4", "Testimonial": "sample string 5", "Score": 1.1 } ] }, "VideoURL": "sample string 4", "Courses": [ { "CandidateId": "sample string 1", "Category": "sample string 2", "CourseTitle": "sample string 3", "Platform": "sample string 4", "ProgressStatus": "sample string 5", "CourseStartedAt": "2025-05-06T13:14:28.5593681Z", "CourseCompletedAt": "2025-05-06T13:14:28.5593681Z" }, { "CandidateId": "sample string 1", "Category": "sample string 2", "CourseTitle": "sample string 3", "Platform": "sample string 4", "ProgressStatus": "sample string 5", "CourseStartedAt": "2025-05-06T13:14:28.5593681Z", "CourseCompletedAt": "2025-05-06T13:14:28.5593681Z" } ], "InTalentPool": true, "IsBankStaff": true, "Id": "sample string 7", "UserId": "sample string 8", "FirstName": "sample string 9", "LastName": "sample string 10", "DisplayName": "sample string 9 sample string 10", "DefaultSummary": "sample string 11", "Photo": "sample string 12", "Area": "sample string 13", "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:14:28.5593681Z", "Score": 1, "Addedby": { "Name": "sample string 14", "Type": 15, "Date": "2025-05-06T13:14:28.5593681Z", "Photo": "sample string 16" }, "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:14:28.5593681Z", "Type": 0, "BookedWithCurrentClient": true }, { "Date": "2025-05-06T13:14:28.5593681Z", "Type": 0, "BookedWithCurrentClient": true } ], "LongTermPreference": { "CandidateId": "sample string 1", "AllowLongTermInvitations": true, "LongTermAvailableFrom": "2025-05-06T13:14:28.5593681Z", "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": 19, "ReadyToGo": true, "ReviewScore": 1.1, "BookAgain": 1.1, "IsDeleted": true, "IsApproved": true, "IncludeInAll": true, "CourseCount": 24, "RecentCourses": [ "sample string 1", "sample string 2" ], "SupplyAvailabilityKnown": true, "TermlyAvailability": 0, "DailySupplyAvailability": 0 }