curl --request POST \
--url https://api.harmonyforstaffing.com/api/screening \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"jobSubmissionId": 789,
"criteria": [
{
"description": "Must have 2 years of ICU nursing experience",
"importance": "required",
"type": "experience"
},
{
"description": "Current ACLS certification required",
"importance": "required",
"type": "certification"
}
],
"replaceCriteria": false
}'
{
"id": 789,
"candidateId": 456,
"jobId": 123,
"currentScore": 66.67,
"potentialScore": 100,
"disqualify": false,
"submissionSummary": {
"screeningSummary": "The candidate meets most critical requirements including ICU experience and certifications. While they have slightly less experience than required, their strong qualifications in pediatric care make them a promising candidate.",
"followUpQuestions": [
"Are you willing and able to work night shifts?",
"Would you be comfortable working with pediatric patients given your adult ICU background?",
"Is your PALS certification current or would you be willing to obtain it?"
],
"missingInformation": [
"Night shift availability",
"Pediatric care experience details",
"PALS certification status"
],
"strengths": [
"Current ACLS and BLS certifications",
"Recent ICU experience",
"Proficient with EPIC EMR"
],
"gaps": [
"Experience level slightly below requirement (2 years vs 3 years)",
"No confirmed night shift experience",
"No explicit pediatric care experience"
]
},
"applicationReadiness": {
"readinessScore": 75,
"status": "NeedsInformation",
"requiredDocuments": {
"missing": [
"PALS certification",
"Professional references"
],
"expiringSoon": [
"RN License (expires in 60 days)"
]
},
"qualificationGaps": {
"critical": [
"Night shift availability confirmation",
"PALS certification"
],
"recommended": [
"Additional year of ICU experience",
"Pediatric care experience"
]
},
"workHistoryGaps": {
"gaps": [
{
"startDate": "2022-06-01",
"endDate": "2022-08-15",
"duration": "2.5 months"
},
{
"startDate": "2023-01-01",
"endDate": "2023-03-01",
"duration": "2 months"
}
],
"totalGapDuration": "4.5 months",
},
"nextSteps": [
"Submit PALS certification",
"Provide professional references",
"Confirm night shift availability",
"Renew RN license"
]
},
"criteria": [
{
"id": 1,
"source": "job_criteria",
"question": "How many years of ICU nursing experience do you have?",
"criteria": "Minimum of 3 years ICU nursing experience required",
"type": "YearsOfExperience",
"status": "PartiallyMet",
"reasoning": "The candidate has 2 years of ICU experience, which is slightly below the required 3 years. However, their experience is recent and includes relevant critical care skills.",
"textEvidence": "2 years of experience in Medical ICU at Saint Francis Hospital"
},
{
"id": 2,
"source": "job_criteria",
"question": "Do you have current ACLS and BLS certifications?",
"criteria": "Current ACLS and BLS certifications required",
"type": "Required",
"status": "FullyMet",
"reasoning": "The candidate holds current ACLS and BLS certifications that are valid through 2025.",
"textEvidence": "ACLS Certification (exp. 06/2025), BLS Certification (exp. 08/2025)"
},
{
"id": 3,
"source": "job_criteria",
"question": "Do you have experience with EPIC EMR system?",
"criteria": "Experience with EPIC EMR system preferred",
"type": "Preferred",
"status": "FullyMet",
"reasoning": "The candidate has extensive experience using EPIC EMR in their current role.",
"textEvidence": "Proficient in EPIC EMR system, including documentation, order entry, and care planning modules"
},
{
"id": 4,
"source": "job_criteria",
"question": "Are you able to work night shifts?",
"criteria": "Must be willing to work night shifts",
"type": "Required",
"status": "NotMet",
"reasoning": "The resume does not indicate any night shift experience or willingness to work nights.",
"textEvidence": null
}
],
"qualificationLevel": "Appropriate",
"isRelevant": true
}
Screening
Screen Job Submission
Screen a candidate for a specific job submission
POST
/
api
/
screening
/
job-submission
curl --request POST \
--url https://api.harmonyforstaffing.com/api/screening \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"jobSubmissionId": 789,
"criteria": [
{
"description": "Must have 2 years of ICU nursing experience",
"importance": "required",
"type": "experience"
},
{
"description": "Current ACLS certification required",
"importance": "required",
"type": "certification"
}
],
"replaceCriteria": false
}'
{
"id": 789,
"candidateId": 456,
"jobId": 123,
"currentScore": 66.67,
"potentialScore": 100,
"disqualify": false,
"submissionSummary": {
"screeningSummary": "The candidate meets most critical requirements including ICU experience and certifications. While they have slightly less experience than required, their strong qualifications in pediatric care make them a promising candidate.",
"followUpQuestions": [
"Are you willing and able to work night shifts?",
"Would you be comfortable working with pediatric patients given your adult ICU background?",
"Is your PALS certification current or would you be willing to obtain it?"
],
"missingInformation": [
"Night shift availability",
"Pediatric care experience details",
"PALS certification status"
],
"strengths": [
"Current ACLS and BLS certifications",
"Recent ICU experience",
"Proficient with EPIC EMR"
],
"gaps": [
"Experience level slightly below requirement (2 years vs 3 years)",
"No confirmed night shift experience",
"No explicit pediatric care experience"
]
},
"applicationReadiness": {
"readinessScore": 75,
"status": "NeedsInformation",
"requiredDocuments": {
"missing": [
"PALS certification",
"Professional references"
],
"expiringSoon": [
"RN License (expires in 60 days)"
]
},
"qualificationGaps": {
"critical": [
"Night shift availability confirmation",
"PALS certification"
],
"recommended": [
"Additional year of ICU experience",
"Pediatric care experience"
]
},
"workHistoryGaps": {
"gaps": [
{
"startDate": "2022-06-01",
"endDate": "2022-08-15",
"duration": "2.5 months"
},
{
"startDate": "2023-01-01",
"endDate": "2023-03-01",
"duration": "2 months"
}
],
"totalGapDuration": "4.5 months",
},
"nextSteps": [
"Submit PALS certification",
"Provide professional references",
"Confirm night shift availability",
"Renew RN license"
]
},
"criteria": [
{
"id": 1,
"source": "job_criteria",
"question": "How many years of ICU nursing experience do you have?",
"criteria": "Minimum of 3 years ICU nursing experience required",
"type": "YearsOfExperience",
"status": "PartiallyMet",
"reasoning": "The candidate has 2 years of ICU experience, which is slightly below the required 3 years. However, their experience is recent and includes relevant critical care skills.",
"textEvidence": "2 years of experience in Medical ICU at Saint Francis Hospital"
},
{
"id": 2,
"source": "job_criteria",
"question": "Do you have current ACLS and BLS certifications?",
"criteria": "Current ACLS and BLS certifications required",
"type": "Required",
"status": "FullyMet",
"reasoning": "The candidate holds current ACLS and BLS certifications that are valid through 2025.",
"textEvidence": "ACLS Certification (exp. 06/2025), BLS Certification (exp. 08/2025)"
},
{
"id": 3,
"source": "job_criteria",
"question": "Do you have experience with EPIC EMR system?",
"criteria": "Experience with EPIC EMR system preferred",
"type": "Preferred",
"status": "FullyMet",
"reasoning": "The candidate has extensive experience using EPIC EMR in their current role.",
"textEvidence": "Proficient in EPIC EMR system, including documentation, order entry, and care planning modules"
},
{
"id": 4,
"source": "job_criteria",
"question": "Are you able to work night shifts?",
"criteria": "Must be willing to work night shifts",
"type": "Required",
"status": "NotMet",
"reasoning": "The resume does not indicate any night shift experience or willingness to work nights.",
"textEvidence": null
}
],
"qualificationLevel": "Appropriate",
"isRelevant": true
}
Screen a candidate for a specific job submission, including a summary of the screening results and recommendations for next steps. You can optionally provide additional or replacement criteria specific to this screening.
Body Parameters
integer
ID of the job submission to screen (required if candidateId and jobId not provided)
array
boolean
default:"false"
If true, provided criteria replace job criteria. If false, they are added to job criteria.
curl --request POST \
--url https://api.harmonyforstaffing.com/api/screening \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"jobSubmissionId": 789,
"criteria": [
{
"description": "Must have 2 years of ICU nursing experience",
"importance": "required",
"type": "experience"
},
{
"description": "Current ACLS certification required",
"importance": "required",
"type": "certification"
}
],
"replaceCriteria": false
}'
Response Fields
integer
Unique identifier for the screening
integer
ID of the job submission being screened (if exists)
integer
ID of the candidate being screened
integer
ID of the job being screened against
number
Current match percentage based on verified criteria (0-100)
number
Maximum possible match percentage if all unverified criteria are met (0-100)
boolean
Whether the candidate should be disqualified from the job
object
Detailed screening analysis and recommendations
Show Summary fields
Show Summary fields
string
Overall assessment of the candidate’s fit for the position
array
Questions to ask the candidate about unverified or unclear criteria
array
List of criteria that couldn’t be verified from available information
array
List of criteria where the candidate shows strong matches
array
List of areas where the candidate doesn’t meet requirements
object
Analysis of application completeness and readiness to submit
Show Readiness fields
Show Readiness fields
number
Overall readiness score (0-100) based on completeness and qualification
string
Current status: “Ready”, “NeedsInformation”, “NeedsQualification”, “NotQualified”
object
object
object
object
array
Prioritized list of actions to improve application readiness
array
Detailed analysis of each criterion
Show Criterion fields
Show Criterion fields
integer
Unique identifier for the criterion
string
Origin of the criterion (e.g., “job_criteria”)
string
The criterion formatted as a question
string
Original criterion text
string
Type of criterion (e.g., “YearsOfExperience”, “Required”, “Preferred”)
string
Match status: “FullyMet”, “PartiallyMet”, or “NotMet”
string
Explanation of how the criterion was evaluated
string
Supporting text from resume/application, if found
string
Overall qualification assessment (e.g., “Appropriate”, “Overqualified”, “Underqualified”)
boolean
Indicates if the candidate’s background is relevant to the position
{
"id": 789,
"candidateId": 456,
"jobId": 123,
"currentScore": 66.67,
"potentialScore": 100,
"disqualify": false,
"submissionSummary": {
"screeningSummary": "The candidate meets most critical requirements including ICU experience and certifications. While they have slightly less experience than required, their strong qualifications in pediatric care make them a promising candidate.",
"followUpQuestions": [
"Are you willing and able to work night shifts?",
"Would you be comfortable working with pediatric patients given your adult ICU background?",
"Is your PALS certification current or would you be willing to obtain it?"
],
"missingInformation": [
"Night shift availability",
"Pediatric care experience details",
"PALS certification status"
],
"strengths": [
"Current ACLS and BLS certifications",
"Recent ICU experience",
"Proficient with EPIC EMR"
],
"gaps": [
"Experience level slightly below requirement (2 years vs 3 years)",
"No confirmed night shift experience",
"No explicit pediatric care experience"
]
},
"applicationReadiness": {
"readinessScore": 75,
"status": "NeedsInformation",
"requiredDocuments": {
"missing": [
"PALS certification",
"Professional references"
],
"expiringSoon": [
"RN License (expires in 60 days)"
]
},
"qualificationGaps": {
"critical": [
"Night shift availability confirmation",
"PALS certification"
],
"recommended": [
"Additional year of ICU experience",
"Pediatric care experience"
]
},
"workHistoryGaps": {
"gaps": [
{
"startDate": "2022-06-01",
"endDate": "2022-08-15",
"duration": "2.5 months"
},
{
"startDate": "2023-01-01",
"endDate": "2023-03-01",
"duration": "2 months"
}
],
"totalGapDuration": "4.5 months",
},
"nextSteps": [
"Submit PALS certification",
"Provide professional references",
"Confirm night shift availability",
"Renew RN license"
]
},
"criteria": [
{
"id": 1,
"source": "job_criteria",
"question": "How many years of ICU nursing experience do you have?",
"criteria": "Minimum of 3 years ICU nursing experience required",
"type": "YearsOfExperience",
"status": "PartiallyMet",
"reasoning": "The candidate has 2 years of ICU experience, which is slightly below the required 3 years. However, their experience is recent and includes relevant critical care skills.",
"textEvidence": "2 years of experience in Medical ICU at Saint Francis Hospital"
},
{
"id": 2,
"source": "job_criteria",
"question": "Do you have current ACLS and BLS certifications?",
"criteria": "Current ACLS and BLS certifications required",
"type": "Required",
"status": "FullyMet",
"reasoning": "The candidate holds current ACLS and BLS certifications that are valid through 2025.",
"textEvidence": "ACLS Certification (exp. 06/2025), BLS Certification (exp. 08/2025)"
},
{
"id": 3,
"source": "job_criteria",
"question": "Do you have experience with EPIC EMR system?",
"criteria": "Experience with EPIC EMR system preferred",
"type": "Preferred",
"status": "FullyMet",
"reasoning": "The candidate has extensive experience using EPIC EMR in their current role.",
"textEvidence": "Proficient in EPIC EMR system, including documentation, order entry, and care planning modules"
},
{
"id": 4,
"source": "job_criteria",
"question": "Are you able to work night shifts?",
"criteria": "Must be willing to work night shifts",
"type": "Required",
"status": "NotMet",
"reasoning": "The resume does not indicate any night shift experience or willingness to work nights.",
"textEvidence": null
}
],
"qualificationLevel": "Appropriate",
"isRelevant": true
}
{
"error": "validation_error",
"message": "Invalid request parameters",
"details": [
"Must provide either jobSubmissionId or both candidateId and jobId",
"Invalid importance value. Must be one of: required, preferred, optional"
]
}
{
"error": "not_found",
"message": "Job submission, candidate, or job not found"
}