POST Requisitions

Description:  Add new or edit existing requisition for a client.

Sample CURL:

curl -X POST "https://uat.vmsapi.vectorvms.com/requisitionimport?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 "Requisition 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

Requisition Payload:

[{ "requesttype": "", "orgid": "", "reqclassid": "", "fullreqpath": "", "titlerole": "", "noofopenings": "", "startdate": "", "enddate": "", "nonewsubmittalsafter": "", "clientinternalreq": "", "reqpriority": "", "citizenstatus": "", "duration": "", "durationtype": "", "ratestructure": "", "billrangefrom": "", "billrangeto": "", "ratesalarydescription": "", "maxpayrate": "", "payrateperiod": "", "nottoexceedrate": "", "nottoexceedratecode": "", "hoursunitsperday": "", "daysperweek": "", "reqstatus": "", "maximumbillrate": "", "engagementtype": "", "shortdescription": "", "completedescription": "", "behaviorcharacteristics": "", "skill1": "", "skilldescription1": "", "requireddesired1": "", "amountofexperience1": "", "amountofexperiencetype1": "", "expertiserating1": "", "skill2": "", "skilldescription2": "", "requireddesired2": "", "amountofexperience2": "", "amountofexperiencetype2": "", "skill3": "", "skilldescription3": "", "requireddesired3": "", "amountofexperience3": "", "amountofexperiencetype3": "", "expertiserating3": "", "skill4": "", "skilldescription4": "", "requireddesired4": "", "amountofexperience4": "", "amountofexperiencetype4": "", "expertiserating4": "", "skill5": "", "skilldescription5": "", "requireddesired5": "", "amountofexperience5": "", "amountofexperiencetype5": "", "expertiserating5": "", "skill6": "", "skilldescription6": "", "requireddesired6": "", "amountofexperience6": "", "amountofexperiencetype6": "", "expertiserating6": "", "skill7": "", "skilldescription7": "", "requireddesired7": "", "amountofexperience7": "", "amountofexperiencetype7": "", "expertiserating7": "", "skill8": "", "skilldescription8": "", "requireddesired8": "", "amountofexperience8": "", "amountofexperiencetype8": "", "expertiserating8": "", "skill9": "", "skilldescription9": "", "requireddesired9": "", "amountofexperience9": "", "amountofexperiencetype9": "", "expertiserating9": "", "skill10": "", "skilldescription10": "", "requireddesired10": "", "amountofexperience10": "", "amountofexperiencetype10": "", "expertiserating10": "", "question1": "", "questiondescription1": "", "question2": "", "questiondescription2": "", "question3": "", "questiondescription3": "", "question4": "", "questiondescription4": "", "question5": "", "questiondescription5": "", "clientcontactfirstname": "", "clientcontactlastname": "", "clientcontactid": "", "reqownerfirstname": "", "reqownerlastname": "", "reqownerid": "", "reportstofirstname": "", "reportstolastname": "", "reportstoid": "", "altemail": "", "worklocationrefcode": "", "costcenterrefcode": "", "glrefcode": "", "divbranch": "", "projectrefcode": "", "worklocationid": "", "costcenterid": "", "glid": "", "projectid": "", "customfieldvalue1": "", "customfieldvalue2": "", "customfieldvalue3": "", "customfieldvalue4": "", "customfieldvalue5": "", "customfieldvalue6": "", "customfieldvalue7": "", "customfieldvalue8": "", "customfieldvalue9": "", "customfieldvalue10": "" }]

Requisition Payload Key

Requisition Payload Field Required for Insert (I) - field must be included in body and contain data Required for Amend (A) - field must be included in body and contain data Data Type Description
requesttype Y Y FLAG Flag that indicates requisition action to be taken:
I - Insert
A - Amend
orgid Y Y INTEGER Org ID for the client where requisition is to be Inserted or Amended
reqclassid Y INTEGER Req Class ID for a valid req class in the specified org:
   -- Must match a valid req class id in the specified org
   -- Required for (I) only if fullreqpath is blank
fullreqpath Y STRING Full for a valid req class in the specified org, separated by |:
   -- Must match a valid req class in the specified org
   -- Required for (I) only if reqclassid is blank
titlerole Y STRING Requisition Job Title
noofopenings Y INTEGER Number of Opening/Positions on this Requisition
startdate DATE Requisition Start Date
enddate DATE Requisition End Date
nonewsubmittalsafter DATE Last Date for Submittal of candidates for this requisition
clientinternalreq Y STRING Client internal requisition reference:
   -- Value can not be duplicated within the same client organization
   -- Value is used to identify requisition for Amend (A)
       --- Client Internal Req or Req ID may be entered in field for Amend
