POST Api/Application/{applicantJobId}

Updates an existing application. This is used to update an application referrer, but more importantly to execute a workflow activity.

Request Information

URI Parameters

Name	Description	Type	Additional information
applicantJobId	The application ID.	integer	Required

Body Parameters

The input parameters.

ApplicationUpdateParameter

Name	Type	Additional information
Message	string	None.
Activity	string	None.
Referrer	string	None.
ReferrerAdditionalInfo	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Message": "sample string 1",
  "Activity": "sample string 2",
  "Referrer": "sample string 3",
  "ReferrerAdditionalInfo": "sample string 4"
}

application/xml, text/xml

Sample:

<ApplicationUpdateParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">
  <Activity>sample string 2</Activity>
  <Message>sample string 1</Message>
  <Referrer>sample string 3</Referrer>
  <ReferrerAdditionalInfo>sample string 4</ReferrerAdditionalInfo>
</ApplicationUpdateParameter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The updated application.

ApplicationResponse

Name	Description	Type	Additional information
Id	The unique identifier of the application.	integer	None.
ApplicantId	The id of the associated applicant to this application.	integer	None.
JobId	The id of the associated job.	integer	None.
Status	The current status of the application.	string	None.
StatusForApplicant		string	None.
StatusForContact		string	None.
IsVisibleToApplicant	Specifies wether the application is visible to the applicant or not.	boolean	None.
IsVisibleToContact	Specifies wether the application is visible to the job contact or not.	boolean	None.
Referrer	The referrer specifies from which source the applicant applied to the job.	string	None.
ReferrerAdditionalInfo	Some additional info to the .	string	None.
AvailableActivities		Collection of ApplicationActivityResponse	None.
WorkflowStatusGroup		WorkflowStatusGroup	None.
Rating		integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "ApplicantId": 2,
  "JobId": 3,
  "Status": "sample string 4",
  "StatusForApplicant": "sample string 5",
  "StatusForContact": "sample string 6",
  "IsVisibleToApplicant": true,
  "IsVisibleToContact": true,
  "Referrer": "sample string 9",
  "ReferrerAdditionalInfo": "sample string 10",
  "AvailableActivities": [
    {
      "Name": "sample string 1",
      "NameForApplicant": "sample string 2",
      "NameForContact": "sample string 3",
      "IsVisibleToApplicant": true,
      "AvailableToContact": 0
    },
    {
      "Name": "sample string 1",
      "NameForApplicant": "sample string 2",
      "NameForContact": "sample string 3",
      "IsVisibleToApplicant": true,
      "AvailableToContact": 0
    }
  ],
  "WorkflowStatusGroup": 0,
  "Rating": 1
}

application/xml, text/xml

Sample:

<ApplicationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Responses">
  <ApplicantId>2</ApplicantId>
  <AvailableActivities>
    <ApplicationResponse.ApplicationActivityResponse>
      <AvailableToContact>None</AvailableToContact>
      <IsVisibleToApplicant>true</IsVisibleToApplicant>
      <Name>sample string 1</Name>
      <NameForApplicant>sample string 2</NameForApplicant>
      <NameForContact>sample string 3</NameForContact>
    </ApplicationResponse.ApplicationActivityResponse>
    <ApplicationResponse.ApplicationActivityResponse>
      <AvailableToContact>None</AvailableToContact>
      <IsVisibleToApplicant>true</IsVisibleToApplicant>
      <Name>sample string 1</Name>
      <NameForApplicant>sample string 2</NameForApplicant>
      <NameForContact>sample string 3</NameForContact>
    </ApplicationResponse.ApplicationActivityResponse>
  </AvailableActivities>
  <Id>1</Id>
  <IsVisibleToApplicant>true</IsVisibleToApplicant>
  <IsVisibleToContact>true</IsVisibleToContact>
  <JobId>3</JobId>
  <Rating>1</Rating>
  <Referrer>sample string 9</Referrer>
  <ReferrerAdditionalInfo>sample string 10</ReferrerAdditionalInfo>
  <Status>sample string 4</Status>
  <StatusForApplicant>sample string 5</StatusForApplicant>
  <StatusForContact>sample string 6</StatusForContact>
  <WorkflowStatusGroup>None</WorkflowStatusGroup>
</ApplicationResponse>