GET api/webcategory/providerAppProducts?programId={programId}&accountId={accountId}&applicationId={applicationId}

Request Information

URI Parameters

Name	Type	Additional information
programId	globally unique identifier	Required
accountId	globally unique identifier	Required
applicationId	globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

WebCategory

Name	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.
PresetBundleDisplayOrder	integer	None.
RetailPrice	decimal number	None.
DiscountedPrice	decimal number	None.
WebProducts	Collection of WebProduct	None.

Response Formats

application/json, text/json

Sample:

{
  "Id": "a52f9bb1-a550-41f6-8e6b-f8a606fe6ea3",
  "Name": "sample string 2",
  "PriceLevelId": "5c39d1cc-799c-4aab-944b-1a0f3f225a4a",
  "ShortDescription": "sample string 4",
  "LongDescription": "sample string 5",
  "Program": {
    "Id": "3b977331-9fe5-4630-98e4-64529621b2dc",
    "Name": "sample string 2"
  },
  "PresetBundleWebProductId": "ac3c1fe0-1b81-48ba-bdd6-c6e9ddce6862",
  "IsPresetBundle": true,
  "PresetBundleDisplayOrder": 8,
  "RetailPrice": 9.0,
  "DiscountedPrice": 10.0,
  "WebProducts": [
    {
      "Id": "607c54f8-3a6a-4865-8daa-aa9f553d9bac",
      "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": "09c4b3b3-40a4-4e56-9393-e13dfac130b8",
          "StartDate": "2024-12-22T05:16:42.483584+00:00",
          "EndDate": "2024-12-22T05:16:42.483584+00:00",
          "CutOffDate": "2024-12-22T05:16:42.483584+00:00"
        },
        {
          "Schedule": "sample string 1",
          "Id": "09c4b3b3-40a4-4e56-9393-e13dfac130b8",
          "StartDate": "2024-12-22T05:16:42.483584+00:00",
          "EndDate": "2024-12-22T05:16:42.483584+00:00",
          "CutOffDate": "2024-12-22T05:16:42.483584+00:00"
        }
      ],
      "Savings": 29.0,
      "SavingsFormat": {
        "Label": "sample string 1",
        "Value": 2
      },
      "ProductTypeIcon": {
        "Label": "sample string 1",
        "Value": 2
      },
      "CreatedOn": "2024-12-22T05:16:42.483584+00:00",
      "IsSelected": true,
      "CountryRestriction": true,
      "EligibleCountries": [
        {
          "Id": "sample string 1"
        },
        {
          "Id": "sample string 1"
        }
      ]
    },
    {
      "Id": "607c54f8-3a6a-4865-8daa-aa9f553d9bac",
      "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": "09c4b3b3-40a4-4e56-9393-e13dfac130b8",
          "StartDate": "2024-12-22T05:16:42.483584+00:00",
          "EndDate": "2024-12-22T05:16:42.483584+00:00",
          "CutOffDate": "2024-12-22T05:16:42.483584+00:00"
        },
        {
          "Schedule": "sample string 1",
          "Id": "09c4b3b3-40a4-4e56-9393-e13dfac130b8",
          "StartDate": "2024-12-22T05:16:42.483584+00:00",
          "EndDate": "2024-12-22T05:16:42.483584+00:00",
          "CutOffDate": "2024-12-22T05:16:42.483584+00:00"
        }
      ],
      "Savings": 29.0,
      "SavingsFormat": {
        "Label": "sample string 1",
        "Value": 2
      },
      "ProductTypeIcon": {
        "Label": "sample string 1",
        "Value": 2
      },
      "CreatedOn": "2024-12-22T05:16:42.483584+00:00",
      "IsSelected": true,
      "CountryRestriction": true,
      "EligibleCountries": [
        {
          "Id": "sample string 1"
        },
        {
          "Id": "sample string 1"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<WebCategory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models">
  <DiscountedPrice>10</DiscountedPrice>
  <Id>a52f9bb1-a550-41f6-8e6b-f8a606fe6ea3</Id>
  <IsPresetBundle>true</IsPresetBundle>
  <LongDescription>sample string 5</LongDescription>
  <Name>sample string 2</Name>
  <PresetBundleDisplayOrder>8</PresetBundleDisplayOrder>
  <PresetBundleWebProductId>ac3c1fe0-1b81-48ba-bdd6-c6e9ddce6862</PresetBundleWebProductId>
  <PriceLevelId>5c39d1cc-799c-4aab-944b-1a0f3f225a4a</PriceLevelId>
  <Program xmlns:d2p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
    <d2p1:Id>3b977331-9fe5-4630-98e4-64529621b2dc</d2p1:Id>
    <d2p1:Name>sample string 2</d2p1:Name>
  </Program>
  <RetailPrice>9</RetailPrice>
  <ShortDescription>sample string 4</ShortDescription>
  <WebProducts>
    <WebProduct>
      <AbbreviatedDescription>sample string 25</AbbreviatedDescription>
      <CountryRestriction>true</CountryRestriction>
      <CreatedOn>2024-12-22T05:16:42.483584+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>607c54f8-3a6a-4865-8daa-aa9f553d9bac</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-12-22T05:16:42.483584+00:00</CutOffDate>
          <EndDate>2024-12-22T05:16:42.483584+00:00</EndDate>
          <Id>09c4b3b3-40a4-4e56-9393-e13dfac130b8</Id>
          <Schedule>sample string 1</Schedule>
          <StartDate>2024-12-22T05:16:42.483584+00:00</StartDate>
        </LiveCourseAvailability>
        <LiveCourseAvailability>
          <CutOffDate>2024-12-22T05:16:42.483584+00:00</CutOffDate>
          <EndDate>2024-12-22T05:16:42.483584+00:00</EndDate>
          <Id>09c4b3b3-40a4-4e56-9393-e13dfac130b8</Id>
          <Schedule>sample string 1</Schedule>
          <StartDate>2024-12-22T05:16:42.483584+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:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
        <d4p1:Label>sample string 1</d4p1:Label>
        <d4p1:Value>2</d4p1: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:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
        <d4p1:Label>sample string 1</d4p1:Label>
        <d4p1:Value>2</d4p1: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-12-22T05:16:42.483584+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>607c54f8-3a6a-4865-8daa-aa9f553d9bac</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-12-22T05:16:42.483584+00:00</CutOffDate>
          <EndDate>2024-12-22T05:16:42.483584+00:00</EndDate>
          <Id>09c4b3b3-40a4-4e56-9393-e13dfac130b8</Id>
          <Schedule>sample string 1</Schedule>
          <StartDate>2024-12-22T05:16:42.483584+00:00</StartDate>
        </LiveCourseAvailability>
        <LiveCourseAvailability>
          <CutOffDate>2024-12-22T05:16:42.483584+00:00</CutOffDate>
          <EndDate>2024-12-22T05:16:42.483584+00:00</EndDate>
          <Id>09c4b3b3-40a4-4e56-9393-e13dfac130b8</Id>
          <Schedule>sample string 1</Schedule>
          <StartDate>2024-12-22T05:16:42.483584+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:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
        <d4p1:Label>sample string 1</d4p1:Label>
        <d4p1:Value>2</d4p1: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:d4p1="http://schemas.datacontract.org/2004/07/HRCI.Services.BL.Models.Helpers">
        <d4p1:Label>sample string 1</d4p1:Label>
        <d4p1:Value>2</d4p1: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>