GET Api/Applicant/{applicantId}/Policies
Returns all current policies for an applicant.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| applicantId |
The ID of the applicant. |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
A list of policies.
Collection of 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:18:46.3126395+01:00",
"RevokedOn": "2025-11-08T08:18:46.3126395+01:00",
"IsOutdated": true
},
{
"ApplicantId": 1,
"PolicyId": 2,
"Type": 0,
"Language": "sample string 3",
"Url": "sample string 4",
"Text": "sample string 5",
"AcceptedOn": "2025-11-08T08:18:46.3126395+01:00",
"RevokedOn": "2025-11-08T08:18:46.3126395+01:00",
"IsOutdated": true
}
]
application/xml, text/xml
Sample:
<ArrayOfApplicantPolicyResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/eRecruiter.Api.Responses">
<ApplicantPolicyResponse>
<AcceptedOn>2025-11-08T08:18:46.3126395+01:00</AcceptedOn>
<ApplicantId>1</ApplicantId>
<IsOutdated>true</IsOutdated>
<Language>sample string 3</Language>
<PolicyId>2</PolicyId>
<RevokedOn>2025-11-08T08:18:46.3126395+01:00</RevokedOn>
<Text>sample string 5</Text>
<Type>Consent</Type>
<Url>sample string 4</Url>
</ApplicantPolicyResponse>
<ApplicantPolicyResponse>
<AcceptedOn>2025-11-08T08:18:46.3126395+01:00</AcceptedOn>
<ApplicantId>1</ApplicantId>
<IsOutdated>true</IsOutdated>
<Language>sample string 3</Language>
<PolicyId>2</PolicyId>
<RevokedOn>2025-11-08T08:18:46.3126395+01:00</RevokedOn>
<Text>sample string 5</Text>
<Type>Consent</Type>
<Url>sample string 4</Url>
</ApplicantPolicyResponse>
</ArrayOfApplicantPolicyResponse>