reqpriority INTEGER Requisition Priority Level:
1 – High
2 – Medium
3 – Low
If blank on Insert (I), will default to Medium (2)
citizenstatus INTEGER Requisition Citizen Status:
1 – US Citizen
2 – Authorised US Worker
3 – Open
4 – Authorised Cdn Worker
5 – Cdn Citizen
6 – Landed Immigrant
duration INTEGER Requisition Duration
durationtype INTEGER Requisition Duration Type:
1 – Days
2 – Weeks
3 – Months
4 – Years
ratestructure INTEGER VMS System ID for Rate Structure used by the requisition
billrangefrom DECIMAL Requisition Hourly High
billrangeto DECIMAL Requisition Hourly Low
ratesalarydescription STRING Requisition Rate/Salary Description
maxpayrate DECIMAL Requisition Max Pay Rate
payrateperiod INTEGER

Requisition Pay Rate Period:
1 – Per Hour
2 – Per Day
3 – Per Year
This will default to Per Hour if blank
nottoexceedrate DECIMAL Requisition Not To Exceed Rate
nottoexceedratecode Y - If App Setting "Allow new engagements to exceed Hourly High Bill Rate on Requisition or Requisition Budget when engaging a candidate:" is set to Yes INTEGER

Requisition Not To Exceed Rate Code:
1 – Per Hour
2 – Per Week
3 – Per Month
4 – Per Year
5 – Per Day
6 – Per Unit
When using a medium form req, use this field to import the rate code for Bill Rate Low
hoursunitsperday Y DECIMAL Requisition Hour Per Day:
   -- Must be value from 0 to 24
   -- Will accept decimal values up to 2 places
daysperweek Y INTEGER Requisition Days Per Week:
   -- Must be value from 0 to 7
reqstatus INTEGER Requisition Status:
4 – Open
5 – Interview occurring
6 – Filled
8 – Closed/Cancelled
9 – On Hold
This field is only available for Amend (A).  All Inserted Reqs have an initial status of Open
maximumbillrate DECIMAL Can candidates be submitted above the maximum bill rate? (only appears on reqs if configured):
0 – No
1 – Yes
engagementtype Y INTEGER Engagement Type:
1 – Contract
2 – Contract To Perm
3 – Perm
 API only allows for a single cloice.  For Amend will only change the engagement type, will not add additional
shortdescription Y STRING Requisition Short Description Text
completedescription STRING Requisition Long Description Text
behaviorcharacteristics STRING Requisition Behavior Characteristics Text
skill1 INTEGER Skill item sequence number:
   -- First = 1, second = 2, etc
skilldescription1 STRING Requisition Skill 1 Description Text
requireddesired1 INTEGER Requisition Skill 1 Required/Desired value:
1 – Required
2 – Highly Desired
3 – Desired
4 - Nice to Have
5 - Not Required
amountofexperience1 DECIMAL Requisition Skill 1 Amount of Experience Duration
amountofexperiencetype1 INTEGER Requisition Skill 1 Amount of Experience Unit value:
1 – Days
2 – Weeks
3 – Months
4 - Years
expertiserating1 INTEGER Requisition Skill 1 Expertise Rating - value based upon client configuration
skill2 INTEGER Skill item sequence number:
   -- First = 1, second = 2, etc.
skilldescription2 STRING Requisition Skill 2 Description Text
requireddesired2 INTEGER Requisition Skill 2 Required/Desired value:
1 – Required
2 – Highly Desired
3 – Desired
4 - Nice to Have
5 - Not Required
amountofexperience2 DECIMAL Requisition Skill 2 Amount of Experience Duration
amountofexperiencetype2 INTEGER Requisition Skill 2 Amount of Experience Units
1 – Days
2 – Weeks
3 – Months
4 - Years
expertiserating2 INTEGER Requisition Skill 2 Expertise Rating - value based upon client configuration
skill3 INTEGER Skill item sequence number:
   -- First = 1, second = 2, etc.
skilldescription3 STRING Requisition Skill 3 Description Text
requireddesired3 INTEGER Requisition Skill 3 Required/Desired value:
1 – Required
2 – Highly Desired
3 – Desired
4 - Nice to Have
5 - Not Required
amountofexperience3 DECIMAL Requisition Skill 3 Amount of Experience Duration
amountofexperiencetype3 INTEGER Requisition Skill 3 Amount of Experience Units
1 – Days
2 – Weeks
3 – Months
4 - Years
expertiserating3 INTEGER Requisition Skill 3 Expertise Rating - value based upon client configuration
skill4 INTEGER Skill item sequence number:
   -- First = 1, second = 2, etc.
