GET api/webcategory/program?programSearch={programSearch}&productSet={productSet}
Gets a collection of retail or public categories and products for a program.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
programSearch |
Program acronym to search for. Examples: sphr, gphr, aphr |
string |
Required |
productSet |
Product set to retrieve. Supported Values: retail, public. Defaults to public. |
string |
Default value is public |
Body Parameters
None.
Response Information
Resource Description
Collection of
Collection of WebCategoryName | Description | Type | Additional information |
---|---|---|---|
Id | globally unique identifier |
None. |
|
Name | string |
None. |
|
PriceLevelId | globally unique identifier |
None. |
|
ShortDescription | string |
None. |
|
LongDescription | string |
None. |
|
Program | IdNamePair |
None. |
|
PresetBundleWebProductId | globally unique identifier |
None. |
|
IsPresetBundle | boolean |
None. |
|
RetailPrice | decimal number |
None. |
|
DiscountedPrice | decimal number |
None. |
|
WebProducts | Collection of WebProduct |
None. |
Response Formats
application/json, text/json
Sample:
[ { "Id": "f0353683-e83f-404c-9946-540dd9e997be", "Name": "sample string 2", "PriceLevelId": "194c027d-3fba-49ba-a019-088856435dc3", "ShortDescription": "sample string 4", "LongDescription": "sample string 5", "Program": { "Id": "ca30b749-491e-48be-b224-3dd7ed9258e6", "Name": "sample string 2" }, "PresetBundleWebProductId": "11180260-8b68-426d-8ff8-686f375babf7", "IsPresetBundle": true, "RetailPrice": 8.0, "DiscountedPrice": 9.0, "WebProducts": [ { "Id": "fd028630-e297-4323-89b6-cfb8d1fe2269", "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": "30b07f39-b080-4de1-937d-9fc3ccb0d50a", "StartDate": "2024-09-08T02:42:12.7472943+00:00", "EndDate": "2024-09-08T02:42:12.7472943+00:00", "CutOffDate": "2024-09-08T02:42:12.7472943+00:00" }, { "Schedule": "sample string 1", "Id": "30b07f39-b080-4de1-937d-9fc3ccb0d50a", "StartDate": "2024-09-08T02:42:12.7472943+00:00", "EndDate": "2024-09-08T02:42:12.7472943+00:00", "CutOffDate": "2024-09-08T02:42:12.7472943+00:00" } ], "Savings": 29.0, "SavingsFormat": { "Label": "sample string 1", "Value": 2 }, "ProductTypeIcon": { "Label": "sample string 1", "Value": 2 }, "CreatedOn": "2024-09-08T02:42:12.7472943+00:00", "IsSelected": true, "CountryRestriction": true, "EligibleCountries": [ { "Id": "sample string 1" }, { "Id": "sample string 1" } ] }, { "Id": "fd028630-e297-4323-89b6-cfb8d1fe2269", "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": "30b07f39-b080-4de1-937d-9fc3ccb0d50a", "StartDate": "2024-09-08T02:42:12.7472943+00:00", "EndDate": "2024-09-08T02:42:12.7472943+00:00", "CutOffDate": "2024-09-08T02:42:12.7472943+00:00" }, { "Schedule": "sample string 1", "Id": "30b07f39-b080-4de1-937d-9fc3ccb0d50a", "StartDate": "2024-09-08T02:42:12.7472943+00:00", "EndDate": "2024-09-08T02:42:12.7472943+00:00", "CutOffDate": "2024-09-08T02:42:12.7472943+00:00" } ], "Savings": 29.0, "SavingsFormat": { "Label": "sample string 1", "Value": 2 }, "ProductTypeIcon": { "Label": "sample string 1", "Value": 2 }, "CreatedOn": "2024-09-08T02:42:12.7472943+00:00", "IsSelected": true, "CountryRestriction": true, "EligibleCountries": [ { "Id": "sample string 1" }, { "Id": "sample string 1" } ] } ] }, { "Id": "f0353683-e83f-404c-9946-540dd9e997be", "Name": "sample string 2", "PriceLevelId": "194c027d-3fba-49ba-a019-088856435dc3", "ShortDescription": "sample string 4", "LongDescription": "sample string 5", "Program": { "Id": "ca30b749-491e-48be-b224-3dd7ed9258e6", "Name": "sample string 2" }, "PresetBundleWebProductId": "11180260-8b68-426d-8ff8-686f375babf7", "IsPresetBundle": true, "RetailPrice": 8.0, "DiscountedPrice": 9.0, "WebProducts": [ { "Id": "fd028630-e297-4323-89b6-cfb8d1fe2269", "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": "30b07f39-b080-4de1-937d-9fc3ccb0d50a", "StartDate": "2024-09-08T02:42:12.7472943+00:00", "EndDate": "2024-09-08T02:42:12.7472943+00:00", "CutOffDate": "2024-09-08T02:42:12.7472943+00:00" }, { "Schedule": "sample string 1", "Id": "30b07f39-b080-4de1-937d-9fc3ccb0d50a", "StartDate": "2024-09-08T02:42:12.7472943+00:00", "EndDate": "2024-09-08T02:42:12.7472943+00:00", "CutOffDate": "2024-09-08T02:42:12.7472943+00:00" } ], "Savings": 29.0, "SavingsFormat": { "Label": "sample string 1", "Value": 2 }, "ProductTypeIcon": { "Label": "sample string 1", "Value": 2 }, "CreatedOn": "2024-09-08T02:42:12.7472943+00:00", "IsSelected": true, "CountryRestriction": true, "EligibleCountries": [ { "Id": "sample string 1" }, { "Id": "sample string 1" } ] }, { "Id": "fd028630-e297-4323-89b6-cfb8d1fe2269", "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": "30b07f39-b080-4de1-937d-9fc3ccb0d50a", "StartDate": "2024-09-08T02:42:12.7472943+00:00", "EndDate": "2024-09-08T02:42:12.7472943+00:00", "CutOffDate": "2024-09-08T02:42:12.7472943+00:00" }, { "Schedule": "sample string 1", "Id": "30b07f39-b080-4de1-937d-9fc3ccb0d50a", "StartDate": "2024-09-08T02:42:12.7472943+00:00", "EndDate": "2024-09-08T02:42:12.7472943+00:00", "CutOffDate": "2024-09-08T02:42:12.7472943+00:00" } ], "Savings": 29.0, "SavingsFormat": { "Label": "sample string 1", "Value": 2 }, "ProductTypeIcon": { "Label": "sample string 1", "Value": 2 }, "CreatedOn": "2024-09-08T02:42:12.7472943+00:00", "IsSelected": true, "CountryRestriction": true, "EligibleCountries": [ { "Id": "sample string 1" }, { "Id": "sample string 1" } ] } ] } ]
application/xml, text/xml
Sample:
<ArrayOfWebCategory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models"> <WebCategory> <DiscountedPrice>9</DiscountedPrice> <Id>f0353683-e83f-404c-9946-540dd9e997be</Id> <IsPresetBundle>true</IsPresetBundle> <LongDescription>sample string 5</LongDescription> <Name>sample string 2</Name> <PresetBundleWebProductId>11180260-8b68-426d-8ff8-686f375babf7</PresetBundleWebProductId> <PriceLevelId>194c027d-3fba-49ba-a019-088856435dc3</PriceLevelId> <Program xmlns:d3p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d3p1:Id>ca30b749-491e-48be-b224-3dd7ed9258e6</d3p1:Id> <d3p1:Name>sample string 2</d3p1:Name> </Program> <RetailPrice>8</RetailPrice> <ShortDescription>sample string 4</ShortDescription> <WebProducts> <WebProduct> <AbbreviatedDescription>sample string 25</AbbreviatedDescription> <CountryRestriction>true</CountryRestriction> <CreatedOn>2024-09-08T02:42:12.7472943+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>fd028630-e297-4323-89b6-cfb8d1fe2269</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> <IsSelected>true</IsSelected> <LiveCourseAvailability> <LiveCourseAvailability> <CutOffDate>2024-09-08T02:42:12.7472943+00:00</CutOffDate> <EndDate>2024-09-08T02:42:12.7472943+00:00</EndDate> <Id>30b07f39-b080-4de1-937d-9fc3ccb0d50a</Id> <Schedule>sample string 1</Schedule> <StartDate>2024-09-08T02:42:12.7472943+00:00</StartDate> </LiveCourseAvailability> <LiveCourseAvailability> <CutOffDate>2024-09-08T02:42:12.7472943+00:00</CutOffDate> <EndDate>2024-09-08T02:42:12.7472943+00:00</EndDate> <Id>30b07f39-b080-4de1-937d-9fc3ccb0d50a</Id> <Schedule>sample string 1</Schedule> <StartDate>2024-09-08T02:42:12.7472943+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:d5p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d5p1:Label>sample string 1</d5p1:Label> <d5p1:Value>2</d5p1: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:d5p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d5p1:Label>sample string 1</d5p1:Label> <d5p1:Value>2</d5p1:Value> </SavingsFormat> <SessionId>sample string 15</SessionId> <ThumbnailImageUrl>sample string 19</ThumbnailImageUrl> <VendorImageURL>sample string 5</VendorImageURL> <VendorName>sample string 4</VendorName> </WebProduct> <WebProduct> <AbbreviatedDescription>sample string 25</AbbreviatedDescription> <CountryRestriction>true</CountryRestriction> <CreatedOn>2024-09-08T02:42:12.7472943+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>fd028630-e297-4323-89b6-cfb8d1fe2269</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> <IsSelected>true</IsSelected> <LiveCourseAvailability> <LiveCourseAvailability> <CutOffDate>2024-09-08T02:42:12.7472943+00:00</CutOffDate> <EndDate>2024-09-08T02:42:12.7472943+00:00</EndDate> <Id>30b07f39-b080-4de1-937d-9fc3ccb0d50a</Id> <Schedule>sample string 1</Schedule> <StartDate>2024-09-08T02:42:12.7472943+00:00</StartDate> </LiveCourseAvailability> <LiveCourseAvailability> <CutOffDate>2024-09-08T02:42:12.7472943+00:00</CutOffDate> <EndDate>2024-09-08T02:42:12.7472943+00:00</EndDate> <Id>30b07f39-b080-4de1-937d-9fc3ccb0d50a</Id> <Schedule>sample string 1</Schedule> <StartDate>2024-09-08T02:42:12.7472943+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:d5p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d5p1:Label>sample string 1</d5p1:Label> <d5p1:Value>2</d5p1: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:d5p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d5p1:Label>sample string 1</d5p1:Label> <d5p1:Value>2</d5p1:Value> </SavingsFormat> <SessionId>sample string 15</SessionId> <ThumbnailImageUrl>sample string 19</ThumbnailImageUrl> <VendorImageURL>sample string 5</VendorImageURL> <VendorName>sample string 4</VendorName> </WebProduct> </WebProducts> </WebCategory> <WebCategory> <DiscountedPrice>9</DiscountedPrice> <Id>f0353683-e83f-404c-9946-540dd9e997be</Id> <IsPresetBundle>true</IsPresetBundle> <LongDescription>sample string 5</LongDescription> <Name>sample string 2</Name> <PresetBundleWebProductId>11180260-8b68-426d-8ff8-686f375babf7</PresetBundleWebProductId> <PriceLevelId>194c027d-3fba-49ba-a019-088856435dc3</PriceLevelId> <Program xmlns:d3p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d3p1:Id>ca30b749-491e-48be-b224-3dd7ed9258e6</d3p1:Id> <d3p1:Name>sample string 2</d3p1:Name> </Program> <RetailPrice>8</RetailPrice> <ShortDescription>sample string 4</ShortDescription> <WebProducts> <WebProduct> <AbbreviatedDescription>sample string 25</AbbreviatedDescription> <CountryRestriction>true</CountryRestriction> <CreatedOn>2024-09-08T02:42:12.7472943+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>fd028630-e297-4323-89b6-cfb8d1fe2269</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> <IsSelected>true</IsSelected> <LiveCourseAvailability> <LiveCourseAvailability> <CutOffDate>2024-09-08T02:42:12.7472943+00:00</CutOffDate> <EndDate>2024-09-08T02:42:12.7472943+00:00</EndDate> <Id>30b07f39-b080-4de1-937d-9fc3ccb0d50a</Id> <Schedule>sample string 1</Schedule> <StartDate>2024-09-08T02:42:12.7472943+00:00</StartDate> </LiveCourseAvailability> <LiveCourseAvailability> <CutOffDate>2024-09-08T02:42:12.7472943+00:00</CutOffDate> <EndDate>2024-09-08T02:42:12.7472943+00:00</EndDate> <Id>30b07f39-b080-4de1-937d-9fc3ccb0d50a</Id> <Schedule>sample string 1</Schedule> <StartDate>2024-09-08T02:42:12.7472943+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:d5p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d5p1:Label>sample string 1</d5p1:Label> <d5p1:Value>2</d5p1: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:d5p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d5p1:Label>sample string 1</d5p1:Label> <d5p1:Value>2</d5p1:Value> </SavingsFormat> <SessionId>sample string 15</SessionId> <ThumbnailImageUrl>sample string 19</ThumbnailImageUrl> <VendorImageURL>sample string 5</VendorImageURL> <VendorName>sample string 4</VendorName> </WebProduct> <WebProduct> <AbbreviatedDescription>sample string 25</AbbreviatedDescription> <CountryRestriction>true</CountryRestriction> <CreatedOn>2024-09-08T02:42:12.7472943+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>fd028630-e297-4323-89b6-cfb8d1fe2269</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> <IsSelected>true</IsSelected> <LiveCourseAvailability> <LiveCourseAvailability> <CutOffDate>2024-09-08T02:42:12.7472943+00:00</CutOffDate> <EndDate>2024-09-08T02:42:12.7472943+00:00</EndDate> <Id>30b07f39-b080-4de1-937d-9fc3ccb0d50a</Id> <Schedule>sample string 1</Schedule> <StartDate>2024-09-08T02:42:12.7472943+00:00</StartDate> </LiveCourseAvailability> <LiveCourseAvailability> <CutOffDate>2024-09-08T02:42:12.7472943+00:00</CutOffDate> <EndDate>2024-09-08T02:42:12.7472943+00:00</EndDate> <Id>30b07f39-b080-4de1-937d-9fc3ccb0d50a</Id> <Schedule>sample string 1</Schedule> <StartDate>2024-09-08T02:42:12.7472943+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:d5p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d5p1:Label>sample string 1</d5p1:Label> <d5p1:Value>2</d5p1: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:d5p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d5p1:Label>sample string 1</d5p1:Label> <d5p1:Value>2</d5p1:Value> </SavingsFormat> <SessionId>sample string 15</SessionId> <ThumbnailImageUrl>sample string 19</ThumbnailImageUrl> <VendorImageURL>sample string 5</VendorImageURL> <VendorName>sample string 4</VendorName> </WebProduct> </WebProducts> </WebCategory> </ArrayOfWebCategory>