Documentation for GET api/Party/Inventory/Kits?orderId={orderId}&productId={productId}

GET api/Party/Inventory/Kits?orderId={orderId}&productId={productId}

Method to return Kit group for specific ProductID.

Request Information

URI Parameters

Name	Description	Type	Additional information
orderId		integer	Required
productId		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of InventoryViewModel

Name	Type	Additional information
ProductID	string	None.
DisplayName	string	None.
ShortDetail	string	None.
LongDetail	string	None.
Price	decimal number	None.
CurrencyTypeID	integer	None.
AutoShipPrice	decimal number	None.
Volume	decimal number	None.
SmallImageURL	string	None.
LargeImageURL	string	None.
QtyOptions	string	None.
InventoryRelationshipGroupID	integer	None.
IsResourceServerImage	boolean	None.
OnHand	integer	None.
LowStockMessage	string	None.
OutOfStockMessage	string	None.
SoftAllocationTimerOverride	integer	None.
TimeDuration	string	None.
IsPartyItem	boolean	None.
InventoryOptionsGroup	Collection of InventoryOptionsGroupViewModel	None.

Response Formats

application/xml, text/xml

Sample:

<ListOfInventoryViewModel>
  <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>
</ListOfInventoryViewModel>

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].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].InventoryOptionsGroup[0].InventoryList'.