Prerequisites

It's assumed that the requesting user is authenticated and there is an existing job on which an applicant wants to apply. The following actions could be performed for an application:

Apply for an existing job
Apply again for an existing application

Creating an application

Use the following endpoint to create a request for a job application.

PUT Api/Application?url={url}&sendApplicationEmail={sendApplicationEmail}

URI Parameters

Use parameter url to specify the application source which is used to determine the related settings for the used portal. If not provided, the default portal url of the current mandator will be used.

The parameter sendApplicationEmail specifies whether to send an eMail to the applicant (rendered from a template defined in the portal) or not.

Body Parameters

Referrer

This parameter describes the application source. It's highly recommended to provide this parameter, since it can be used to generate statistics from what site your applicants come from (e.g. karriere.at, willhaben.at, StepStone, ...).

CoverLetter

The applicant is able to attach a personal cover letter to the application. It can be viewed in the eRecruiter.

RefreshApplicationIfItAlreadyExists

This flag defines the behavior of existing applications.

Flag (RefreshApplicationIfItAlreadyExists)	Existing application in eRecruiter	API Behavoir
No	No	Create application (No impact of the Flag)
No	Yes	Ignore application ( Neither a confirmation E-Mail will be sent nor an Cover Letter will be created)
Yes	No	Create application (No impact of the Flag)
Yes	Yes	Update an existing application. An History entry will be created with the information that the applicant has applied again and additionally, an internal Message will be sent to the responsible recruiter attached to the job.

Response

The response contains messages about errors that occured during the application. Here is a list of possible messages (please note: a response could contain more than one message):

ApplicantDoesNotExist - The applicant Id does not exist, or at least does not exist for the current mandator.
JobDoesNotExist - The provided job Id does not exist, or at least does not exist for the current mandator.
JobIsClosed - Job is not enabled on the Channel or Portal.
ApplicationAlreadyExists - If there is an existing online-job-application for this job and the RefreshApplicationIfItAlreadyExists flag is set to no.

Update an Application

This section described how to update an existing application. Use the following request to edit an application.

POST Api/Application/{applicantJobId}

The following action can be applied to an application:

Trigger an workflow transition
Send an internal message to the job-contact-person
Edit the referrer

Body Parameter

Message

This parameter can contain a message for the job-contact-person.

Activity

This parameter can trigger an workflow transition. The following errors could occur:

Invalid identifier for the activity
The provided activity is not supported for this applicant
The provided activity is not a valid transition from the current state

For an valid activity, the state of the application will be set to the provided one.

Referrer

Update the referrer and additional referrer information

Response

The server response contains the following information:

attribute	description
Id	Id of the application
ApplicantId	Id of the applicant
JobId	Id fo the job this application is for
Referrer	Current value of the referrer
ReferrerAdditionalInfo	Current value of the additional information of the referrer
Status	Name of the application status
StatusForApplicant	If available, it's the status name of the current application status for the applicant Portal. If not available, it has the same value as Status
StatusForContact	If available, it's the status name of the current application status for the customer Portal. If not available, it has the same value as Status
IsVisibleToApplicant	Indicates, whether to show the application-status on the applicant portal or not.
IsVisibleToContact	Indicates, whether to show the application-status on the customerportal or not.
AvailableActivities	A list of possible status transitions (= acitivies, see below)

Activity:

attribute	description
Name	Name of the activity
NameForApplicant	If available, a name for the applicant portal, the name otherwise
NameForContact	if available, a name for the customer portal, the name otherwise
IsVisibleToApplicant	Determines, if activity should be visible to applicant
AvailableToContact	None - Don't display on company portal Simple - Display on company portal Full - Display at company portal and allow direct communication

Browser not supported