PCRecruiter API
Search... K

Appearance

Pipeline ​

Description ​

The pipeline endpoint is used to retrieve, edit, create, and delete interview records in PCRecruiter. In PCR, an "interview" is a distinct action or interaction between a specific position record and specific candidate. The "pipeline" is where these records are tracked and managed.

Pipeline Interviews ​

The main functionality of the pipeline endpoint revolves around managing interview records. It allows for retrieving, updating, creating, and deleting interview data efficiently.

Data parameters ​

  • SendoutId: Unique identifier for the interview record.
  • JobId: Unique identifier for the job associated with the interview.
  • CandidateId: Unique identifier for the candidate the interview pertains to.
  • CandidateName: Full name of the candidate.
  • CompanyId: Unique identifier for the company associated with the job ID.
  • AppointmentDate: Date and time when the interview took place (in ISO-8601 format).
  • ArrangedDate: Date and time the interview was scheduled in PCRecruiter.
  • InterviewType: Specifies the type of interview.
  • InterviewStatus: A sub-type that describes the status of the interview.
  • BillRate: The hourly rate billed to the client for the interview:
    • CurrencyCode: Currency code for the bill rate (e.g., USD, EUR).
    • Value: Numeric value of the bill rate.
  • PayRate: The hourly rate paid to the candidate for the interview:
    • CurrencyCode: Currency code for the pay rate.
    • Value: Numeric value of the pay rate.
  • Notes: A free-text field containing basic information about the interview, including user-typed notes.
  • Feedback: Free-text field for providing feedback after the interview.
  • Guarantee: Free-text field to specify the guarantee for minimum employment requirements for the position.
  • NotesPublic: Public notes related to the interview.
  • UserName: Username of the user who created the interview record.
  • InterviewerIds: Candidate IDs for selected interviewers (if the interviewers are name records in PCRecruiter).
  • InterviewerNames: Full names of the interviewers.
  • CurrentInterviewType: The current interview type in the pipeline for the candidate ID.
  • CurrentInterviewStatus: The current interview status in the pipeline for the candidate ID.
  • CurrentRollupStage: Indicates the rollup stage assigned to the candidate in this pipeline.
  • VisibleOnWeb: Boolean value to determine if managers can view this interview in the manager portal.
  • LastModified: Date and time the interview record was last updated (in ISO-8601 format).
  • Rank: Ranking (0-100) for the candidate's suitability for the position and interview.
  • Position: The position associated with this interview record.
  • JobTitle: Title of the position linked to the position parameter.

Examples ​

Retrieve a Specific Pipeline Interview ​

------------------ REQUEST ------------------- ​
API
GET /rest/api/pipelineinterviews/{SendoutId}
json
{
  "method": "GET",
  "url": "https://www2.pcrecruiter.net/rest/api/pipelineInterviews/{SendoutId}",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  }
}
------------------ RESPONSE ------------------ ​
json
{
  "SendoutId": 12345,
  "JobId": 67890,
  "CandidateId": 24680,
  "CandidateName": "Sample Candidate",
  "CompanyId": 13579,
  "AppointmentDate": "2021-03-19T16:42:51.587",
  "ArrangedDate": "2021-03-19T16:42:51.587",
  "InterviewType": "PRESENTATION",
  "InterviewStatus": "LINKNAME",
  "BillRate": {
    "CurrencyCode": "USD",
    "Value": 0.0
  },
  "PayRate": {
    "CurrencyCode": "USD",
    "Value": 0.0
  },
  "Notes": "** Status: LINKNAME\\r\\n** Position With: Main Sequence Technology\\r\\n** Name:Sample Candidate\\r\\n** Job Title: Sample Open Position\\r\\n** Position Id: EB-5384351406\\r\\n** City: \\r\\n** State: \\r\\n** Contact Name: \\r\\n** Contact Phone:",
  "Feedback": null,
  "Guarantee": null,
  "NotesPublic": null,
  "UserName": "SAMPLE",
  "InterviewerIds": null,
  "InterviewerNames": "Sample Interviewer",
  "CurrentInterviewType": "PRESENTATION",
  "CurrentInterviewStatus": "LINKNAME",
  "CurrentRollupStage": null,
  "VisibleOnWeb": true,
  "LastModified": "2021-03-19T16:42:51.587",
  "Rank": null,
  "Position": [
    {
      "JobTitle": "Sample Open Position"
    }
  ]
}

TIP

This API call retrieves details for a specific pipeline interview record based on the SendoutId.

Pipeline Placements ​

Pipeline placements provide a way to create placements for a specified candidate at a position they are currently interviewing for.

