PUT Api/Applicant/History/{applicantId}

Creates a new history entry for a specified applicant.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
applicantId

The ID of the applicant.

integer

Required

Body Parameters

The history parameter.

ApplicantHistoryParameter
NameDescriptionTypeAdditional information
JobId

The id of an optionally related job.

integer

None.

Subject

The subject of the history entry.

string

None.

Body

The content of the history entry.

string

None.

Type

The type of the history entry.

HistoryType

None.

CreatedBy

The information (mostly the name of the applicant, user) who created this history entry.

string

None.

Request Formats

application/json, text/json

Sample:
{
  "JobId": 1,
  "Subject": "sample string 1",
  "Body": "sample string 2",
  "Type": 0,
  "CreatedBy": "sample string 3"
}

application/xml, text/xml

Sample:
<ApplicantHistoryParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">
  <Body>sample string 2</Body>
  <CreatedBy>sample string 3</CreatedBy>
  <JobId>1</JobId>
  <Subject>sample string 1</Subject>
  <Type>Manual</Type>
</ApplicantHistoryParameter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The created history entry.

ApplicantHistoryResponse
NameDescriptionTypeAdditional information
JobId

The id of an optionally related job.

integer

None.

Subject

The subject of the history entry.

string

None.

Body

The content of the history entry.

string

None.

Type

The type of the history entry.

HistoryType

None.

CreatedBy

The information (mostly the name of the applicant, user) who created this history entry.

string

None.

Response Formats

application/json, text/json

Sample:
{
  "JobId": 1,
  "Subject": "sample string 1",
  "Body": "sample string 2",
  "Type": 0,
  "CreatedBy": "sample string 3"
}

application/xml, text/xml

Sample:
<ApplicantHistoryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Responses">
  <Body xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 2</Body>
  <CreatedBy xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 3</CreatedBy>
  <JobId xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">1</JobId>
  <Subject xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 1</Subject>
  <Type xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">Manual</Type>
</ApplicantHistoryResponse>