Manage Candidates

recruitment/candidates@1.0.1
2 providers

Create Candidate

Creates an application for specific job. The candidate may (depends on the provider implementation) receive notification that her/his application was successfully accepted by the company.

Input
Job Id
First Name
Last Name
Email
Phone
Address
Education
Work Experience
CV (Resume)
Links
Answers
Stage Id
Result
Id
Job Id
Rate limit

1.Choose a provider

2.Use CreateCandidate with mock in your code

npm i @superfaceai/one-sdk
const { SuperfaceClient } = require('@superfaceai/one-sdk');

const sdk = new SuperfaceClient();

async function run() {
  // Load the profile
  const profile = await sdk.getProfile('recruitment/candidates@1.0.1');

  // Use the profile
  const result = await profile
    .getUseCase('CreateCandidate')
    .perform({
      jobId: 'JOB_ID',
      firstName: 'Demo',
      lastName: 'Testing',
      email: 'demo_testing@fakemail.com'
    }, {
      provider: 'mock'
    });

  // Handle the result
  try {
    const data = result.unwrap();
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

run();

Structure details

Input (object)

jobId
Id of a job, to which candidate applies to.
firstName
First name of a candidate.
lastName
Last name of a candidate.
email
Email of a candidate.
phone
Phone number of a candidate.
address
Address of a candidate.
education
Array of education experiences.
workExperience
Array of work experiences.
cv
Object containing either URL to a CV or data encoded in Base64 format with CV document and name with the file name.
links
Array of links to different profiles or portfolios of a candidate.
answers
Array of answers to questions connected to a job that candidate applies to.
stageId
Unique identifier of a stage, in which candidate is in.

Example

{
  "jobId": "JOB_ID",
  "firstName": "Demo",
  "lastName": "Testing",
  "email": "demo_testing@fakemail.com"
}

Result (object)

id
Unique identifier of newly created candidate.
jobId
Unique identifier of a job, newly created candidate applied for.
rateLimit
Rate limit details.

Example

{
  "id": "CANDIDATE_ID",
  "jobId": "JOB_ID"
}

Implementation details

Provider
mock
Use case
CreateCandidate
Author
@superface
Source
Verified