POST Api/Applicant/{applicantId}/ResetPassword
Sets an applicants password to a new value.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| applicantId |
The ID of the applicant. |
integer |
Required |
Body Parameters
Contains the new password and the URL of the portal (required for selection of correct password policies).
ApplicantResetPasswordParameter| Name | Description | Type | Additional information |
|---|---|---|---|
| NewPassword | string |
None. |
|
| Url | URI |
None. |
Request Formats
application/json, text/json, application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
A list of password policy errors (if any).
ApplicantSetPasswordResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Errors | Collection of Error |
None. |
Response Formats
application/json, text/json
Sample:
{
"Errors": [
0,
0
]
}
application/xml, text/xml
Sample:
<ApplicantSetPasswordResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Responses">
<Errors>
<ApplicantSetPasswordResponse.Error>PasswordPolicySymbols</ApplicantSetPasswordResponse.Error>
<ApplicantSetPasswordResponse.Error>PasswordPolicySymbols</ApplicantSetPasswordResponse.Error>
</Errors>
</ApplicantSetPasswordResponse>