GET api/WebSuiteCategory?categoryId={categoryId}&priceLevelId={priceLevelId}&portalId={portalId}&programId={programId}&skipProgram={skipProgram}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
categoryId

System.String

Required
priceLevelId

System.String

Required
portalId

System.String

Required
programId

System.String

Required
skipProgram

System.Boolean

Required

Body Parameters

None.

Response Information

Resource Description

Altai.Core.Cache.Entities.WebSuiteCategory
NameDescriptionTypeAdditional information
Id

System.Guid

None.
Name

System.String

None.
DisplayOrder

System.Decimal

None.
PriceLevelId

System.Guid

None.
PageSize

System.Int32

None.
IsSelectionRequired

System.Boolean

None.
WebSuiteWebProducts

System.Collections.Generic.List`1[Altai.Core.Cache.Entities.WebSuiteWebProduct]

None.

Response Formats

application/json, text/json

Sample: 
{
  "Id": "c05defbc-917c-461e-b904-d700903ef8d5",
  "Name": "sample string 2",
  "DisplayOrder": 3.0,
  "PriceLevelId": "b9f4f4e9-245b-4a5e-a5a8-ecfe3d3761ed",
  "PageSize": 5,
  "IsSelectionRequired": true,
  "WebSuiteWebProducts": [
    {
      "Id": "65cf7634-ce8d-4e32-9473-2db8cfe837ef",
      "Price": 2.0,
      "Name": "sample string 3",
      "ShortDescription": "sample string 4",
      "ProgramId": "sample string 5",
      "EventId": "sample string 6",
      "SessionId": "sample string 7",
      "DonationFundId": "sample string 8",
      "ProductId": "sample string 9",
      "ImageUrl": "sample string 10",
      "ThumbnailImageUrl": "sample string 11",
      "Quantity": 12,
      "Program": {
        "Id": "f03ad2ea-dc2e-4638-8968-6e3d05bbb4d5",
        "Name": "sample string 2",
        "BillingTermLength": 3
      }
    },
    {
      "Id": "65cf7634-ce8d-4e32-9473-2db8cfe837ef",
      "Price": 2.0,
      "Name": "sample string 3",
      "ShortDescription": "sample string 4",
      "ProgramId": "sample string 5",
      "EventId": "sample string 6",
      "SessionId": "sample string 7",
      "DonationFundId": "sample string 8",
      "ProductId": "sample string 9",
      "ImageUrl": "sample string 10",
      "ThumbnailImageUrl": "sample string 11",
      "Quantity": 12,
      "Program": {
        "Id": "f03ad2ea-dc2e-4638-8968-6e3d05bbb4d5",
        "Name": "sample string 2",
        "BillingTermLength": 3
      }
    }
  ]
}

application/xml, text/xml

Sample: 
<WebSuiteCategory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Altai.Core.Cache.Entities">
  <DisplayOrder>3</DisplayOrder>
  <Id>c05defbc-917c-461e-b904-d700903ef8d5</Id>
  <IsSelectionRequired>true</IsSelectionRequired>
  <Name>sample string 2</Name>
  <PageSize>5</PageSize>
  <PriceLevelId>b9f4f4e9-245b-4a5e-a5a8-ecfe3d3761ed</PriceLevelId>
  <WebSuiteWebProducts>
    <WebSuiteWebProduct>
      <DonationFundId>sample string 8</DonationFundId>
      <EventId>sample string 6</EventId>
      <Id>65cf7634-ce8d-4e32-9473-2db8cfe837ef</Id>
      <ImageUrl>sample string 10</ImageUrl>
      <Name>sample string 3</Name>
      <Price>2</Price>
      <ProductId>sample string 9</ProductId>
      <Program>
        <BillingTermLength>3</BillingTermLength>
        <Id>f03ad2ea-dc2e-4638-8968-6e3d05bbb4d5</Id>
        <Name>sample string 2</Name>
      </Program>
      <ProgramId>sample string 5</ProgramId>
      <Quantity>12</Quantity>
      <SessionId>sample string 7</SessionId>
      <ShortDescription>sample string 4</ShortDescription>
      <ThumbnailImageUrl>sample string 11</ThumbnailImageUrl>
    </WebSuiteWebProduct>
    <WebSuiteWebProduct>
      <DonationFundId>sample string 8</DonationFundId>
      <EventId>sample string 6</EventId>
      <Id>65cf7634-ce8d-4e32-9473-2db8cfe837ef</Id>
      <ImageUrl>sample string 10</ImageUrl>
      <Name>sample string 3</Name>
      <Price>2</Price>
      <ProductId>sample string 9</ProductId>
      <Program>
        <BillingTermLength>3</BillingTermLength>
        <Id>f03ad2ea-dc2e-4638-8968-6e3d05bbb4d5</Id>
        <Name>sample string 2</Name>
      </Program>
      <ProgramId>sample string 5</ProgramId>
      <Quantity>12</Quantity>
      <SessionId>sample string 7</SessionId>
      <ShortDescription>sample string 4</ShortDescription>
      <ThumbnailImageUrl>sample string 11</ThumbnailImageUrl>
    </WebSuiteWebProduct>
  </WebSuiteWebProducts>
</WebSuiteCategory>