GET api/webcategory/webProduct?webProductId={webProductId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| webProductId | globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
WebProduct| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| Price | decimal number |
None. |
|
| RetailPrice | decimal number |
None. |
|
| VendorName | string |
None. |
|
| VendorImageURL | string |
None. |
|
| IsBook | boolean |
None. |
|
| IsCD | boolean |
None. |
|
| IsOnline | boolean |
None. |
|
| IsLive | boolean |
None. |
|
| IsLiveCourse | boolean |
None. |
|
| Name | string |
None. |
|
| Description | string |
None. |
|
| ProgramId | string |
None. |
|
| EventId | string |
None. |
|
| SessionId | string |
None. |
|
| DonationFundId | string |
None. |
|
| ProductId | string |
None. |
|
| ImageUrl | string |
None. |
|
| ThumbnailImageUrl | string |
None. |
|
| Quantity | integer |
None. |
|
| ProgramName | string |
None. |
|
| NotSoldSeparately | boolean |
None. |
|
| ParentWebProductId | string |
None. |
|
| RefundPolicy | string |
None. |
|
| AbbreviatedDescription | string |
None. |
|
| IsNew | boolean |
None. |
|
| IsPromoted | boolean |
None. |
|
| IsPublic | boolean |
None. |
|
| LiveCourseAvailability | Collection of LiveCourseAvailability |
None. |
|
| Savings | decimal number |
None. |
|
| SavingsFormat | OptionSetValueModel |
None. |
|
| ProductTypeIcon | OptionSetValueModel |
None. |
|
| CreatedOn | date |
None. |
|
| IsSelected | boolean |
None. |
|
| CountryRestriction | boolean |
None. |
|
| EligibleCountries | Collection of EligibleCountry |
None. |
|
| IsRecertLateFee | boolean |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": "16da755f-f931-4734-8547-86b06e758fcf",
"Price": 2.0,
"RetailPrice": 3.0,
"VendorName": "sample string 4",
"VendorImageURL": "sample string 5",
"IsBook": true,
"IsCD": true,
"IsOnline": true,
"IsLive": true,
"IsLiveCourse": true,
"Name": "sample string 11",
"Description": "sample string 12",
"ProgramId": "sample string 13",
"EventId": "sample string 14",
"SessionId": "sample string 15",
"DonationFundId": "sample string 16",
"ProductId": "sample string 17",
"ImageUrl": "sample string 18",
"ThumbnailImageUrl": "sample string 19",
"Quantity": 20,
"ProgramName": "sample string 21",
"NotSoldSeparately": true,
"ParentWebProductId": "sample string 23",
"RefundPolicy": "sample string 24",
"AbbreviatedDescription": "sample string 25",
"IsNew": true,
"IsPromoted": true,
"IsPublic": true,
"LiveCourseAvailability": [
{
"Schedule": "sample string 1",
"Id": "ca0cff15-9fd7-4666-912e-2511f06e539f",
"StartDate": "2025-10-26T18:47:37.3500322+00:00",
"EndDate": "2025-10-26T18:47:37.3500322+00:00",
"CutOffDate": "2025-10-26T18:47:37.3500322+00:00"
},
{
"Schedule": "sample string 1",
"Id": "ca0cff15-9fd7-4666-912e-2511f06e539f",
"StartDate": "2025-10-26T18:47:37.3500322+00:00",
"EndDate": "2025-10-26T18:47:37.3500322+00:00",
"CutOffDate": "2025-10-26T18:47:37.3500322+00:00"
}
],
"Savings": 29.0,
"SavingsFormat": {
"Label": "sample string 1",
"Value": 2
},
"ProductTypeIcon": {
"Label": "sample string 1",
"Value": 2
},
"CreatedOn": "2025-10-26T18:47:37.3500322+00:00",
"IsSelected": true,
"CountryRestriction": true,
"EligibleCountries": [
{
"Id": "sample string 1"
},
{
"Id": "sample string 1"
}
],
"IsRecertLateFee": true
}
application/xml, text/xml
Sample:
<WebProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models">
<AbbreviatedDescription>sample string 25</AbbreviatedDescription>
<CountryRestriction>true</CountryRestriction>
<CreatedOn>2025-10-26T18:47:37.3500322+00:00</CreatedOn>
<Description>sample string 12</Description>
<DonationFundId>sample string 16</DonationFundId>
<EligibleCountries>
<EligibleCountry>
<Id>sample string 1</Id>
</EligibleCountry>
<EligibleCountry>
<Id>sample string 1</Id>
</EligibleCountry>
</EligibleCountries>
<EventId>sample string 14</EventId>
<Id>16da755f-f931-4734-8547-86b06e758fcf</Id>
<ImageUrl>sample string 18</ImageUrl>
<IsBook>true</IsBook>
<IsCD>true</IsCD>
<IsLive>true</IsLive>
<IsLiveCourse>true</IsLiveCourse>
<IsNew>true</IsNew>
<IsOnline>true</IsOnline>
<IsPromoted>true</IsPromoted>
<IsPublic>true</IsPublic>
<IsRecertLateFee>true</IsRecertLateFee>
<IsSelected>true</IsSelected>
<LiveCourseAvailability>
<LiveCourseAvailability>
<CutOffDate>2025-10-26T18:47:37.3500322+00:00</CutOffDate>
<EndDate>2025-10-26T18:47:37.3500322+00:00</EndDate>
<Id>ca0cff15-9fd7-4666-912e-2511f06e539f</Id>
<Schedule>sample string 1</Schedule>
<StartDate>2025-10-26T18:47:37.3500322+00:00</StartDate>
</LiveCourseAvailability>
<LiveCourseAvailability>
<CutOffDate>2025-10-26T18:47:37.3500322+00:00</CutOffDate>
<EndDate>2025-10-26T18:47:37.3500322+00:00</EndDate>
<Id>ca0cff15-9fd7-4666-912e-2511f06e539f</Id>
<Schedule>sample string 1</Schedule>
<StartDate>2025-10-26T18:47:37.3500322+00:00</StartDate>
</LiveCourseAvailability>
</LiveCourseAvailability>
<Name>sample string 11</Name>
<NotSoldSeparately>true</NotSoldSeparately>
<ParentWebProductId>sample string 23</ParentWebProductId>
<Price>2</Price>
<ProductId>sample string 17</ProductId>
<ProductTypeIcon xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d2p1:Label>sample string 1</d2p1:Label>
<d2p1:Value>2</d2p1:Value>
</ProductTypeIcon>
<ProgramId>sample string 13</ProgramId>
<ProgramName>sample string 21</ProgramName>
<Quantity>20</Quantity>
<RefundPolicy>sample string 24</RefundPolicy>
<RetailPrice>3</RetailPrice>
<Savings>29</Savings>
<SavingsFormat xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
<d2p1:Label>sample string 1</d2p1:Label>
<d2p1:Value>2</d2p1:Value>
</SavingsFormat>
<SessionId>sample string 15</SessionId>
<ThumbnailImageUrl>sample string 19</ThumbnailImageUrl>
<VendorImageURL>sample string 5</VendorImageURL>
<VendorName>sample string 4</VendorName>
</WebProduct>