skilldescription4 STRING Requisition Skill 4 Description Text
requireddesired4 INTEGER Requisition Skill 4 Required/Desired value:
1 – Required
2 – Highly Desired
3 – Desired
4 - Nice to Have
5 - Not Required
amountofexperience4 DECIMAL Requisition Skill 4 Amount of Experience Duration
amountofexperiencetype4 INTEGER Requisition Skill 4 Amount of Experience Units
1 – Days
2 – Weeks
3 – Months
4 - Years
expertiserating4 INTEGER Requisition Skill 4 Expertise Rating - value based upon client configuration
skill5 INTEGER Skill item sequence number:
   -- First = 1, second = 2, etc.
skilldescription5 >STRING Requisition Skill 5 Description Text
requireddesired5 INTEGER Requisition Skill 5 Required/Desired value:
1 – Required
2 – Highly Desired
3 – Desired
4 - Nice to Have
5 - Not Required
amountofexperience5 DECIMAL Requisition Skill 5 Amount of Experience Duration
amountofexperiencetype5 INTEGER Requisition Skill 5 Amount of Experience Units
1 – Days
2 – Weeks
3 – Months
4 - Years
expertiserating5 INTEGER Requisition Skill 5 Expertise Rating - value based upon client configuration
skill6 INTEGER Skill item sequence number:
   -- First = 1, second = 2, etc.
skilldescription6 STRING Requisition Skill 6 Description Text
requireddesired6 INTEGER Requisition Skill 6 Required/Desired value:
1 – Required
2 – Highly Desired
3 – Desired
4 - Nice to Have
5 - Not Required
amountofexperience6 DECIMAL Requisition Skill 6 Amount of Experience Duration
amountofexperiencetype6 INTEGER Requisition Skill 6 Amount of Experience Units
1 – Days
2 – Weeks
3 – Months
4 - Years
expertiserating6 INTEGER Requisition Skill 6 Expertise Rating - value based upon client configuration
skill7 INTEGER Skill item sequence number:
   -- First = 1, second = 2, etc.
skilldescription7 STRING Requisition Skill 7 Description Text
requireddesired7 INTEGER Requisition Skill 7 Required/Desired value:
1 – Required
2 – Highly Desired
3 – Desired
4 - Nice to Have
5 - Not Required
amountofexperience7 DECIMAL Requisition Skill 7 Amount of Experience Duration
amountofexperiencetype7 INTEGER Requisition Skill 7 Amount of Experience Units
1 – Days
2 – Weeks
3 – Months
4 - Years
expertiserating7 INTEGER Requisition Skill 7 Expertise Rating - value based upon client configuration
skill8 INTEGER Skill item sequence number:
   -- First = 1, second = 2, etc.
skilldescription8
STRING Requisition Skill 8 Description Text
requireddesired8 INTEGER Requisition Skill 8 Required/Desired value:
1 – Required
2 – Highly Desired
3 – Desired
4 - Nice to Have
5 - Not Required
amountofexperience8 DECIMAL Requisition Skill 8 Amount of Experience Duration
amountofexperiencetype8 INTEGER Requisition Skill 8 Amount of Experience Units
1 – Days
2 – Weeks
3 – Months
4 - Years
expertiserating8 INTEGER Requisition Skill 8 Expertise Rating - value based upon client configuration
skill9 INTEGER Skill item sequence number:
   -- First = 1, second = 2, etc.
skilldescription9 STRING Requisition Skill 9 Description Text
requireddesired9 INTEGER Requisition Skill 9 Required/Desired value:
1 – Required
2 – Highly Desired
3 – Desired
4 - Nice to Have
5 - Not Required
amountofexperience9 DECIMAL Requisition Skill 9 Amount of Experience Duration
amountofexperiencetype9 INTEGER Requisition Skill 9 Amount of Experience Units
1 – Days
2 – Weeks
3 – Months
4 - Years
expertiserating9 INTEGER Requisition Skill 9 Expertise Rating - value based upon client configuration
skill10 INTEGER Skill item sequence number:
   -- First = 1, second = 2, etc.
