GET api/WebSuiteCategory?categoryId={categoryId}&priceLevelId={priceLevelId}&portalId={portalId}&useCustomPricing={useCustomPricing}&filterBySubscription={filterBySubscription}
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
categoryId | System.String |
Required |
|
priceLevelId | System.String |
Required |
|
portalId | System.String |
Required |
|
useCustomPricing | System.Boolean |
Required |
|
filterBySubscription | System.Boolean |
Required |
Body Parameters
None.
Response Information
Resource Description
Altai.Core.Cache.Entities.WebSuiteCategoryName | Description | Type | Additional 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": "0d5a342f-aa98-438f-94c6-2323f7a8c587", "Name": "sample string 2", "DisplayOrder": 3.0, "PriceLevelId": "a2100845-6230-4382-afc4-d3d56dae87c9", "PageSize": 5, "IsSelectionRequired": true, "WebSuiteWebProducts": [ { "Id": "e08c93d6-039d-4303-984f-b69d080a1ad4", "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": "a3bd4894-b0de-4cd0-aef6-bf2c5ca4b1f4", "Name": "sample string 2", "BillingTermLength": 3 } }, { "Id": "e08c93d6-039d-4303-984f-b69d080a1ad4", "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": "a3bd4894-b0de-4cd0-aef6-bf2c5ca4b1f4", "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>0d5a342f-aa98-438f-94c6-2323f7a8c587</Id> <IsSelectionRequired>true</IsSelectionRequired> <Name>sample string 2</Name> <PageSize>5</PageSize> <PriceLevelId>a2100845-6230-4382-afc4-d3d56dae87c9</PriceLevelId> <WebSuiteWebProducts> <WebSuiteWebProduct> <DonationFundId>sample string 8</DonationFundId> <EventId>sample string 6</EventId> <Id>e08c93d6-039d-4303-984f-b69d080a1ad4</Id> <ImageUrl>sample string 10</ImageUrl> <Name>sample string 3</Name> <Price>2</Price> <ProductId>sample string 9</ProductId> <Program> <BillingTermLength>3</BillingTermLength> <Id>a3bd4894-b0de-4cd0-aef6-bf2c5ca4b1f4</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>e08c93d6-039d-4303-984f-b69d080a1ad4</Id> <ImageUrl>sample string 10</ImageUrl> <Name>sample string 3</Name> <Price>2</Price> <ProductId>sample string 9</ProductId> <Program> <BillingTermLength>3</BillingTermLength> <Id>a3bd4894-b0de-4cd0-aef6-bf2c5ca4b1f4</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>