POST api/Voucher/Eligibility?contactId={contactId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| contactId | string |
Required |
Body Parameters
Collection of BCVoucherProduct| Name | Description | Type | Additional information |
|---|---|---|---|
| BCProductId | string |
None. |
|
| ProductType | string |
None. |
|
| BCProductSKU | string |
None. |
|
| ExamContainerId | string |
None. |
Request Formats
application/json, text/json
Sample:
[
{
"BCProductId": "sample string 1",
"ProductType": "sample string 2",
"BCProductSKU": "sample string 3",
"ExamContainerId": "sample string 4"
},
{
"BCProductId": "sample string 1",
"ProductType": "sample string 2",
"BCProductSKU": "sample string 3",
"ExamContainerId": "sample string 4"
}
]
application/xml, text/xml
Sample:
<ArrayOfBCVoucherProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models">
<BCVoucherProduct>
<BCProductId>sample string 1</BCProductId>
<BCProductSKU>sample string 3</BCProductSKU>
<ExamContainerId>sample string 4</ExamContainerId>
<ProductType>sample string 2</ProductType>
</BCVoucherProduct>
<BCVoucherProduct>
<BCProductId>sample string 1</BCProductId>
<BCProductSKU>sample string 3</BCProductSKU>
<ExamContainerId>sample string 4</ExamContainerId>
<ProductType>sample string 2</ProductType>
</BCVoucherProduct>
</ArrayOfBCVoucherProduct>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of BCVoucherEligibility| Name | Description | Type | Additional information |
|---|---|---|---|
| BCProductId | string |
None. |
|
| ProductType | string |
None. |
|
| BCProductSKU | string |
None. |
|
| ExamContainerId | string |
None. |
|
| ApplicationId | string |
None. |
|
| IsEligible | boolean |
None. |
|
| IsCertified | boolean |
None. |
|
| ExamEligibilityDate | date |
None. |
|
| IsCourseEligibleForRecertCredits | boolean |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"BCProductId": "sample string 1",
"ProductType": "sample string 2",
"BCProductSKU": "sample string 3",
"ExamContainerId": "sample string 4",
"ApplicationId": "sample string 5",
"IsEligible": true,
"IsCertified": true,
"ExamEligibilityDate": "2026-02-12T19:19:48.5135685+00:00",
"IsCourseEligibleForRecertCredits": true
},
{
"BCProductId": "sample string 1",
"ProductType": "sample string 2",
"BCProductSKU": "sample string 3",
"ExamContainerId": "sample string 4",
"ApplicationId": "sample string 5",
"IsEligible": true,
"IsCertified": true,
"ExamEligibilityDate": "2026-02-12T19:19:48.5135685+00:00",
"IsCourseEligibleForRecertCredits": true
}
]
application/xml, text/xml
Sample:
<ArrayOfBCVoucherEligibility xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models">
<BCVoucherEligibility>
<ApplicationId>sample string 5</ApplicationId>
<BCProductId>sample string 1</BCProductId>
<BCProductSKU>sample string 3</BCProductSKU>
<ExamContainerId>sample string 4</ExamContainerId>
<ExamEligibilityDate>2026-02-12T19:19:48.5135685+00:00</ExamEligibilityDate>
<IsCertified>true</IsCertified>
<IsCourseEligibleForRecertCredits>true</IsCourseEligibleForRecertCredits>
<IsEligible>true</IsEligible>
<ProductType>sample string 2</ProductType>
</BCVoucherEligibility>
<BCVoucherEligibility>
<ApplicationId>sample string 5</ApplicationId>
<BCProductId>sample string 1</BCProductId>
<BCProductSKU>sample string 3</BCProductSKU>
<ExamContainerId>sample string 4</ExamContainerId>
<ExamEligibilityDate>2026-02-12T19:19:48.5135685+00:00</ExamEligibilityDate>
<IsCertified>true</IsCertified>
<IsCourseEligibleForRecertCredits>true</IsCourseEligibleForRecertCredits>
<IsEligible>true</IsEligible>
<ProductType>sample string 2</ProductType>
</BCVoucherEligibility>
</ArrayOfBCVoucherEligibility>