Data parameters ​

  • PlacementId: Unique identifier for the placement.
  • JobId: Unique identifier for the position this placement pertains to.
  • CandidateId: Unique identifier for the candidate being placed.
  • CandidateName: Full name of the candidate being placed.
  • CompanyId: Unique identifier for the company associated with the job ID.
  • StartDate: The candidate's start date for the placement (ISO-8601 format).
  • PlacementDate: Date and time the placement was created in PCRecruiter (ISO-8601 format).
  • PlacementType: Type of placement (e.g., contract/temp, permanent).
  • PlacementStatus: Sub-type providing more detail about the placement type (e.g., "Permanent").
  • BillRate: Hourly rate billed to the client for contract placements:
    • CurrencyCode: Currency code for the bill rate (e.g., USD).
    • Value: Numeric value of the bill rate.
  • PayRate: Hourly rate paid to the candidate for the placement:
    • CurrencyCode: Currency code for the pay rate.
    • Value: Numeric value of the pay rate.
  • Notes: Free text field containing basic placement information and user-typed notes.
  • Feedback: Free text field for providing feedback after the placement.
  • Guarantee: Explains the guarantee for minimum employment requirements for the position.
  • NotesPublic: Public notes related to the placement.
  • InterviewerNames: Full names of the interviewers associated with the placement.
  • CurrentInterviewType: The current interview type for the candidate in the pipeline.
  • CurrentInterviewStatus: The current interview status for the candidate in the pipeline.
  • CurrentRollupStage: Indicates the rollup stage in the pipeline.
  • VisibleOnWeb: Boolean indicating if managers can view the placement in the manager portal.
  • LastModified: Date and time the placement record was last updated (ISO-8601 format).
  • Rank: Numerical rank (e.g., 0-100) for the candidate's suitability for the position.
  • OvertimeBillRate: Rate billed to the client for overtime hours.
  • OvertimePayRate: Rate paid to the candidate for overtime hours.
  • OnCallBillRate: Rate billed to the client for on-call hours.
  • OnCallPayRate: Rate paid to the candidate for on-call hours.
  • HolidayBillRate: Rate billed to the client for holiday hours.
  • HolidayPayRate: Rate paid to the candidate for holiday hours.
  • DoubleTimeBillRate: Rate billed to the client for double-time hours.
  • DoubleTimePayRate: Rate paid to the candidate for double-time hours.
  • DailyPerDiem: Daily per diem provided to the candidate during the contract.
  • HourlyPerDiem: Hourly per diem provided to the candidate during the contract (if applicable).
  • BurdenRate: Billing rate to the client for the hiring process.
  • BurdenState: State where burden rate taxes are calculated.
  • PONumber: Purchase order number associated with the placement.
  • PlacementFee: Fee billed to the client for the placement:
    • CurrencyCode: Currency code for the placement fee.
    • Value: Numeric value of the placement fee.
  • FeePercentage: Percentage of the candidate's salary collected as placement fee.
  • StartingSalary: Starting salary for the candidate in this placement:
    • CurrencyCode: Currency code for the starting salary.
    • Value: Numeric value of the starting salary.
  • ApproveList: List of approvers for timesheets (if the placement involves a contract).
  • PayFrequency: Frequency of payment to the candidate for the contract placement.
  • StartingWeekday: Day of the week timesheet collection starts.
  • TimeclockVisible: Boolean indicating if the candidate can submit hours via a time clock or manual entry.
  • EndDate: Contract end date for the placement (ISO-8601 format).
  • EstimatedWeeksWorked: Estimated number of weeks worked for a contract placement.
  • EstimatedTotalRevenue: Estimated total revenue from the placement:
    • CurrencyCode: Currency code for the revenue.
    • Value: Numeric value of the revenue estimate.
  • EstimatedTotalCost: Estimated total cost of the placement:
    • CurrencyCode: Currency code for the cost.
    • Value: Numeric value of the cost estimate.
  • EstimatedTotalProfit: Estimated total profit from the placement:
    • CurrencyCode: Currency code for the profit.
    • Value: Numeric value of the profit estimate.
  • Position: Position associated with the placement.
  • JobTitle: Job title for the position.

Examples ​

------------------ REQUEST ------------------- ​
API
POST /rest/api/pipelineplacements
json
{
  "method": "POST",
  "url": "https://www2.pcrecruiter.net/rest/api/pipelineplacements",
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "BEARER Token"
  },
  "body": {
    "JobId": 12345,
    "CandidateId": 67890,
    "CandidateName": "Sample Candidate",
    "StartDate": "2020-12-18T17:02:00",
    "PlacementDate": "2020-12-10T17:02:00",
    "PlacementType": "PLACEMENT_PERM",
    "PlacementStatus": "Permanent",
    "PlacementFee": {
      "CurrencyCode": "USD",
      "Value": 15000
    },
    "FeePercentage": 15,
    "StartingSalary": {
      "CurrencyCode": "USD",
      "Value": 100000
    }
  }
}
------------------ RESPONSE ------------------ ​
json
{
  "PlacementId": 13579
}

TIP

This API call creates a placement using the parameters provided in the POST request body. Ensure all required fields are included for accurate data in the database.