GET Api/Applicant?usernameOrEmail={usernameOrEmail}&password={password}

Returns an applicant profile by its user credentials, if it exists.

Request Information

URI Parameters

Name	Description	Type	Additional information
usernameOrEmail	The username of the applicant. This is usually the e-mail address.	string	Required
password	The password of the applicant. This must be supplied in clear text. Don't worry, the passwords are stored only as hashes.	string	Required

Body Parameters

None.

Response Information

Resource Description

The applicant profile. Returns HTTP 404 if no matching applicant can be found. Returns HTTP 400 if one or more parameters are missing.

ApplicantResponse

Name	Description	Type	Additional information
Id	The unique identifier of an applicant.	integer	None.
DateOfUpdateByUser		date	None.
DateOfUpdateByApplicant		date	None.
HasCv	Specifies wether the applicant has a curriculum vitae or not.	boolean	None.
HasPhoto	Specifies wether the applicant has a picture or not.	boolean	None.
HasApplicationsVisibleToApplicant	Specifies if there are any applications on a job, which are visible to the applicant.	boolean	None.
DocumentsCount		integer	None.
ActivitiesCount		integer	None.
ExperiencesCount		integer	None.
EducationsCount		integer	None.
CertificatesCount		integer	None.
LanguagesCount		integer	None.
PublicationsCount		integer	None.
ThirdPartyProfiles		Collection of ApplicantThirdPartyProfileResponse	None.
DateOfCreation	The date when the applicant was created in the database.	date	None.
GlobalId	Global identifier for same appliant in different mandators.	integer	None.
ExternalId	Optional identifier for third party applications.	integer	None.
FirstName	The first name of an applicant.	string	None.
LastName	The surname of an applicant.	string	None.
Email	The applicant's email address.	string	None.
Gender	The applicant's gender.	Gender	None.
GenderIdentity	The applicant's gender identity.	GenderIdentity	None.
TitleBeforeName	The academic title, which usually is written before an applicant's name.	string	None.
TitleAfterName	The academic degree, which usually is written after an applicant's name.	string	None.
BirthDate	The date of birth.	date	None.
Street	The street of an applicant's address.	string	None.
City	The city of an applicant's address.	string	None.
ZipCode	The ZIP (Zone Improvement Plan) code of an applicant's address.	string	None.
Country	The country of an applicant's address.	string	None.
Citizenship	The citizenship of an applicant.	string	None.
Phone	The telephone number of an applicant.	string	None.
MobilePhone	The mobile phone number of an applicant.	string	None.
Url		string	None.
IsActive		boolean	None.
IsLocked		boolean	None.
EnableNewsletter		boolean	None.
EnableMatchingJobsAutoMail		boolean	None.
Tags		Collection of string	None.
JobProfiles		Collection of string	None.
Regions		Collection of string	None.
CareerLevel		string	None.
Location		string	None.
Salary		integer	None.
SalaryNotes		string	None.
SalaryCurrency		string	None.
SalaryPeriod		SalaryPeriodType	None.
DomesticTravelling		string	None.
AbroadTravelling		string	None.
EarliestPossibleBeginDate		FlexDate	None.
PhoneTime		string	None.
MilitaryService		MilitaryServiceType	None.
MilitaryServiceStart		FlexDate	None.
MilitaryServiceEnd		FlexDate	None.
MilitaryServiceReliefReason		string	None.
IsWillingToMove		boolean	None.
IsInterestedInInternship		boolean	None.
IsInterestedInFulltime		boolean	None.
IsInterestedInFreelancer		boolean	None.
IsInterestedInPartTime		boolean	None.
OvertimeHours		integer	None.
PartTimeHours		integer	None.
Referrer		string	None.
ReferrerAdditionalInfo		string	None.
Classification		string	None.
ClassificationReason		string	None.
ImportantInfo		string	None.
SelfDescription		string	None.
JobDescription		string	None.
Culture	Is used for determining the spoken language, taken from the browser, Emails are generated in that language	string	None.
MaximumDistanceToJobLocation	Gets or sets the maximum distance to a job location desired by the applicant.	decimal number	None.
PolicyAcceptedAt	Get or set the date when the privacy policy has been accepted.	date	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "DateOfUpdateByUser": "2024-12-27T23:42:31.0597261+01:00",
  "DateOfUpdateByApplicant": "2024-12-27T23:42:31.0597261+01:00",
  "HasCv": true,
  "HasPhoto": true,
  "HasApplicationsVisibleToApplicant": true,
  "DocumentsCount": 7,
  "ActivitiesCount": 8,
  "ExperiencesCount": 9,
  "EducationsCount": 10,
  "CertificatesCount": 11,
  "LanguagesCount": 12,
  "PublicationsCount": 13,
  "ThirdPartyProfiles": [
    {
      "ThirdParty": "sample string 1",
      "Identifier": "sample string 2",
      "Url": "sample string 3"
    },
    {
      "ThirdParty": "sample string 1",
      "Identifier": "sample string 2",
      "Url": "sample string 3"
    }
  ],
  "DateOfCreation": "2024-12-27T23:42:31.0597261+01:00",
  "GlobalId": 1,
  "ExternalId": 1,
  "FirstName": "sample string 15",
  "LastName": "sample string 16",
  "Email": "sample string 17",
  "Gender": 0,
  "GenderIdentity": 0,
  "TitleBeforeName": "sample string 18",
  "TitleAfterName": "sample string 19",
  "BirthDate": "2024-12-27T23:42:31.0597261+01:00",
  "Street": "sample string 20",
  "City": "sample string 21",
  "ZipCode": "sample string 22",
  "Country": "sample string 23",
  "Citizenship": "sample string 24",
  "Phone": "sample string 25",
  "MobilePhone": "sample string 26",
  "Url": "sample string 27",
  "IsActive": true,
  "IsLocked": true,
  "EnableNewsletter": true,
  "EnableMatchingJobsAutoMail": true,
  "Tags": [
    "sample string 1",
    "sample string 2"
  ],
  "JobProfiles": [
    "sample string 1",
    "sample string 2"
  ],
  "Regions": [
    "sample string 1",
    "sample string 2"
  ],
  "CareerLevel": "sample string 32",
  "Location": "sample string 33",
  "Salary": 1,
  "SalaryNotes": "sample string 34",
  "SalaryCurrency": "sample string 35",
  "SalaryPeriod": 0,
  "DomesticTravelling": "sample string 36",
  "AbroadTravelling": "sample string 37",
  "EarliestPossibleBeginDate": {
    "Year": 1,
    "Month": 1,
    "Day": 1,
    "IsRelativeDate": true,
    "IsValid": false,
    "IsEmpty": false
  },
  "PhoneTime": "sample string 38",
  "MilitaryService": 0,
  "MilitaryServiceStart": {
    "Year": 1,
    "Month": 1,
    "Day": 1,
    "IsRelativeDate": true,
    "IsValid": false,
    "IsEmpty": false
  },
  "MilitaryServiceEnd": {
    "Year": 1,
    "Month": 1,
    "Day": 1,
    "IsRelativeDate": true,
    "IsValid": false,
    "IsEmpty": false
  },
  "MilitaryServiceReliefReason": "sample string 39",
  "IsWillingToMove": true,
  "IsInterestedInInternship": true,
  "IsInterestedInFulltime": true,
  "IsInterestedInFreelancer": true,
  "IsInterestedInPartTime": true,
  "OvertimeHours": 1,
  "PartTimeHours": 1,
  "Referrer": "sample string 40",
  "ReferrerAdditionalInfo": "sample string 41",
  "Classification": "sample string 42",
  "ClassificationReason": "sample string 43",
  "ImportantInfo": "sample string 44",
  "SelfDescription": "sample string 45",
  "JobDescription": "sample string 46",
  "Culture": "sample string 47",
  "MaximumDistanceToJobLocation": 1.1,
  "PolicyAcceptedAt": "2024-12-27T23:42:31.0597261+01:00"
}

