GET api/v2/products/stonefamilies

Used to retrieve available stone families in a mounting's stone location(s).

Request Information

URI Parameters

Name	Description	Type	Additional information
ConfigurationModelId	The id of the configuration of a product.	integer	None.
LocationNumbers		Collection of integer	None.
Locations		Collection of LocationDimensions	None.
StoneGroups	The list of stones in the group.	Collection of string	None.

Response Information

Resource Description

StoneFamiliesResponse

Name	Description	Type	Additional information
StoneFamilies	List of the stone families that will be returned.	Collection of StoneFamily	None.

Sample:

{
  "StoneFamilies": [
    {
      "StoneGroup": "sample string 1",
      "LocationNumber": 1,
      "Name": "sample string 2",
      "Categories": [
        "sample string 1",
        "sample string 2"
      ],
      "CategoriesWithSerializedIndicator": [
        {
          "CategoryName": "sample string 1",
          "IsSerialized": true
        },
        {
          "CategoryName": "sample string 1",
          "IsSerialized": true
        }
      ]
    },
    {
      "StoneGroup": "sample string 1",
      "LocationNumber": 1,
      "Name": "sample string 2",
      "Categories": [
        "sample string 1",
        "sample string 2"
      ],
      "CategoriesWithSerializedIndicator": [
        {
          "CategoryName": "sample string 1",
          "IsSerialized": true
        },
        {
          "CategoryName": "sample string 1",
          "IsSerialized": true
        }
      ]
    }
  ]
}

Sample:

<StoneFamiliesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <StoneFamilies>
    <StoneFamily>
      <Categories xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Categories>
      <CategoriesWithSerializedIndicator>
        <StoneFamilyCategoryWithSerializedIndicator>
          <CategoryName>sample string 1</CategoryName>
          <IsSerialized>true</IsSerialized>
        </StoneFamilyCategoryWithSerializedIndicator>
        <StoneFamilyCategoryWithSerializedIndicator>
          <CategoryName>sample string 1</CategoryName>
          <IsSerialized>true</IsSerialized>
        </StoneFamilyCategoryWithSerializedIndicator>
      </CategoriesWithSerializedIndicator>
      <LocationNumber>1</LocationNumber>
      <Name>sample string 2</Name>
      <StoneGroup>sample string 1</StoneGroup>
    </StoneFamily>
    <StoneFamily>
      <Categories xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </Categories>
      <CategoriesWithSerializedIndicator>
        <StoneFamilyCategoryWithSerializedIndicator>
          <CategoryName>sample string 1</CategoryName>
          <IsSerialized>true</IsSerialized>
        </StoneFamilyCategoryWithSerializedIndicator>
        <StoneFamilyCategoryWithSerializedIndicator>
          <CategoryName>sample string 1</CategoryName>
          <IsSerialized>true</IsSerialized>
        </StoneFamilyCategoryWithSerializedIndicator>
      </CategoriesWithSerializedIndicator>
      <LocationNumber>1</LocationNumber>
      <Name>sample string 2</Name>
      <StoneGroup>sample string 1</StoneGroup>
    </StoneFamily>
  </StoneFamilies>
</StoneFamiliesResponse>