GET Api/Applicant/{applicantId}/LogOnToken

Generates a log-on token for the given applicant.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
applicantId

Applicant ID

 integer

Required

Body Parameters

None.

Response Information

Resource Description

LogOn Token

ApplicantLogOnTokenResponse
NameDescriptionTypeAdditional information
ApplicantId

Applicant the log-on token has been issued for.

 integer

None.
LogOnToken

The log-on token for the applicant.

 string

None.
ExpiresAt

The expiration time for the log-on token.

 date

None.

Response Formats

application/json, text/json

Sample: 
{
  "ApplicantId": 1,
  "LogOnToken": "sample string 2",
  "ExpiresAt": "2025-01-09T10:40:31.3730587+01:00"
}

application/xml, text/xml

Sample: 
<ApplicantLogOnTokenResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Responses">
  <ApplicantId>1</ApplicantId>
  <ExpiresAt>2025-01-09T10:40:31.3730587+01:00</ExpiresAt>
  <LogOnToken>sample string 2</LogOnToken>
</ApplicantLogOnTokenResponse>