Applicant Export

Applicant Export

The eRecruiter support a XML feed that allows to export applicants to other systems based on either applicant ID, a search query or applicant status. The feed allows simple pagination and can be configured for the data that is required by the external consumer. The following data can be exported by the applicant export feed:
  1. applicant data (mandatory)
  2. applications (optional)
  3. history (optional)
  4. documents as paths or inline BASE64-encoded (optional)

Example XML

<?xml version="1.0" encoding="utf-8"?>
<applicants>
  <applicant>
    <id>1234567</id>
    <gender>male</gender>
    <title></title>
    <firstName>John</firstName>
    <lastName>Doe</lastName>
    <titleAfterName>MSc</titleAfterName>
    <street>Street 123</street>
    <zipCode>12345</zipCode>
    <city>City</city>
    <country>Austria</country>
    <birthdate>01-Jun-1900</birthdate>
    <phone>123-123-123</phone>
    <email> wolkerstorfer@gmail.com </email>
    <nationality>Austria</nationality>
    <updateDateUser>13.06.2016 13:59:04</updateDateUser>
    <updateDateApplicant>22.04.2016 15:14:43</updateDateApplicant>
 
    [...optional custom fields for application...]
  
    <experience>
      <company>ePunkt Internet Recruiting GmbH</company>
      <position>Master of Recruiting</position>
      <tasks>a lot of tasks</tasks>
      <quitReason>current position</quitReason>
      <careerLevel>4 - Management</careerLevel>
      <beginDate>Dec-2000</beginDate>
      <endDate></endDate>
    </experience>
    [...more experience...]   
 
    <education>
      <type>University</type>
      <location>Linz</location>
      <specialization>Recruiting</specialization>
      <isFinished>True</isFinished>
      <beginDate>Oct-2008</beginDate>
      <endDate>Jul-2010</endDate>
    </education>
  
    [...more education...]
 
    <document type="CV" format="pdf">\\path\to\document\cv.pdf</document>
    <document type="Photo" format="jpeg">\\path\to\document\photo.jpeg</document>
  
    [...more documents...]
 
    <job>
      <id>10907</id>
      <name>Senior Recruiter</name>
      <jobStatus>Open</jobStatus>
      <applicantJobStatus>Declined</applicantJobStatus>
      <user>Sue User</user>
    </job>
  
    [...more jobs...]  
 
    <history date="08/08/2013 22:00:44" user="">
      <type>Erstellung</type>
      <subject><![CDATA[]]></subject>
      <body><![CDATA[]]></body>
    </history>
  
    [...more history...]
     
  </applicant>
</applicants>

Applicant Data

These fields represent the applicant's base data and some meta-information. There may be some additional custom fields included in the feed which are based of the eRecruiter customization.

Field
Type
Description
id
number
eRecruiter ID
gender
male|female|other
gender
title
string
academic title before name
firstName
string
first name
lastName
string
last name
titleAfterName
string
academic title after name
street
string
street address
zipCode
string
address ZIP code
city
string
address city
country
string
address country
birthdate
date (DD-MMM-YYYY)
birth date
phone
string
phone number
email
string
e-mail address
nationality
string
nationality/citizenship
updateDateUser
date (DD.MM.YYYY HH:MM:SS)
date of last update by eRecruiter user
updateDateApplicant
date (DD.MM.YYYY HH:MM:SS)
date of last update by applicant

Experience

The applicants work experience.

Field
Type
Description
company
string
name of company
position
string
name of position
tasks
string
description of performed tasks
quitReason
string
reason for quitting
careerLevel
string
job/career level (based on customization)
beginDate
date (MMM-YYYY)
start date of job
endDate
date (MMM-YYYY)
end date of job (can be empty)

Education

The applicant's education.

Field
Type
Description
type
string
type of education (based on customization)
location
string
location of education, i.e. a city name
specialization
string
description of the education
isFinished
boolean
flag if the education has been finished
beginDate
date (MMM-YYYY)
start date of job
endDate
date (MMM-YYYY)
end date of job (can be empty)

Document

The applicant's document either as UNC-paths or inline as encoded documents.

Field
Type
Description
type
string
type of document (based on customization)
format
string
file format (MIME type)
content
string
path to the document or BASE64-encoded document

Job (Application)

The applicant's applications in the eRecruiter. There may be additional information, if the applicant accepted a job and hiring information has been added.

Field
Type
Description
id
number
eRecruiter job ID
name
string
name of the job
jobStatus
string
status of the job
applicantJobStatus
string
status of the applicant regarding to the job
user
string
name of the responsible eRecruiter user

History

The applicant's history in the eRecruiter including all history entries that were generated by the system or the eRecruiter users.

Field
Type
Description
date
date (MM/DD/YYYY HH:MM:SS)
date of history entry
type
string
type of entry
subject
string
subject/title
body
string
body text

Usage

The applicant export can either be used through the eRecruiter backend or through a web service. The eRecruiter user must have permissions to export data to either one of it.

eRecuiter

The eRecruiter backend user interface can be found under .../Modules/Export/.

Web service

The webservice URL is .../Services/ApplicantExport.ashx

Export modes

There are two possible export modes for either one or multiple applicants.
Common Parameter

Parameter
Type
Description
user
number
The ID of the user. The user must have the permission to export data. Required.
pass
string
The user's hashed password. Required.
documents
Ignore|LocalPaths|Encoded
Include the documents as paths (LocalPaths) or include them as a base 64 encoded string (Encoded). The default value is "Ignore".
history
true|false
Include the history information or not. The default value is "false".
jobs
true|false
Include the jobs of an applicant or not. The default value is "false".
Mode 1 - Single applicant export

Parameter
Type
Description
applicantId
number
The identifier of the applicant to export.
Mode 2 - Multiple applicant export

Parameter
Type
Description
statusGroups
{StatusGroup[,Date]|}

StatusGroup: Accepted|Denied|One|Two|Three|Four
Date: YYYY-MM-DD

Filters any applications in the specified status group, starting at the date if provided.

filter
string
Filters the applicants by a search phrase.
take
number
Specifies the number of applicants to be taken.
skip
number
Specifies the number of applicants to be skipped.
Status Groups of applicants
The four status groups of open applicants are mapped to the parameter values as shown in the table below.
Rejected applicants have status group "Denied". Placed applicants have status group "Accepted".

Status group
Parameter value
First status group
One
Second status group
Two
Third status group
Three
Fourth status group
Four

    • Related Articles

    • Project Export

      The eR enterprise project export service is able to export whole mandators (candidates, vacancies, accounts and some settings) to a JSON file, thus allowing a properly export at the end of a contract. This service is available for public SaaS ...

    • 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 ...

    • 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 ...

    • System Description

      Application Definitions / Legend This page describes the different types of system architectures the eRecruiter can be installed in. API eRecruiter API allows to exchange data for between the applicant portal or third-party applications with ...

    • DNS

      Important: The following is valid for Cloud-customers only! OnPremise-customers operate their own infrastructure and domains and therefore will have different DNS settings. To use your own domain for the API, the eRecruiter, the Customer Portal ...