GET v{version}/OptionGroups?SiteID={SiteID}

V2 Version of Option Groups

Request Information

URI Parameters

Name Type Description Additional information
SiteID integer

version string

None.

Body Parameters

None.

Response Information

Resource Description

Collection of OptionGroupDto
Name Type Description Additional information
OptionGroupID integer

None.

SiteID integer

None.

Name string

None.

MinOptionCount integer

None.

MaxOptionCount integer

None.

PromptForQuantity boolean

None.

Order integer

None.

Active boolean

None.

OptionItems Collection of OptionItemsDto

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "OptionGroupID": 1,
    "SiteID": 2,
    "Name": "sample string 3",
    "MinOptionCount": 4,
    "MaxOptionCount": 5,
    "PromptForQuantity": true,
    "Order": 7,
    "Active": true,
    "OptionItems": [
      {
        "OptionItemID": 1,
        "SiteID": 2,
        "OptionGroupID": 3,
        "Name": "sample string 4",
        "ProductID": 5,
        "MeasureID": 6,
        "Active": true,
        "Prices": [
          {
            "PriceGroupID": 1,
            "GrossPrice": 2.0
          },
          {
            "PriceGroupID": 1,
            "GrossPrice": 2.0
          }
        ]
      },
      {
        "OptionItemID": 1,
        "SiteID": 2,
        "OptionGroupID": 3,
        "Name": "sample string 4",
        "ProductID": 5,
        "MeasureID": 6,
        "Active": true,
        "Prices": [
          {
            "PriceGroupID": 1,
            "GrossPrice": 2.0
          },
          {
            "PriceGroupID": 1,
            "GrossPrice": 2.0
          }
        ]
      }
    ]
  },
  {
    "OptionGroupID": 1,
    "SiteID": 2,
    "Name": "sample string 3",
    "MinOptionCount": 4,
    "MaxOptionCount": 5,
    "PromptForQuantity": true,
    "Order": 7,
    "Active": true,
    "OptionItems": [
      {
        "OptionItemID": 1,
        "SiteID": 2,
        "OptionGroupID": 3,
        "Name": "sample string 4",
        "ProductID": 5,
        "MeasureID": 6,
        "Active": true,
        "Prices": [
          {
            "PriceGroupID": 1,
            "GrossPrice": 2.0
          },
          {
            "PriceGroupID": 1,
            "GrossPrice": 2.0
          }
        ]
      },
      {
        "OptionItemID": 1,
        "SiteID": 2,
        "OptionGroupID": 3,
        "Name": "sample string 4",
        "ProductID": 5,
        "MeasureID": 6,
        "Active": true,
        "Prices": [
          {
            "PriceGroupID": 1,
            "GrossPrice": 2.0
          },
          {
            "PriceGroupID": 1,
            "GrossPrice": 2.0
          }
        ]
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfOptionGroupDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.API.App.Models.v2">
  <OptionGroupDto>
    <Active>true</Active>
    <MaxOptionCount>5</MaxOptionCount>
    <MinOptionCount>4</MinOptionCount>
    <Name>sample string 3</Name>
    <OptionGroupID>1</OptionGroupID>
    <OptionItems>
      <OptionItemsDto>
        <Active>true</Active>
        <GrossPrice>7</GrossPrice>
        <MeasureID>6</MeasureID>
        <Name>sample string 4</Name>
        <OptionGroupID>3</OptionGroupID>
        <OptionItemID>1</OptionItemID>
        <Prices>
          <OptionGroupPriceModel>
            <GrossPrice>2</GrossPrice>
            <PriceGroupID>1</PriceGroupID>
          </OptionGroupPriceModel>
          <OptionGroupPriceModel>
            <GrossPrice>2</GrossPrice>
            <PriceGroupID>1</PriceGroupID>
          </OptionGroupPriceModel>
        </Prices>
        <ProductID>5</ProductID>
        <SiteID>2</SiteID>
      </OptionItemsDto>
      <OptionItemsDto>
        <Active>true</Active>
        <GrossPrice>7</GrossPrice>
        <MeasureID>6</MeasureID>
        <Name>sample string 4</Name>
        <OptionGroupID>3</OptionGroupID>
        <OptionItemID>1</OptionItemID>
        <Prices>
          <OptionGroupPriceModel>
            <GrossPrice>2</GrossPrice>
            <PriceGroupID>1</PriceGroupID>
          </OptionGroupPriceModel>
          <OptionGroupPriceModel>
            <GrossPrice>2</GrossPrice>
            <PriceGroupID>1</PriceGroupID>
          </OptionGroupPriceModel>
        </Prices>
        <ProductID>5</ProductID>
        <SiteID>2</SiteID>
      </OptionItemsDto>
    </OptionItems>
    <Order>7</Order>
    <PromptForQuantity>true</PromptForQuantity>
    <SiteID>2</SiteID>
  </OptionGroupDto>
  <OptionGroupDto>
    <Active>true</Active>
    <MaxOptionCount>5</MaxOptionCount>
    <MinOptionCount>4</MinOptionCount>
    <Name>sample string 3</Name>
    <OptionGroupID>1</OptionGroupID>
    <OptionItems>
      <OptionItemsDto>
        <Active>true</Active>
        <GrossPrice>7</GrossPrice>
        <MeasureID>6</MeasureID>
        <Name>sample string 4</Name>
        <OptionGroupID>3</OptionGroupID>
        <OptionItemID>1</OptionItemID>
        <Prices>
          <OptionGroupPriceModel>
            <GrossPrice>2</GrossPrice>
            <PriceGroupID>1</PriceGroupID>
          </OptionGroupPriceModel>
          <OptionGroupPriceModel>
            <GrossPrice>2</GrossPrice>
            <PriceGroupID>1</PriceGroupID>
          </OptionGroupPriceModel>
        </Prices>
        <ProductID>5</ProductID>
        <SiteID>2</SiteID>
      </OptionItemsDto>
      <OptionItemsDto>
        <Active>true</Active>
        <GrossPrice>7</GrossPrice>
        <MeasureID>6</MeasureID>
        <Name>sample string 4</Name>
        <OptionGroupID>3</OptionGroupID>
        <OptionItemID>1</OptionItemID>
        <Prices>
          <OptionGroupPriceModel>
            <GrossPrice>2</GrossPrice>
            <PriceGroupID>1</PriceGroupID>
          </OptionGroupPriceModel>
          <OptionGroupPriceModel>
            <GrossPrice>2</GrossPrice>
            <PriceGroupID>1</PriceGroupID>
          </OptionGroupPriceModel>
        </Prices>
        <ProductID>5</ProductID>
        <SiteID>2</SiteID>
      </OptionItemsDto>
    </OptionItems>
    <Order>7</Order>
    <PromptForQuantity>true</PromptForQuantity>
    <SiteID>2</SiteID>
  </OptionGroupDto>
</ArrayOfOptionGroupDto>