GET Candidates

Description:  Retrieve candidates from a client for a specific vendor.

Sample CURL:

curl -X GET "https://uat.vmsapi.vectorvms.com/candidateextract?filterfield=&filteroperator=&filtervalue=&Vendor_Org_Id=1234&Client_Org_Id=1234" -H  "accept: application/json" -H  "x-api-key: {your_api_key}" -H  "x-signature: {your_api_signature}"

ParameterDescription
filtervalue Filter value
filteroperator Filter operator: =, >=, etc
filterfield Filter Field.  Available filters: Candidate_Id, Requisition_Id,  Submitted_Date, Updated_Date
Vendor_Org_Id VMS Org ID for Vendor
Client_Org_Id VMS Org ID for Client
x-api-key Your API key (found in My Account)
x-signature  Signature (Key+Secret+Timestamp Hash) - refer to Authentication section of Documentation for more information

Response Code 200 - Schema

Response Field Data Type Description
Answer1 number Candidate Response Question 1 from Requisition
Answer2 number Candidate Response Question 2 from Requisition
Answer3 string Candidate Response Question 3 from Requisition
Answer4 string Candidate Response Question 4 from Requisition
Answer5 string Candidate Response Question 5 from Requisition
Budget_Rate
 string Base Budget Rate from candidate record
Cand_Curr_Employed_By_Vendor
 number Response to  "Is Candidate currently Employed by vendor?"
Cand_Paid_W2_By_Vendor
 string Response to  "Is/will be Paid-Employee/W2 to Vendor?"
Candcustomfield1 string Candidate Custom Field 1 Value
Candcustomfield2 string Candidate Custom Field 2 Value
Candcustomfield3 string Candidate Custom Field 3 Value
Candcustomfield4 string Candidate Custom Field 4 Value
Candcustomfield5 string Candidate Custom Field 5 Value
Candidate_Comments
 string Text from last comment on candidate record
Candidate_Email_Address
 string Candidate Email Address
Candidate_First_Name
 string Candidate First Name
Candidate_Id
 string VMS System ID for this candidate record
Candidate_Last_Name
 number Candidate Last Name
Candidate_Middle_Initial
 string Candidate Middle Initial
Candidate_Pay_Rate
 string Base Pay Rate from candidate record
Candidate_Status
 string Client status of Candidate
Citizen_Status
 string Candidate Citizenship Status
Client_Org_Id
 string VMS Organization ID for client
Client_Rate
 string Base Client Rate from candidate record
Created_By_User
 string Engaged Candidate First Name
Interview_By
 string

Candidate Interviwer
Interview_Date
 string Date if Candidate Interview
Is_Cand_Independent_Contractor
 string Response to "Independent Contractor?"
Payment_Basis
 string Hours/units per day for the engsagement
Req_Reports_To
 string Requisition Reports To user (Last name, First name)
Requisition_Id
 string VMS System ID the requuisiton candidate submitted for
Skill10_Amount_Of_Experience_Duration
 string Candidate response to Requisition Skill 10 "Amount of Experience Duration"
Skill10_Amount_Of_Experience_Units
 string Candidate response to Requisition Skill 10 "Amount of Experience Units"
Skill10_Expertise_Rating
 number Candidate response to Requisition Skill 10 "Expertise Rating"
Skill10_Response
 string Candidate response to Requisition Skill 10 "Required/Desired"