skilldescription10 STRING Requisition Skill 10 Description Text
requireddesired10 INTEGER Requisition Skill 10 Required/Desired value:
1 – Required
2 – Highly Desired
3 – Desired
4 - Nice to Have
5 - Not Required
amountofexperience10 DECIMAL Requisition Skill 10 Amount of Experience Duration
amountofexperiencetype10 INTEGER Requisition Skill 10 Amount of Experience Units
1 – Days
2 – Weeks
3 – Months
4 - Years
expertiserating10 INTEGER Requisition Skill 10 Expertise Rating - value based upon client configuration
question1 INTEGER Question sequence number:
   -- First = 1, second = 2, etc.
questiondescription1 STRING Requisition Question 1 text
question2 INTEGER Question sequence number:
   -- First = 1, second = 2, etc.
questiondescription2 STRING Requisition Question 2 text
question3 INTEGER Question sequence number:
   -- First = 1, second = 2, etc.
questiondescription3 STRING Requisition Question 3 text
question4 INTEGER Question sequence number:
   -- First = 1, second = 2, etc.
questiondescription4 STRING Requisition Question 4 text
question5 INTEGER Question sequence number:
   -- First = 1, second = 2, etc.
questiondescription5 STRING Requisition Question 5 text
clientcontactfirstname STRING First Name of Requisition Client Contact:
   -- Must match first name from user profile exactly
   -- Not needed if ClientContactID used
clientcontactlastname STRING Last Name of Requisition Client Contact:
   -- Must match last name from user profile exactly
   -- Not needed if ClientContactID used
clientcontactid STRING User ID or Client Internal ID of Requisition Client Contact:
   -- Must match value from user profile exactly
   -- Not needed if ClientContactfirstname / lastname used
   -- For Insert (I) only, if all Client Contact field blank, Client Contact of req will default to Req Owner
reqownerfirstname Y STRING First Name of Requisition Owner:
   -- Must match first name from user profile exactly
   -- Not needed if ReqOwnertID used
reqownerlastname Y STRING Last Name of Requisition Owner:
   -- Must match last name from user profile exactly
   -- Not needed if ReqOwnerD used
reqownerid Y  STRING User ID or Client Internal ID of Requisition Owner:
   -- Must match value from user profile exactly
   -- Not needed if reqownerfirstname / lastname used
   -- For Amend (A) only, the Req Owner fields will only update the Req Owner of the specified requisition when Client Contact and Reports To fields are blank
reportstofirstname
STRING First Name of Requisition Reports To User:
   -- Must match first name from user profile exactly
   -- Not needed if reportstoid used
reportstolastname
STRING Last Name of Requisition Reports To User:
   -- Must match last name from user profile exactly
   -- Not needed if reportstoid used
reportstoid STRING User ID or Client Internal ID of Requisition Reports To User:
   -- Must match value from user profile exactly
   -- Not needed if reportstofirstname / lastname used
   -- For Insert (I) only, if all Reports To User fields blank, Reports To user of req will default to Req Owner
altemail STRING Requisition Alternate email address
worklocationrefcode STRING Requisition Work Location Reference Code
   -- Use this or worklocationid to indicate location associated to requisition
costcenterrefcode STRING Requisition Cost Center Reference Code
   -- Use this or costcenterid to indicate cost center associated to requisition
glrefcode STRING Requisition GL Reference Code
   -- Use this or glidto indicate GL associated to requisition
divbranch STRING Requisition Division / Branch
projectrefcode STRING Requisition Project Reference Code
   -- Use this or projectid to indicate project associated to requisition
   -- Only one project can be associated to the requisition via the API
worklocationid NTEGER Requisition Work Location VMS ID
   -- Use this or worklocationrefcode to indicate location associated to requisition
costcenterid INTEGER Requisition Cost Center VMS ID
   -- Use this or costcenterrefcode to indicate cost center associated to requisition
glid INTEGER Requisition GL VMS ID
   -- Use this or glrefcode indicate GL associated to requisition
projectid INTEGER Requisition Project VMS ID
   -- Use this or projectrefcode to indicate project associated to requisition
   -- Only one project can be associated to the requisition via the API
customfieldvalue1 STRING Requisition Custom Field 1 Value
customfieldvalue2 STRING Requisition Custom Field 2 Value
customfieldvalue3 STRING Requisition Custom Field 3 Value
customfieldvalue4 STRING Requisition Custom Field 4 Value
customfieldvalue5 STRING Requisition Custom Field 5 Value
customfieldvalue6 STRING Requisition Custom Field 6 Value
customfieldvalue7 STRING Requisition Custom Field 7 Value
customfieldvalue8 STRING Requisition Custom Field 8 Value
customfieldvalue9 STRING Requisition Custom Field 9 Value
customfieldvalue10 STRING Requisition Custom Field 10 Value
RequestType

version 71 as of 6 months ago by Gregory Kreh