POST Candidates

Description:  Submit candidates to existing requisitions.

Sample CURL:

curl -X POST "https://uat.vmsapi.vectorvms.com/candidates?Client_Org_Id=1234&Vendor_Org_Id=1234" -H  "accept: application/json" -H  "x-api-key: {your_api_key}" -H  "x-signature: {your_api_signature}" -H  "Content-Type: application/json" -d "Candidate Payload"

ParameterDescription
Client_Org_Id VMS Org ID for Client
Vendor_Org_Id VMS Org ID for Vendor
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
Body

Candidate Payload:

[{ "requirementid": "", "firstname": "", "lastname": "", "candemail": "", "engagementtype": "", "iscandcurrentlyemployedbyvendor": "", "iscandcurrentlypaidbyvendor": "", "availability": "", "vendorcandidateid": "", "summaryofqualifications": "", "skill1response": "", "skill1amountofexperienceduration": "", "skill1amountofexperienceunits": "", "skill1expertiserating": "", "skill2response": "", "skill2amountofexperienceduration": "", "skill2amountofexperienceunits": "", "skill2expertiserating": "", "skill3response": "", "skill3amountofexperienceduration": "", "skill3amountofexperienceunits": "", "skill3expertiserating": "", "skill4response": "", "skill4amountofexperienceduration": "", "skill4amountofexperienceunits": "", "skill4expertiserating": "", "skill5response": "", "skill5amountofexperienceduration": "", "skill5amountofexperienceunits": "", "skill5expertiserating": "", "skill6response": "", "skill6amountofexperienceduration": "", "skill6amountofexperienceunits": "", "skill6expertiserating": "", "skill7response": "", "skill7amountofexperienceduration": "", "skill7amountofexperienceunits": "", "skill7expertiserating": "", "skill8response": "", "skill8amountofexperienceduration": "", "skill8amountofexperienceunits": "", "skill8expertiserating": "", "skill9response": "", "skill9amountofexperienceduration": "", "skill9amountofexperienceunits": "", "skill9expertiserating": "", "skill10response": "", "skill10amountofexperienceduration": "", "skill10amountofexperienceunits": "", "skill10expertiserating": "", "answer1": "", "answer2": "", "answer3": "", "answer4": "", "answer5": "", "iscandindependantcontractor": "", "wascandeveremployedbyclient": "", "candcitizenshipstatus": "", "candcitizenshipexplain": "", "billrate": "", "vendorrate": "", "payrate": "", "budgetrate": "", "candidatecomments": "", "candcustomfield1": "", "candcustomfield2": "", "candcustomfield3": "", "candcustomfield4": "", "candcustomfield5": "" }]

Candidate Payload Key

