API - Applicant

API - Applicant

Prerequisites

It's required to be authenticated to use the following methods. Furthermore, an API token with "Applicants" access level is mandatory.

Applicant profile

Essentially an applicant profile consists of basic  claim data . More Data can be added through different routes. To get more information about the appropriate calls, see the  documentation  of the route.

Extended applicant profile

Extended applicant profile data can be added, edited and deleted through API calls. All of them provides interfaces to operate on the applicant data. Find here a list of all routes:
  1. Api/Applicant/{applicantId}/CustomField
  2. Api/Applicant/Activities
  3. Api/Applicant/Activity
  4. Api/Applicant/Certificate
  5. Api/Applicant/Cv
  6. Api/Applicant/Document
  7. Api/Applicant/Education
  8. Api/Applicant/Experience
  9. Api/Applicant/History
  10. Api/Applicant/Knowledge
  11. Api/Applicant/Language
  12. Api/Applicant/LinkedIn
  13. Api/Applicant/Photo
  14. Api/Applicant/Publication
  15. Api/Applicant/Xing

Create an applicant profile

PUT  Api/Applicant?sendRegistrationEmail={sendRegistrationEmail}&url={url}
Besides the users basic claim data , it's possible to extend the users profile with more precise data. Therefore, the provided routes of the API should be used. See section "Extended applicant profile" above. 

Edit an applicant profile

Like creating an applicant profile, it's possible to edit an applicant profile through the API's POST requests. Basic applicant claim data , as well as extended applicant profile data can be edited and updated.
POST Api/Applicant/{applicantId}

Delete an applicant profile  

If it is intended to only delete extended applicant profile data, use the appropriate routes with a DELETE request.
Otherwise, if the whole applicant profile needs to be removed (including extended applicant profile data), two options are available via Url-parameters:
  1. Anonymization of the applicant profile
  2. Deletion of the applicant profile
DELETE Api/Applicant/{applicantId}?deleteCompletely={deleteCompletely}  

Anonymization 

The personal data of the applicant becomes anonymized. The applicant's lastname is set to an standardized name, such that the user quickly knows that the applicant was anonymized. All related applicant information is deleted from the database, except of the applicant-instance itself (= Id) and the applicants job applications. All history entries containing the name are deleted and the remaining entries are anonymized, which means that texts are removed and the occurring applicant name is removed. At the end of the anonymization a history entry is created. This means, the applicant will still affect statistics, but without any personal information.

Deletion

The whole applicant data will be deleted, including the applicant itself. Thus, the applicant will not have impact on any statistics and cannot be restored.


    • Related Articles

    • API - Questionnaires

      The eRecuiter application allows recruiters to create questionnaires to create questions for jobs. Questionnaires describes applicant information, that can be provided for that job during the application process. For all possible questions, an API ...

    • API - Reset Password

      Process The password reset process is basically devided into three parts. Step 1 - Trigger "I-Forget-My-Password"-Token First, the API has to be called ( http://api.erecruiter.net/Help/Api/POST-Api-Applicant-RequestPassword_email_url_culture ) ...

    • API - Auto-LogOn-URL

      The Auto-LogOn-URL is provided to applicants (on the applicant portal) and contacts (on the customer portal) to automatically log in at their portal. The Auto-LogOn-URL can be used in several mail templates in the eRecruiter web-application and is ...

    • API - External Profiles

      There are two possible ways for external profiles to be integrated into an applicant portal: Login with external profile Link with external profile Login with external profile Prerequisites The following prerequisites need to be met, if ...

    • Applicant Import

      The applicant import is an open source command line tool and can be found at https://github.com/eRecruiter/eRecruiter.ApplicantImport. Format The input file must be a tab-separated ("\t") Textfile in UTF8 format. The rows are separated by new line ...