Home > Guides > Administrator Guide > Integration > API

API

Need Help on this Topic? Email Support

The Cyber Recruiter API is implemented as a web service to be hosted (typically, but not required) on the existing Cyber Recruiter web server.  The web service exposes three .asmx objects used to access the SQL tables for Cyber Recruiter to develop programs outside of the core Cyber Recruiter and Careers tools.  Note: Using this tool directly access the SQL tables.  Writing data to the tables will NOT be tracked in the standard history screens (Requisition History and Applicant History) and could make troubleshooting more difficult.     

Setup

IMPORTANT:  The last parameter in ALL methods available through the API is called Auth.  

1. Download the API files to the Cyber Recruiter web server
   1. Version 9.x - www.VSPublic.com/CRUpdates/CR-API.zip
   2. Version 10.x  -   https://visibility.awsapps.com/workdocs/index.html#/share/document/cd088b93d5f774cdeae38e0116aea7781fa9ba815d60bb7bf4d1c67eaaba3af0.  Passcode 9992
2.  Create a website application in IIS pointed to this location.  It does not need to be public.
3. Obtain the "auth" key for your database.  This will be the value for the ConString in the webconfig file for Cyber Recruiter. 
4. Start to program.

CRCodes.asmx Methods

Purpose: Maintains Cyber Recruiter’s existing code tables

GetTables:  Pulls all of the enumerated tables that are available to manipulate in Cyber Recruiter.  Returns a string array of length 70

AddCode: Used to insert a new code into Cyber Recruiter.  Takes 3 parameters, all required.  Returns a status string.

DeleteCode:  Used to delete an existing code from a code tables.  Takes 2 parameters, both required.  Returns a status string.

EditCode:  Used to edit an existing code in a code table.  Takes 3 parameters, all required.  Returns a status string.

CRApplicants.asmx Methods

Purpose: To read, insert, or update applicants

The following methods are all simple retrieval methods that pull the available values for particular applicant fields.  None require a parameter and all return a string array.

AddApplicant:  Used to insert a new applicant into Cyber Recruiter.  Only first name and last name are required.  Returns, as a string, the applicant number automatically assigned to the new applicant.  Adds the new record to Cyber Recruiter as well as an applicant history record recording the insert.  The last parameter in the signature takes a valid requisition code from Cyber Recruiter but is NOT required.  If that parameter exists, then this new applicant will also be attached to that requisition and a history record added to that req.

AddApplicantEducation:  Adds an education record to an existing applicant.  The first two parameters, Applnum and School are required.

AddApplicantPreviousEmployment: Adds a previous employment record to an existing applicant.  The first two parameters, Applnum and Employer are required.

AddApplicantSkill:  Adds a new skill to an existing applicant.  The first two parameters, Applnum and SkillCode are required.

AddApplicantSecurityClearnace:  Adds a security clearance record to an existing applicant.  The 1^st and 3^rd parameters, Applnum and ClearanceType are required.

AddApplicantMilitaryHistory:  Adds a military history record to an existing applicant.  The first two parameters, Applnum and Branch are required.

AddApplicantNote:  Adds a note to an existing applicant.  The 1^st, 3^rd, and 6^th parameters, Applnum, NoteType, and Note are required.

AddApplicantHistory:  Adds a history record to an existing applicant.  The 1^st, 4^th, and 5^th parameters, Applnum, HistDate, and HistItem are required.  HistItem is a string field that takes any text you want to appear in the history record.

GetApplicantByApplnum:  Retrieve’s a complete applicant record in the format found below.  Takes one parameter, Applnum, which is required.  Returns one applicant.

GetApplicantsByStatus:  Takes one parameter, a list of statuses, which is required.  The list of available statuses can be found by calling the GetStatuses method.  If providing more than one status to the GetApplicantsByStatus method, each status must be separated by a comma.  This method will return as many applicants as are attached to the list of statuses provided.  Returned XML format can be found in below in the section titled 'Applicant XML Schema'.

GetApplicantsByReq:  Takes on parameter, a requisition code, which is required.  This method will return as many applicants as are attached to the requisition provided.  Returned XML format can be found in below in the section titled 'Applicant XML Schema'.

CRRequisitions.asmx Methods

Purpose: To read, insert, or update requisitions

The following methods are all simple retrieval methods that pull the available values for particular requisition fields.  None require a parameter and all return a string array.

AddRequisition:  Used to insert a new requisition into Cyber Recruiter.  Code, Description, and Status are required.  The Code must be a unique code.  If a requisition already exists with the code provided a duplicate message will be returned.  This method adds the new record to Cyber Recruiter as well as a requisition history record recording the insert. 

AddRequisitionApprover:  Adds an approver to an existing requisition.  The list of valid approvers can be found as the cumulative results of the GetRecruiters, GetHiringManagers, and GetEvaluators methods.  The 1^st and 2^nd parameters, Req and Approver, are required.  The last parameter, a Boolean, is used to indicate whether you want the API to send out the next req approval email as the last step of the AddRequisitionApprover method.

AddRequisitionNote: Adds a note to an existing requisition.  The 1^st, 2^nd, and 6^th parameters, Req, NoteType, and Note are required.

AddRequisitionCost:  Adds a cost item to an existing requisition.  The 1^st and 2^nd parameters, Req and Cost Item, are required.

AddRequisitionHistory:  Adds a history record to an existing requisition.  All three parameters, Req, HistDate, and HistItem are required.  HistItem is a string field that takes any text you want to appear in the history record.

GetAllRequisitions:  Retrieves all requisitions in the system in the format found below.  Takes no parameters.

GetRequisitionsByStatus:  Takes one parameter, a list of statuses, which is required.  The list of available statuses can be found by calling the GetStatuses method.  If providing more than one status to the GetRequisitionsByStatus method, each status must be separated by a comma.  This method will return as many requisitions as are attached to the list of statuses provided.  Returned XML format can be found in below in the section titled 'Requisition XML Schema'.

Applicant XML Schema

Unless noted, the value in the field will be the raw data from the SQL table.  This could be data typed in or could be the code associated with a drop-down value.

 Requisition XML Schema

​