Skill1_Amount_Of_Experience_Duration string Candidate response to Requisition Skill 1 "Amount of Experience Duration"
Skill1_Amount_Of_Experience_Units string Candidate response to Requisition Skill 1 "Amount of Experience Units"
Skill1_Expertise_Rating string Candidate response to Requisition Skill 1 "Expertise Rating"
Skill1_Response number Candidate response to Requisition Skill 1 "Required/Desired"
Skill2_Amount_Of_Experience_Duration number Candidate response to Requisition Skill 2 "Amount of Experience Duration"
Skill2_Amount_Of_Experience_Units string Candidate response to Requisition Skill 2 "Amount of Experience Units"
Skill2_Expertise_Rating string Candidate response to Requisition Skill 2 "Expertise Rating"
Skill2_Response string Candidate response to Requisition Skill 2 "Required/Desired"
Skill3_Amount_Of_Experience_Duration string Candidate response to Requisition Skill 3 "Amount of Experience Duration"
Skill3_Amount_Of_Experience_Units string Candidate response to Requisition Skill 3 "Amount of Experience Units"
Skill3_Expertise_Rating string Candidate response to Requisition Skill 3 "Expertise Rating"
Skill3_Response string Candidate response to Requisition Skill 3 "Required/Desired"
Skill4_Amount_Of_Experience_Duration string Candidate response to Requisition Skill 4 "Amount of Experience Duration"
Skill4_Amount_Of_Experience_Units string Candidate response to Requisition Skill 4 "Amount of Experience Units"
Skill4_Expertise_Rating Candidate response to Requisition Skill 4 "Expertise Rating"
Skill4_Response Candidate response to Requisition Skill 4 "Required/Desired"
Skill5_Amount_Of_Experience_Duration  Candidate response to Requisition Skill 5 "Amount of Experience Duration"
Skill5_Amount_Of_Experience_Units Candidate response to Requisition Skill 5 "Amount of Experience Units"
Skill5_Expertise_Rating Candidate response to Requisition Skill 5 "Expertise Rating" 
Skill5_Response Candidate response to Requisition Skill 5 "Required/Desired" 
Skill6_Amount_Of_Experience_Duration Candidate response to Requisition Skill 6 "Amount of Experience Duration" 
Skill6_Amount_Of_Experience_Units Candidate response to Requisition Skill 6 "Amount of Experience Units" 
Skill6_Expertise_Rating Candidate response to Requisition Skill 6 "Expertise Rating" 
Skill6_Response Candidate response to Requisition Skill 6 "Required/Desired" 
Skill7_Amount_Of_Experience_Duration Candidate response to Requisition Skill 7 "Amount of Experience Duration" 
Skill7_Amount_Of_Experience_Units Candidate response to Requisition Skill 7 "Amount of Experience Units"
Skill7_Expertise_Rating Candidate response to Requisition Skill 7 "Expertise Rating"
Skill7_Response Candidate response to Requisition Skill 7 "Required/Desired"
Skill8_Amount_Of_Experience_Duration Candidate response to Requisition Skill 8 "Amount of Experience Duration"
Skill8_Amount_Of_Experience_Units Candidate response to Requisition Skill 8 "Amount of Experience Units"
Skill8_Expertise_Rating Candidate response to Requisition Skill 8 "Expertise Rating"
Skill8_Response Candidate response to Requisition Skill 8 "Required/Desired"
Skill9_Amount_Of_Experience_Duration Candidate response to Requisition Skill 8 "Amount of Experience Duration"
Skill9_Amount_Of_Experience_Units Candidate response to Requisition Skill 9 "Amount of Experience Units"
Skill9_Expertise_Rating Candidate response to Requisition Skill 9 "Expertise Rating"
Skill9_Response Candidate response to Requisition Skill 9 "Required/Desired"
Submitted_Date
 Date of Candidate Submission
Summary_Of_Qualifications
 Candidate Summary of Qualification
Updated_By_User
 User to last update candidate record (Last name, First name)
Updated_Date
 Date of last update to Candidate Record
Vendor_Candidate_Id
 Unique candidate id from originating vendor
Vendor_Candidate_Status
 Vendor status of Candidate
Vendor_Contact
 Vendor Contact (Last name, First name)
Vendor_Contact_Email
 Vendor Contact email address
Vendor_Id
 VMS Organization ID for vendor
Vendor_Name
 Name of vendor
Vendor_Rate
 Base Vendor Rate from candidate record
Was_Cand_Ever_Emp_By_Client
 Response to  "Was Candidate ever contracted/employed by client?"

version 13 as of 10 months ago by Gregory Kreh