GET api/Party/Inventory/GroupByCategory?orderId={orderId}

Method to return a list of Items Group by Category.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
orderId

The ID of the party to close

 integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of CategoryViewModel
NameDescriptionTypeAdditional information
Category

string

None.
CategoryID

integer

None.
DisplayCategory

string

None.
HasSubCats

boolean

None.
ParentCategoryID

integer

None.
SortOrder

integer

None.
Products

Collection of InventoryViewModel

None.

Response Formats

application/xml, text/xml

Sample: 
<ListOfCategoryViewModel>
  <CategoryViewModel>
    <Category>sample string 1</Category>
    <CategoryID>2</CategoryID>
    <DisplayCategory>sample string 3</DisplayCategory>
    <HasSubCats>True</HasSubCats>
    <ParentCategoryID>5</ParentCategoryID>
    <SortOrder>6</SortOrder>
    <Products>
      <InventoryViewModel>
        <ProductID>sample string 1</ProductID>
        <DisplayName>sample string 2</DisplayName>
        <ShortDetail>sample string 3</ShortDetail>
        <LongDetail>sample string 4</LongDetail>
        <Price>5</Price>
        <CurrencyTypeID>6</CurrencyTypeID>
        <AutoShipPrice>1</AutoShipPrice>
        <Volume>1</Volume>
        <SmallImageURL>sample string 7</SmallImageURL>
        <LargeImageURL>sample string 8</LargeImageURL>
        <QtyOptions>sample string 9</QtyOptions>
        <InventoryRelationshipGroupID>10</InventoryRelationshipGroupID>
        <IsResourceServerImage>True</IsResourceServerImage>
        <OnHand>12</OnHand>
        <LowStockMessage>sample string 13</LowStockMessage>
        <OutOfStockMessage>sample string 14</OutOfStockMessage>
        <SoftAllocationTimerOverride>15</SoftAllocationTimerOverride>
        <TimeDuration>sample string 16</TimeDuration>
        <IsPartyItem>True</IsPartyItem>
        <InventoryOptionsGroup>
          <InventoryOptionsGroupViewModel>
            <GroupDescription>sample string 1</GroupDescription>
            <GroupId>2</GroupId>
            <RelationshipTypeProgrammingKey>sample string 3</RelationshipTypeProgrammingKey>
            <InventoryList>
              <InventoryViewModel />
              <InventoryViewModel />
            </InventoryList>
          </InventoryOptionsGroupViewModel>
          <InventoryOptionsGroupViewModel>
            <GroupDescription>sample string 1</GroupDescription>
            <GroupId>2</GroupId>
            <RelationshipTypeProgrammingKey>sample string 3</RelationshipTypeProgrammingKey>
            <InventoryList>
              <InventoryViewModel />
              <InventoryViewModel />
            </InventoryList>
          </InventoryOptionsGroupViewModel>
        </InventoryOptionsGroup>
      </InventoryViewModel>
      <InventoryViewModel>
        <ProductID>sample string 1</ProductID>
        <DisplayName>sample string 2</DisplayName>
        <ShortDetail>sample string 3</ShortDetail>
        <LongDetail>sample string 4</LongDetail>
        <Price>5</Price>
        <CurrencyTypeID>6</CurrencyTypeID>
        <AutoShipPrice>1</AutoShipPrice>
        <Volume>1</Volume>
        <SmallImageURL>sample string 7</SmallImageURL>
        <LargeImageURL>sample string 8</LargeImageURL>
        <QtyOptions>sample string 9</QtyOptions>
        <InventoryRelationshipGroupID>10</InventoryRelationshipGroupID>
        <IsResourceServerImage>True</IsResourceServerImage>
        <OnHand>12</OnHand>
        <LowStockMessage>sample string 13</LowStockMessage>
        <OutOfStockMessage>sample string 14</OutOfStockMessage>
        <SoftAllocationTimerOverride>15</SoftAllocationTimerOverride>
        <TimeDuration>sample string 16</TimeDuration>
        <IsPartyItem>True</IsPartyItem>
        <InventoryOptionsGroup>
          <InventoryOptionsGroupViewModel>
            <GroupDescription>sample string 1</GroupDescription>
            <GroupId>2</GroupId>
            <RelationshipTypeProgrammingKey>sample string 3</RelationshipTypeProgrammingKey>
            <InventoryList>
              <InventoryViewModel />
              <InventoryViewModel />
            </InventoryList>
          </InventoryOptionsGroupViewModel>
          <InventoryOptionsGroupViewModel>
            <GroupDescription>sample string 1</GroupDescription>
            <GroupId>2</GroupId>
            <RelationshipTypeProgrammingKey>sample string 3</RelationshipTypeProgrammingKey>
            <InventoryList>
              <InventoryViewModel />
              <InventoryViewModel />
            </InventoryList>
          </InventoryOptionsGroupViewModel>
        </InventoryOptionsGroup>
      </InventoryViewModel>
    </Products>
  </CategoryViewModel>
  <CategoryViewModel>
    <Category>sample string 1</Category>
    <CategoryID>2</CategoryID>
    <DisplayCategory>sample string 3</DisplayCategory>
    <HasSubCats>True</HasSubCats>
    <ParentCategoryID>5</ParentCategoryID>
    <SortOrder>6</SortOrder>
    <Products>
      <InventoryViewModel>
        <ProductID>sample string 1</ProductID>
        <DisplayName>sample string 2</DisplayName>
        <ShortDetail>sample string 3</ShortDetail>
        <LongDetail>sample string 4</LongDetail>
        <Price>5</Price>
        <CurrencyTypeID>6</CurrencyTypeID>
        <AutoShipPrice>1</AutoShipPrice>
        <Volume>1</Volume>
        <SmallImageURL>sample string 7</SmallImageURL>
        <LargeImageURL>sample string 8</LargeImageURL>
        <QtyOptions>sample string 9</QtyOptions>
        <InventoryRelationshipGroupID>10</InventoryRelationshipGroupID>
        <IsResourceServerImage>True</IsResourceServerImage>
        <OnHand>12</OnHand>
        <LowStockMessage>sample string 13</LowStockMessage>
        <OutOfStockMessage>sample string 14</OutOfStockMessage>
        <SoftAllocationTimerOverride>15</SoftAllocationTimerOverride>
        <TimeDuration>sample string 16</TimeDuration>
        <IsPartyItem>True</IsPartyItem>
        <InventoryOptionsGroup>
          <InventoryOptionsGroupViewModel>
            <GroupDescription>sample string 1</GroupDescription>
            <GroupId>2</GroupId>
            <RelationshipTypeProgrammingKey>sample string 3</RelationshipTypeProgrammingKey>
            <InventoryList>
              <InventoryViewModel />
              <InventoryViewModel />
            </InventoryList>
          </InventoryOptionsGroupViewModel>
          <InventoryOptionsGroupViewModel>
            <GroupDescription>sample string 1</GroupDescription>
            <GroupId>2</GroupId>
            <RelationshipTypeProgrammingKey>sample string 3</RelationshipTypeProgrammingKey>
            <InventoryList>
              <InventoryViewModel />
              <InventoryViewModel />
            </InventoryList>
          </InventoryOptionsGroupViewModel>
        </InventoryOptionsGroup>
      </InventoryViewModel>
      <InventoryViewModel>
        <ProductID>sample string 1</ProductID>
        <DisplayName>sample string 2</DisplayName>
        <ShortDetail>sample string 3</ShortDetail>
        <LongDetail>sample string 4</LongDetail>
        <Price>5</Price>
        <CurrencyTypeID>6</CurrencyTypeID>
        <AutoShipPrice>1</AutoShipPrice>
        <Volume>1</Volume>
        <SmallImageURL>sample string 7</SmallImageURL>
        <LargeImageURL>sample string 8</LargeImageURL>
        <QtyOptions>sample string 9</QtyOptions>
        <InventoryRelationshipGroupID>10</InventoryRelationshipGroupID>
        <IsResourceServerImage>True</IsResourceServerImage>
        <OnHand>12</OnHand>
        <LowStockMessage>sample string 13</LowStockMessage>
        <OutOfStockMessage>sample string 14</OutOfStockMessage>
        <SoftAllocationTimerOverride>15</SoftAllocationTimerOverride>
        <TimeDuration>sample string 16</TimeDuration>
        <IsPartyItem>True</IsPartyItem>
        <InventoryOptionsGroup>
          <InventoryOptionsGroupViewModel>
            <GroupDescription>sample string 1</GroupDescription>
            <GroupId>2</GroupId>
            <RelationshipTypeProgrammingKey>sample string 3</RelationshipTypeProgrammingKey>
            <InventoryList>
              <InventoryViewModel />
              <InventoryViewModel />
            </InventoryList>
          </InventoryOptionsGroupViewModel>
          <InventoryOptionsGroupViewModel>
            <GroupDescription>sample string 1</GroupDescription>
            <GroupId>2</GroupId>
            <RelationshipTypeProgrammingKey>sample string 3</RelationshipTypeProgrammingKey>
            <InventoryList>
              <InventoryViewModel />
              <InventoryViewModel />
            </InventoryList>
          </InventoryOptionsGroupViewModel>
        </InventoryOptionsGroup>
      </InventoryViewModel>
    </Products>
  </CategoryViewModel>
</ListOfCategoryViewModel>

application/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'application/json'. Exception message: Self referencing loop detected with type 'ByDesign.SOA.Applications.WebAPI.Areas.Party.Models.PartyInventoryViewModel+InventoryViewModel'. Path '[0].Products[0].InventoryOptionsGroup[0].InventoryList'.

text/json

Sample:

An exception has occurred while using the formatter 'JsonMediaTypeFormatter' to generate sample for media type 'text/json'. Exception message: Self referencing loop detected with type 'ByDesign.SOA.Applications.WebAPI.Areas.Party.Models.PartyInventoryViewModel+InventoryViewModel'. Path '[0].Products[0].InventoryOptionsGroup[0].InventoryList'.