GET api/webcategory/program?programSearch={programSearch}&productSet={productSet}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
programSearch | string |
Required |
|
productSet | string |
Default value is public |
Body Parameters
None.
Response Information
Resource Description
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": "f3c4e1c9-5db7-4def-9479-535a341d4e86", "Name": "sample string 2", "PriceLevelId": "b25d5ff5-fa44-43a0-a26d-b4d181b433c5", "ShortDescription": "sample string 4", "LongDescription": "sample string 5", "Program": { "Id": "b3a82df6-3b83-4dfe-8195-c0a70f4da867", "Name": "sample string 2" }, "PresetBundleWebProductId": "0c6b1057-1924-4857-a910-18ea2f7407c7", "IsPresetBundle": true, "RetailPrice": 8.0, "DiscountedPrice": 9.0, "WebProducts": [ { "Id": "5a5ce34e-fc6a-41bd-b43e-4c2176fe7bb2", "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": "9c44c820-3665-456a-8513-82ebb629fdba", "StartDate": "2024-09-08T02:29:47.714245+00:00", "EndDate": "2024-09-08T02:29:47.714245+00:00", "CutOffDate": "2024-09-08T02:29:47.714245+00:00" }, { "Schedule": "sample string 1", "Id": "9c44c820-3665-456a-8513-82ebb629fdba", "StartDate": "2024-09-08T02:29:47.714245+00:00", "EndDate": "2024-09-08T02:29:47.714245+00:00", "CutOffDate": "2024-09-08T02:29:47.714245+00:00" } ], "Savings": 29.0, "SavingsFormat": { "Label": "sample string 1", "Value": 2 }, "ProductTypeIcon": { "Label": "sample string 1", "Value": 2 }, "CreatedOn": "2024-09-08T02:29:47.714245+00:00", "IsSelected": true, "CountryRestriction": true, "EligibleCountries": [ { "Id": "sample string 1" }, { "Id": "sample string 1" } ] }, { "Id": "5a5ce34e-fc6a-41bd-b43e-4c2176fe7bb2", "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": "9c44c820-3665-456a-8513-82ebb629fdba", "StartDate": "2024-09-08T02:29:47.714245+00:00", "EndDate": "2024-09-08T02:29:47.714245+00:00", "CutOffDate": "2024-09-08T02:29:47.714245+00:00" }, { "Schedule": "sample string 1", "Id": "9c44c820-3665-456a-8513-82ebb629fdba", "StartDate": "2024-09-08T02:29:47.714245+00:00", "EndDate": "2024-09-08T02:29:47.714245+00:00", "CutOffDate": "2024-09-08T02:29:47.714245+00:00" } ], "Savings": 29.0, "SavingsFormat": { "Label": "sample string 1", "Value": 2 }, "ProductTypeIcon": { "Label": "sample string 1", "Value": 2 }, "CreatedOn": "2024-09-08T02:29:47.714245+00:00", "IsSelected": true, "CountryRestriction": true, "EligibleCountries": [ { "Id": "sample string 1" }, { "Id": "sample string 1" } ] } ] }, { "Id": "f3c4e1c9-5db7-4def-9479-535a341d4e86", "Name": "sample string 2", "PriceLevelId": "b25d5ff5-fa44-43a0-a26d-b4d181b433c5", "ShortDescription": "sample string 4", "LongDescription": "sample string 5", "Program": { "Id": "b3a82df6-3b83-4dfe-8195-c0a70f4da867", "Name": "sample string 2" }, "PresetBundleWebProductId": "0c6b1057-1924-4857-a910-18ea2f7407c7", "IsPresetBundle": true, "RetailPrice": 8.0, "DiscountedPrice": 9.0, "WebProducts": [ { "Id": "5a5ce34e-fc6a-41bd-b43e-4c2176fe7bb2", "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": "9c44c820-3665-456a-8513-82ebb629fdba", "StartDate": "2024-09-08T02:29:47.714245+00:00", "EndDate": "2024-09-08T02:29:47.714245+00:00", "CutOffDate": "2024-09-08T02:29:47.714245+00:00" }, { "Schedule": "sample string 1", "Id": "9c44c820-3665-456a-8513-82ebb629fdba", "StartDate": "2024-09-08T02:29:47.714245+00:00", "EndDate": "2024-09-08T02:29:47.714245+00:00", "CutOffDate": "2024-09-08T02:29:47.714245+00:00" } ], "Savings": 29.0, "SavingsFormat": { "Label": "sample string 1", "Value": 2 }, "ProductTypeIcon": { "Label": "sample string 1", "Value": 2 }, "CreatedOn": "2024-09-08T02:29:47.714245+00:00", "IsSelected": true, "CountryRestriction": true, "EligibleCountries": [ { "Id": "sample string 1" }, { "Id": "sample string 1" } ] }, { "Id": "5a5ce34e-fc6a-41bd-b43e-4c2176fe7bb2", "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": "9c44c820-3665-456a-8513-82ebb629fdba", "StartDate": "2024-09-08T02:29:47.714245+00:00", "EndDate": "2024-09-08T02:29:47.714245+00:00", "CutOffDate": "2024-09-08T02:29:47.714245+00:00" }, { "Schedule": "sample string 1", "Id": "9c44c820-3665-456a-8513-82ebb629fdba", "StartDate": "2024-09-08T02:29:47.714245+00:00", "EndDate": "2024-09-08T02:29:47.714245+00:00", "CutOffDate": "2024-09-08T02:29:47.714245+00:00" } ], "Savings": 29.0, "SavingsFormat": { "Label": "sample string 1", "Value": 2 }, "ProductTypeIcon": { "Label": "sample string 1", "Value": 2 }, "CreatedOn": "2024-09-08T02:29:47.714245+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>f3c4e1c9-5db7-4def-9479-535a341d4e86</Id> <IsPresetBundle>true</IsPresetBundle> <LongDescription>sample string 5</LongDescription> <Name>sample string 2</Name> <PresetBundleWebProductId>0c6b1057-1924-4857-a910-18ea2f7407c7</PresetBundleWebProductId> <PriceLevelId>b25d5ff5-fa44-43a0-a26d-b4d181b433c5</PriceLevelId> <Program xmlns:d3p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d3p1:Id>b3a82df6-3b83-4dfe-8195-c0a70f4da867</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:29:47.714245+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>5a5ce34e-fc6a-41bd-b43e-4c2176fe7bb2</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:29:47.714245+00:00</CutOffDate> <EndDate>2024-09-08T02:29:47.714245+00:00</EndDate> <Id>9c44c820-3665-456a-8513-82ebb629fdba</Id> <Schedule>sample string 1</Schedule> <StartDate>2024-09-08T02:29:47.714245+00:00</StartDate> </LiveCourseAvailability> <LiveCourseAvailability> <CutOffDate>2024-09-08T02:29:47.714245+00:00</CutOffDate> <EndDate>2024-09-08T02:29:47.714245+00:00</EndDate> <Id>9c44c820-3665-456a-8513-82ebb629fdba</Id> <Schedule>sample string 1</Schedule> <StartDate>2024-09-08T02:29:47.714245+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:29:47.714245+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>5a5ce34e-fc6a-41bd-b43e-4c2176fe7bb2</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:29:47.714245+00:00</CutOffDate> <EndDate>2024-09-08T02:29:47.714245+00:00</EndDate> <Id>9c44c820-3665-456a-8513-82ebb629fdba</Id> <Schedule>sample string 1</Schedule> <StartDate>2024-09-08T02:29:47.714245+00:00</StartDate> </LiveCourseAvailability> <LiveCourseAvailability> <CutOffDate>2024-09-08T02:29:47.714245+00:00</CutOffDate> <EndDate>2024-09-08T02:29:47.714245+00:00</EndDate> <Id>9c44c820-3665-456a-8513-82ebb629fdba</Id> <Schedule>sample string 1</Schedule> <StartDate>2024-09-08T02:29:47.714245+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>f3c4e1c9-5db7-4def-9479-535a341d4e86</Id> <IsPresetBundle>true</IsPresetBundle> <LongDescription>sample string 5</LongDescription> <Name>sample string 2</Name> <PresetBundleWebProductId>0c6b1057-1924-4857-a910-18ea2f7407c7</PresetBundleWebProductId> <PriceLevelId>b25d5ff5-fa44-43a0-a26d-b4d181b433c5</PriceLevelId> <Program xmlns:d3p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers"> <d3p1:Id>b3a82df6-3b83-4dfe-8195-c0a70f4da867</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:29:47.714245+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>5a5ce34e-fc6a-41bd-b43e-4c2176fe7bb2</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:29:47.714245+00:00</CutOffDate> <EndDate>2024-09-08T02:29:47.714245+00:00</EndDate> <Id>9c44c820-3665-456a-8513-82ebb629fdba</Id> <Schedule>sample string 1</Schedule> <StartDate>2024-09-08T02:29:47.714245+00:00</StartDate> </LiveCourseAvailability> <LiveCourseAvailability> <CutOffDate>2024-09-08T02:29:47.714245+00:00</CutOffDate> <EndDate>2024-09-08T02:29:47.714245+00:00</EndDate> <Id>9c44c820-3665-456a-8513-82ebb629fdba</Id> <Schedule>sample string 1</Schedule> <StartDate>2024-09-08T02:29:47.714245+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:29:47.714245+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>5a5ce34e-fc6a-41bd-b43e-4c2176fe7bb2</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:29:47.714245+00:00</CutOffDate> <EndDate>2024-09-08T02:29:47.714245+00:00</EndDate> <Id>9c44c820-3665-456a-8513-82ebb629fdba</Id> <Schedule>sample string 1</Schedule> <StartDate>2024-09-08T02:29:47.714245+00:00</StartDate> </LiveCourseAvailability> <LiveCourseAvailability> <CutOffDate>2024-09-08T02:29:47.714245+00:00</CutOffDate> <EndDate>2024-09-08T02:29:47.714245+00:00</EndDate> <Id>9c44c820-3665-456a-8513-82ebb629fdba</Id> <Schedule>sample string 1</Schedule> <StartDate>2024-09-08T02:29:47.714245+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>