Candidate Payload Field Required - field must be included in body and contain data Data Type Description
requirementid Y INTEGER Requisition ID - the VMS REQ ID to which the Candidate is being Submitted.
firstname Y STRING Candidte First Name
lastname Y STRING Candidate Last Name
candemail Y STRING Candidate Email Address - Must be a valid formatted email address
engagementtype Y INTEGER Engagement Type:
1 – Contract
2 – Contract To Perm
3 – Perm
4 - Project
iscandcurrentlyemployedbyvendor
Flag Is Candidate Currently Employed By Vendor?
Y - Yes
N - No
iscandcurrentlypaidbyvendor
Flag Is Candidate Currently Paid By Vendor?
Y - Yes
N - No
availability   STRING Candidate Availability
vendorcandidateid   STRING Vendor Candidate ID
summaryofqualifications   STRING Summary Of Qualifications
skill1response   INTEGER Requisition Skill Response 1
1 – Close
2 – Exceeds
3 – Meets
4 - Not at all
skill1amountofexperienceduration   INTEGER Requisition Skill 1 Amount of Experience Duration
skill1amountofexperienceunits   INTEGER Requisition Skill 1 Amount of Experience Units
1 – Days
2 – Weeks
3 – Months
4 - Years
skill1expertiserating   INTEGER Requisition Skill 1 Expertise Rating - value based upon client configuration
skill2response   INTEGER Requisition Skill Response 2
1 – Close
2 – Exceeds
3 – Meets
4 - Not at all
skill2amountofexperienceduration   INTEGER Requisition Skill 2 Amount of Experience Duration
skill2amountofexperienceunits   INTEGER Requisition Skill 2 Amount of Experience Units
1 – Days
2 – Weeks
3 – Months
4 - Years
skill2expertiserating   INTEGER Requisition Skill 2 Expertise Rating - value based upon client configuration
skill3response   INTEGER Requisition Skill Response 3
1 – Close
2 – Exceeds
3 – Meets
4 - Not at all
skill3amountofexperienceduration   INTEGER Requisition Skill 3 Amount of Experience Duration
skill3amountofexperienceunits   INTEGER Requisition Skill 3 Amount of Experience Units
1 – Days
2 – Weeks
3 – Months
4 - Years
skill3expertiserating   INTEGER Requisition Skill 3 Expertise Rating - value based upon client configuration
skill4response   INTEGER Requisition Skill Response 4
1 – Close
2 – Exceeds
3 – Meets
4 - Not at all
skill4amountofexperienceduration   INTEGER Requisition Skill 4 Amount of Experience Duration
skill4amountofexperienceunits   INTEGER Requisition Skill 4 Amount of Experience Units
1 – Days
2 – Weeks
3 – Months
4 - Years
skill4expertiserating   INTEGER Requisition Skill 4 Expertise Rating - value based upon client configuration
skill5response   INTEGER Requisition Skill Response 5
1 – Close
2 – Exceeds
3 – Meets
4 - Not at all
skill5amountofexperienceduration   INTEGER Requisition Skill 5 Amount of Experience Duration
skill5amountofexperienceunits   INTEGER Requisition Skill 5 Amount of Experience Units
1 – Days
2 – Weeks
3 – Months
4 - Years
skill5expertiserating   INTEGER Requisition Skill 5 Expertise Rating - value based upon client configuration
skill6response   INTEGER Requisition Skill Response 6
1 – Close
2 – Exceeds
3 – Meets
4 - Not at all
skill6amountofexperienceduration   INTEGER Requisition Skill 6 Amount of Experience Duration
skill6amountofexperienceunits   INTEGER Requisition Skill 6 Amount of Experience Units
1 – Days
2 – Weeks
3 – Months
4 - Years
skill6expertiserating   INTEGER Requisition Skill 6 Expertise Rating - value based upon client configuration
skill7response   INTEGER Requisition Skill Response 7
1 – Close
2 – Exceeds
3 – Meets
4 - Not at all
skill7amountofexperienceduration   INTEGER Requisition Skill 7 Amount of Experience Duration
skill7amountofexperienceunits   INTEGER Requisition Skill 7 Amount of Experience Units
1 – Days
2 – Weeks
3 – Months
4 - Years
skill7expertiserating   INTEGER Requisition Skill 7 Expertise Rating - value based upon client configuration
skill8response   INTEGER Requisition Skill Response 8
1 – Close
2 – Exceeds
3 – Meets
4 - Not at all
skill8amountofexperienceduration   INTEGER Requisition Skill 8 Amount of Experience Duration
skill8amountofexperienceunits   INTEGER Requisition Skill 8 Amount of Experience Units
1 – Days
2 – Weeks
3 – Months
4 - Years
skill8expertiserating   INTEGER Requisition Skill 8 Expertise Rating - value based upon client configuration
skill9response   INTEGER Requisition Skill Response 9
1 – Close
2 – Exceeds
3 – Meets
4 - Not at all
skill9amountofexperienceduration   INTEGER Requisition Skill 9 Amount of Experience Duration
skill9amountofexperienceunits   INTEGER Requisition Skill 9 Amount of Experience Units
1 – Days
2 – Weeks
3 – Months
4 - Years
skill9expertiserating   INTEGER Requisition Skill 9 Expertise Rating - value based upon client configuration
skill10response   INTEGER Requisition Skill Response 10
1 – Close
2 – Exceeds
3 – Meets
4 - Not at all
skill10amountofexperienceduration   INTEGER Requisition Skill 10 Amount of Experience Duration
skill10amountofexperienceunits   INTEGER Requisition Skill 10 Amount of Experience Units
1 – Days
2 – Weeks
3 – Months
4 - Years
skill10expertiserating   INTEGER Requisition Skill 10 Expertise Rating - value based upon client configuration
answer1   STRING Answer to Requisition Question 1
answer2   STRING Answer to Requisition Question 2
answer3   STRING Answer to Requisition Question 3
answer4   STRING Answer to Requisition Question 4
answer5   STRING Answer to Requisition Question 5
iscandindependantcontractor   Flag Is Candidate an Independent Contractor?
Y - Yes
N - No (Default)
wascandeveremployedbyclient   Flag Was Candidate ever employed by client?
Y - Yes
N - No (Default)
candcitizenshipstatus   STRING Candidate Citizenship Status (valid values listed):
  US Citizen
  H1B
  K1
  Green card
  F1
  Other
  Authorized Canadian Worker
  Canadian Citizen
  Landed Immigrant
  Authorized UK Worker
candcitizenshipexplain   STRING If Citizenship Status other, then explain
billrate   Decimal Client Rate
vendorrate   Decimal Vendor Rate
payrate   Decimal Direct Labor Rate
budgetrate   Decimal Budget Rate
candidatecomments   STRING Candidate Comments
candcustomfield1   STRING Candidate Custom Field 1 Response
candcustomfield2   STRING Candidate Custom Field 2 Response
candcustomfield3   STRING Candidate Custom Field 3 Response
candcustomfield4   STRING Candidate Custom Field 4 Response
candcustomfield5   STRING Candidate Custom Field 5 Response

version 13 as of 11 months ago by Gregory Kreh