PUT Api/Applicant/{applicantId}/Policies/{policyId}
Updates a policy for an applicant.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| applicantId |
The ID of the applicant. |
integer |
Required |
| policyId |
The ID of the policy. |
integer |
Required |
Body Parameters
The data which will be updated.
ApplicantPolicyParameter| Name | Description | Type | Additional information |
|---|---|---|---|
| AcceptedOn |
Date of acceptance |
date |
None. |
| RevokedOn |
Date of revocation |
date |
None. |
Request Formats
application/json, text/json
Sample:
{
"AcceptedOn": "2025-11-08T08:23:55.3548598+01:00",
"RevokedOn": "2025-11-08T08:23:55.3548598+01:00"
}
application/xml, text/xml
Sample:
<ApplicantPolicyParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Parameters"> <AcceptedOn>2025-11-08T08:23:55.3548598+01:00</AcceptedOn> <RevokedOn>2025-11-08T08:23:55.3548598+01:00</RevokedOn> </ApplicantPolicyParameter>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
The updated policy related to the applicant.
ApplicantPolicyResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| ApplicantId |
Applicant ID |
integer |
None. |
| PolicyId |
Policy ID |
integer |
None. |
| Type |
Policy Type |
PolicyType |
None. |
| Language |
Language of the policy. |
string |
None. |
| Url |
URL of the portal of the policy. |
string |
None. |
| Text |
Policy text |
string |
None. |
| AcceptedOn |
Date of acceptance if it is accepted |
date |
None. |
| RevokedOn |
Date of revocation if it is revoked |
date |
None. |
| IsOutdated |
Flag indicating that the policy has a new version. |
boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"ApplicantId": 1,
"PolicyId": 2,
"Type": 0,
"Language": "sample string 3",
"Url": "sample string 4",
"Text": "sample string 5",
"AcceptedOn": "2025-11-08T08:23:55.3704845+01:00",
"RevokedOn": "2025-11-08T08:23:55.3704845+01:00",
"IsOutdated": true
}
application/xml, text/xml
Sample:
<ApplicantPolicyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Responses"> <AcceptedOn>2025-11-08T08:23:55.3704845+01:00</AcceptedOn> <ApplicantId>1</ApplicantId> <IsOutdated>true</IsOutdated> <Language>sample string 3</Language> <PolicyId>2</PolicyId> <RevokedOn>2025-11-08T08:23:55.3704845+01:00</RevokedOn> <Text>sample string 5</Text> <Type>Consent</Type> <Url>sample string 4</Url> </ApplicantPolicyResponse>