GET api/clients/vacancies/{vacancyUId}/bestmatches
Vacancy best matches created by the matching alg for an existing vacancy
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| vacancyUId | string |
Required |
Body Parameters
None.
Response Information
Resource Description
MatchingResponseViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| TotalResult | integer |
None. |
|
| MatchedCandidates | Collection of CandidateMatchViewModel |
None. |
Response Formats
application/json, text/json
Sample:
{
"TotalResult": 1,
"MatchedCandidates": [
{
"CandidateId": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"DisplayName": "sample string 4",
"MatchScore": 5,
"MatchedProfile": {
"Id": 1,
"RoleId": "sample string 2",
"Role": "sample string 3",
"DayPayRate": 1.0,
"HalfDayPayRate": 1.0,
"HourlyRate": 1.0,
"LongTermDayPayRate": 1.0,
"IsMatched": true,
"IsDefault": true,
"CandidateCardTags": [
{
"Id": "sample string 1",
"TagCategoryId": "sample string 2",
"TagCategoryName": "sample string 3",
"Name": "sample string 4"
},
{
"Id": "sample string 1",
"TagCategoryId": "sample string 2",
"TagCategoryName": "sample string 3",
"Name": "sample string 4"
}
]
},
"Profiles": [
{
"Id": 1,
"RoleId": "sample string 2",
"Role": "sample string 3",
"DayPayRate": 1.0,
"HalfDayPayRate": 1.0,
"HourlyRate": 1.0,
"LongTermDayPayRate": 1.0,
"IsMatched": true,
"IsDefault": true,
"CandidateCardTags": [
{
"Id": "sample string 1",
"TagCategoryId": "sample string 2",
"TagCategoryName": "sample string 3",
"Name": "sample string 4"
},
{
"Id": "sample string 1",
"TagCategoryId": "sample string 2",
"TagCategoryName": "sample string 3",
"Name": "sample string 4"
}
]
},
{
"Id": 1,
"RoleId": "sample string 2",
"Role": "sample string 3",
"DayPayRate": 1.0,
"HalfDayPayRate": 1.0,
"HourlyRate": 1.0,
"LongTermDayPayRate": 1.0,
"IsMatched": true,
"IsDefault": true,
"CandidateCardTags": [
{
"Id": "sample string 1",
"TagCategoryId": "sample string 2",
"TagCategoryName": "sample string 3",
"Name": "sample string 4"
},
{
"Id": "sample string 1",
"TagCategoryId": "sample string 2",
"TagCategoryName": "sample string 3",
"Name": "sample string 4"
}
]
}
],
"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"
}
],
"Availability": [
{
"BookedWithCurrentClient": true,
"Id": 2,
"CandidateId": "sample string 3",
"Date": "2025-05-06T14:36:50.296993Z",
"UpdatedOn": "2025-05-06T14:36:50.296993Z",
"AvailabilityType": 6
},
{
"BookedWithCurrentClient": true,
"Id": 2,
"CandidateId": "sample string 3",
"Date": "2025-05-06T14:36:50.296993Z",
"UpdatedOn": "2025-05-06T14:36:50.296993Z",
"AvailabilityType": 6
}
],
"ProfileImageURL": "sample string 6",
"JourneyTime": 1.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"
}
],
"Location": "sample string 7",
"InTalentPool": true,
"IsAvailable": true,
"UnavailableReason": 10,
"ClientBookedDays": 11,
"DayPayRate": 1.0,
"HalfDayPayRate": 1.0,
"HourlyRate": 1.0,
"Recommended": true,
"RecommendedBy": "sample string 13",
"RecommendedByPhotoURL": "sample string 14",
"IsBankStaff": true,
"TopMatch": true,
"ReadyToGo": true,
"ReviewScore": 1.1,
"BookAgain": 1.1,
"CourseCount": 18,
"RecentCourses": [
"sample string 1",
"sample string 2"
]
},
{
"CandidateId": "sample string 1",
"FirstName": "sample string 2",
"LastName": "sample string 3",
"DisplayName": "sample string 4",
"MatchScore": 5,
"MatchedProfile": {
"Id": 1,
"RoleId": "sample string 2",
"Role": "sample string 3",
"DayPayRate": 1.0,
"HalfDayPayRate": 1.0,
"HourlyRate": 1.0,
"LongTermDayPayRate": 1.0,
"IsMatched": true,
"IsDefault": true,
"CandidateCardTags": [
{
"Id": "sample string 1",
"TagCategoryId": "sample string 2",
"TagCategoryName": "sample string 3",
"Name": "sample string 4"
},
{
"Id": "sample string 1",
"TagCategoryId": "sample string 2",
"TagCategoryName": "sample string 3",
"Name": "sample string 4"
}
]
},
"Profiles": [
{
"Id": 1,
"RoleId": "sample string 2",
"Role": "sample string 3",
"DayPayRate": 1.0,
"HalfDayPayRate": 1.0,
"HourlyRate": 1.0,
"LongTermDayPayRate": 1.0,
"IsMatched": true,
"IsDefault": true,
"CandidateCardTags": [
{
"Id": "sample string 1",
"TagCategoryId": "sample string 2",
"TagCategoryName": "sample string 3",
"Name": "sample string 4"
},
{
"Id": "sample string 1",
"TagCategoryId": "sample string 2",
"TagCategoryName": "sample string 3",
"Name": "sample string 4"
}
]
},
{
"Id": 1,
"RoleId": "sample string 2",
"Role": "sample string 3",
"DayPayRate": 1.0,
"HalfDayPayRate": 1.0,
"HourlyRate": 1.0,
"LongTermDayPayRate": 1.0,
"IsMatched": true,
"IsDefault": true,
"CandidateCardTags": [
{
"Id": "sample string 1",
"TagCategoryId": "sample string 2",
"TagCategoryName": "sample string 3",
"Name": "sample string 4"
},
{
"Id": "sample string 1",
"TagCategoryId": "sample string 2",
"TagCategoryName": "sample string 3",
"Name": "sample string 4"
}
]
}
],
"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"
}
],
"Availability": [
{
"BookedWithCurrentClient": true,
"Id": 2,
"CandidateId": "sample string 3",
"Date": "2025-05-06T14:36:50.296993Z",
"UpdatedOn": "2025-05-06T14:36:50.296993Z",
"AvailabilityType": 6
},
{
"BookedWithCurrentClient": true,
"Id": 2,
"CandidateId": "sample string 3",
"Date": "2025-05-06T14:36:50.296993Z",
"UpdatedOn": "2025-05-06T14:36:50.296993Z",
"AvailabilityType": 6
}
],
"ProfileImageURL": "sample string 6",
"JourneyTime": 1.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"
}
],
"Location": "sample string 7",
"InTalentPool": true,
"IsAvailable": true,
"UnavailableReason": 10,
"ClientBookedDays": 11,
"DayPayRate": 1.0,
"HalfDayPayRate": 1.0,
"HourlyRate": 1.0,
"Recommended": true,
"RecommendedBy": "sample string 13",
"RecommendedByPhotoURL": "sample string 14",
"IsBankStaff": true,
"TopMatch": true,
"ReadyToGo": true,
"ReviewScore": 1.1,
"BookAgain": 1.1,
"CourseCount": 18,
"RecentCourses": [
"sample string 1",
"sample string 2"
]
}
]
}