GET api/WebSuiteCategory?contactId={contactId}&programId={programId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
contactId

System.Guid

Required
programId

System.Guid

Required

Body Parameters

None.

Response Information

Resource Description

System.Collections.Generic.IEnumerable`1[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": "5678c49e-2d94-413c-a4a9-4d234826d958",
    "Name": "sample string 2",
    "DisplayOrder": 3.0,
    "PriceLevelId": "37363834-5375-496a-a8ce-4107365f9b65",
    "PageSize": 5,
    "IsSelectionRequired": true,
    "WebSuiteWebProducts": [
      {
        "Id": "a291de4b-8c39-4435-8580-0b968f9f2b27",
        "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": "065f02a8-572a-4813-876f-013f8f0f62cd",
          "Name": "sample string 2",
          "BillingTermLength": 3
        }
      },
      {
        "Id": "a291de4b-8c39-4435-8580-0b968f9f2b27",
        "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": "065f02a8-572a-4813-876f-013f8f0f62cd",
          "Name": "sample string 2",
          "BillingTermLength": 3
        }
      }
    ]
  },
  {
    "Id": "5678c49e-2d94-413c-a4a9-4d234826d958",
    "Name": "sample string 2",
    "DisplayOrder": 3.0,
    "PriceLevelId": "37363834-5375-496a-a8ce-4107365f9b65",
    "PageSize": 5,
    "IsSelectionRequired": true,
    "WebSuiteWebProducts": [
      {
        "Id": "a291de4b-8c39-4435-8580-0b968f9f2b27",
        "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": "065f02a8-572a-4813-876f-013f8f0f62cd",
          "Name": "sample string 2",
          "BillingTermLength": 3
        }
      },
      {
        "Id": "a291de4b-8c39-4435-8580-0b968f9f2b27",
        "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": "065f02a8-572a-4813-876f-013f8f0f62cd",
          "Name": "sample string 2",
          "BillingTermLength": 3
        }
      }
    ]
  }
]

application/xml, text/xml

Sample: 
<ArrayOfWebSuiteCategory xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Altai.Core.Cache.Entities">
  <WebSuiteCategory>
    <DisplayOrder>3</DisplayOrder>
    <Id>5678c49e-2d94-413c-a4a9-4d234826d958</Id>
    <IsSelectionRequired>true</IsSelectionRequired>
    <Name>sample string 2</Name>
    <PageSize>5</PageSize>
    <PriceLevelId>37363834-5375-496a-a8ce-4107365f9b65</PriceLevelId>
    <WebSuiteWebProducts>
      <WebSuiteWebProduct>
        <DonationFundId>sample string 8</DonationFundId>
        <EventId>sample string 6</EventId>
        <Id>a291de4b-8c39-4435-8580-0b968f9f2b27</Id>
        <ImageUrl>sample string 10</ImageUrl>
        <Name>sample string 3</Name>
        <Price>2</Price>
        <ProductId>sample string 9</ProductId>
        <Program>
          <BillingTermLength>3</BillingTermLength>
          <Id>065f02a8-572a-4813-876f-013f8f0f62cd</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>a291de4b-8c39-4435-8580-0b968f9f2b27</Id>
        <ImageUrl>sample string 10</ImageUrl>
        <Name>sample string 3</Name>
        <Price>2</Price>
        <ProductId>sample string 9</ProductId>
        <Program>
          <BillingTermLength>3</BillingTermLength>
          <Id>065f02a8-572a-4813-876f-013f8f0f62cd</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>
  <WebSuiteCategory>
    <DisplayOrder>3</DisplayOrder>
    <Id>5678c49e-2d94-413c-a4a9-4d234826d958</Id>
    <IsSelectionRequired>true</IsSelectionRequired>
    <Name>sample string 2</Name>
    <PageSize>5</PageSize>
    <PriceLevelId>37363834-5375-496a-a8ce-4107365f9b65</PriceLevelId>
    <WebSuiteWebProducts>
      <WebSuiteWebProduct>
        <DonationFundId>sample string 8</DonationFundId>
        <EventId>sample string 6</EventId>
        <Id>a291de4b-8c39-4435-8580-0b968f9f2b27</Id>
        <ImageUrl>sample string 10</ImageUrl>
        <Name>sample string 3</Name>
        <Price>2</Price>
        <ProductId>sample string 9</ProductId>
        <Program>
          <BillingTermLength>3</BillingTermLength>
          <Id>065f02a8-572a-4813-876f-013f8f0f62cd</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>a291de4b-8c39-4435-8580-0b968f9f2b27</Id>
        <ImageUrl>sample string 10</ImageUrl>
        <Name>sample string 3</Name>
        <Price>2</Price>
        <ProductId>sample string 9</ProductId>
        <Program>
          <BillingTermLength>3</BillingTermLength>
          <Id>065f02a8-572a-4813-876f-013f8f0f62cd</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>
</ArrayOfWebSuiteCategory>