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": "3f9c113b-c6ee-4cae-af3d-2761c2fd6d2c",
    "Name": "sample string 2",
    "DisplayOrder": 3.0,
    "PriceLevelId": "ec905992-7c0c-4f5f-a8c3-6158f83684a1",
    "PageSize": 5,
    "IsSelectionRequired": true,
    "WebSuiteWebProducts": [
      {
        "Id": "04ce0acb-78a2-4554-a18f-7ea512891127",
        "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": "5c385543-c28a-4b6b-8207-cc1d7e645bd1",
          "Name": "sample string 2",
          "BillingTermLength": 3
        }
      },
      {
        "Id": "04ce0acb-78a2-4554-a18f-7ea512891127",
        "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": "5c385543-c28a-4b6b-8207-cc1d7e645bd1",
          "Name": "sample string 2",
          "BillingTermLength": 3
        }
      }
    ]
  },
  {
    "Id": "3f9c113b-c6ee-4cae-af3d-2761c2fd6d2c",
    "Name": "sample string 2",
    "DisplayOrder": 3.0,
    "PriceLevelId": "ec905992-7c0c-4f5f-a8c3-6158f83684a1",
    "PageSize": 5,
    "IsSelectionRequired": true,
    "WebSuiteWebProducts": [
      {
        "Id": "04ce0acb-78a2-4554-a18f-7ea512891127",
        "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": "5c385543-c28a-4b6b-8207-cc1d7e645bd1",
          "Name": "sample string 2",
          "BillingTermLength": 3
        }
      },
      {
        "Id": "04ce0acb-78a2-4554-a18f-7ea512891127",
        "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": "5c385543-c28a-4b6b-8207-cc1d7e645bd1",
          "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>3f9c113b-c6ee-4cae-af3d-2761c2fd6d2c</Id>
    <IsSelectionRequired>true</IsSelectionRequired>
    <Name>sample string 2</Name>
    <PageSize>5</PageSize>
    <PriceLevelId>ec905992-7c0c-4f5f-a8c3-6158f83684a1</PriceLevelId>
    <WebSuiteWebProducts>
      <WebSuiteWebProduct>
        <DonationFundId>sample string 8</DonationFundId>
        <EventId>sample string 6</EventId>
        <Id>04ce0acb-78a2-4554-a18f-7ea512891127</Id>
        <ImageUrl>sample string 10</ImageUrl>
        <Name>sample string 3</Name>
        <Price>2</Price>
        <ProductId>sample string 9</ProductId>
        <Program>
          <BillingTermLength>3</BillingTermLength>
          <Id>5c385543-c28a-4b6b-8207-cc1d7e645bd1</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>04ce0acb-78a2-4554-a18f-7ea512891127</Id>
        <ImageUrl>sample string 10</ImageUrl>
        <Name>sample string 3</Name>
        <Price>2</Price>
        <ProductId>sample string 9</ProductId>
        <Program>
          <BillingTermLength>3</BillingTermLength>
          <Id>5c385543-c28a-4b6b-8207-cc1d7e645bd1</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>3f9c113b-c6ee-4cae-af3d-2761c2fd6d2c</Id>
    <IsSelectionRequired>true</IsSelectionRequired>
    <Name>sample string 2</Name>
    <PageSize>5</PageSize>
    <PriceLevelId>ec905992-7c0c-4f5f-a8c3-6158f83684a1</PriceLevelId>
    <WebSuiteWebProducts>
      <WebSuiteWebProduct>
        <DonationFundId>sample string 8</DonationFundId>
        <EventId>sample string 6</EventId>
        <Id>04ce0acb-78a2-4554-a18f-7ea512891127</Id>
        <ImageUrl>sample string 10</ImageUrl>
        <Name>sample string 3</Name>
        <Price>2</Price>
        <ProductId>sample string 9</ProductId>
        <Program>
          <BillingTermLength>3</BillingTermLength>
          <Id>5c385543-c28a-4b6b-8207-cc1d7e645bd1</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>04ce0acb-78a2-4554-a18f-7ea512891127</Id>
        <ImageUrl>sample string 10</ImageUrl>
        <Name>sample string 3</Name>
        <Price>2</Price>
        <ProductId>sample string 9</ProductId>
        <Program>
          <BillingTermLength>3</BillingTermLength>
          <Id>5c385543-c28a-4b6b-8207-cc1d7e645bd1</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>