application/xml, text/xml

Sample:

<ApplicantResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Responses">
  <AbroadTravelling xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 37</AbroadTravelling>
  <BirthDate xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">2024-12-27T23:42:31.0597261+01:00</BirthDate>
  <CareerLevel xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 32</CareerLevel>
  <Citizenship xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 24</Citizenship>
  <City xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 21</City>
  <Classification xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 42</Classification>
  <ClassificationReason xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 43</ClassificationReason>
  <Country xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 23</Country>
  <Culture xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 47</Culture>
  <DateOfCreation xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">2024-12-27T23:42:31.0597261+01:00</DateOfCreation>
  <DomesticTravelling xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 36</DomesticTravelling>
  <EarliestPossibleBeginDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/eRecruiter.Api" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">
    <d2p1:Day>1</d2p1:Day>
    <d2p1:IsRelativeDate>true</d2p1:IsRelativeDate>
    <d2p1:Month>1</d2p1:Month>
    <d2p1:Year>1</d2p1:Year>
  </EarliestPossibleBeginDate>
  <Email xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 17</Email>
  <EnableMatchingJobsAutoMail xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">true</EnableMatchingJobsAutoMail>
  <EnableNewsletter xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">true</EnableNewsletter>
  <ExternalId xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">1</ExternalId>
  <FirstName xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 15</FirstName>
  <Gender xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">Unknown</Gender>
  <GenderIdentity xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">Unknown</GenderIdentity>
  <GlobalId xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">1</GlobalId>
  <ImportantInfo xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 44</ImportantInfo>
  <IsActive xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">true</IsActive>
  <IsInterestedInFreelancer xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">true</IsInterestedInFreelancer>
  <IsInterestedInFulltime xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">true</IsInterestedInFulltime>
  <IsInterestedInInternship xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">true</IsInterestedInInternship>
  <IsInterestedInPartTime xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">true</IsInterestedInPartTime>
  <IsLocked xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">true</IsLocked>
  <IsWillingToMove xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">true</IsWillingToMove>
  <JobDescription xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 46</JobDescription>
  <JobProfiles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </JobProfiles>
  <LastName xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 16</LastName>
  <Location xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 33</Location>
  <MaximumDistanceToJobLocation xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">1.1</MaximumDistanceToJobLocation>
  <MilitaryService xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">NotYetDone</MilitaryService>
  <MilitaryServiceEnd xmlns:d2p1="http://schemas.datacontract.org/2004/07/eRecruiter.Api" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">
    <d2p1:Day>1</d2p1:Day>
    <d2p1:IsRelativeDate>true</d2p1:IsRelativeDate>
    <d2p1:Month>1</d2p1:Month>
    <d2p1:Year>1</d2p1:Year>
  </MilitaryServiceEnd>
  <MilitaryServiceReliefReason xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 39</MilitaryServiceReliefReason>
  <MilitaryServiceStart xmlns:d2p1="http://schemas.datacontract.org/2004/07/eRecruiter.Api" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">
    <d2p1:Day>1</d2p1:Day>
    <d2p1:IsRelativeDate>true</d2p1:IsRelativeDate>
    <d2p1:Month>1</d2p1:Month>
    <d2p1:Year>1</d2p1:Year>
  </MilitaryServiceStart>
  <MobilePhone xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 26</MobilePhone>
  <OvertimeHours xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">1</OvertimeHours>
  <PartTimeHours xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">1</PartTimeHours>
  <Phone xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 25</Phone>
  <PhoneTime xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 38</PhoneTime>
  <PolicyAcceptedAt xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">2024-12-27T23:42:31.0597261+01:00</PolicyAcceptedAt>
  <Referrer xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 40</Referrer>
  <ReferrerAdditionalInfo xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 41</ReferrerAdditionalInfo>
  <Regions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Regions>
  <Salary xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">1</Salary>
  <SalaryCurrency xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 35</SalaryCurrency>
  <SalaryNotes xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 34</SalaryNotes>
  <SalaryPeriod xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">Monthly</SalaryPeriod>
  <SelfDescription xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 45</SelfDescription>
  <Street xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 20</Street>
  <Tags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Tags>
  <TitleAfterName xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 19</TitleAfterName>
  <TitleBeforeName xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 18</TitleBeforeName>
  <Url xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 27</Url>
  <ZipCode xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters">sample string 22</ZipCode>
  <ActivitiesCount>8</ActivitiesCount>
  <CertificatesCount>11</CertificatesCount>
  <DateOfUpdateByApplicant>2024-12-27T23:42:31.0597261+01:00</DateOfUpdateByApplicant>
  <DateOfUpdateByUser>2024-12-27T23:42:31.0597261+01:00</DateOfUpdateByUser>
  <DocumentsCount>7</DocumentsCount>
  <EducationsCount>10</EducationsCount>
  <ExperiencesCount>9</ExperiencesCount>
  <HasApplicationsVisibleToApplicant>true</HasApplicationsVisibleToApplicant>
  <HasCv>true</HasCv>
  <HasPhoto>true</HasPhoto>
  <Id>1</Id>
  <LanguagesCount>12</LanguagesCount>
  <PublicationsCount>13</PublicationsCount>
  <ThirdPartyProfiles>
    <ApplicantThirdPartyProfileResponse>
      <Identifier>sample string 2</Identifier>
      <ThirdParty>sample string 1</ThirdParty>
      <Url>sample string 3</Url>
    </ApplicantThirdPartyProfileResponse>
    <ApplicantThirdPartyProfileResponse>
      <Identifier>sample string 2</Identifier>
      <ThirdParty>sample string 1</ThirdParty>
      <Url>sample string 3</Url>
    </ApplicantThirdPartyProfileResponse>
  </ThirdPartyProfiles>
</ApplicantResponse>