GET api/v2/gem/gemstones

Returns only certified gemstones

Request Information

URI Parameters

NameDescriptionTypeAdditional information
SerialNumbers

Collection of integer

None.

Colors

Collection of ColorFilter

None.

Shapes

Collection of ShapeFilter

None.

StoneTypes

Collection of StoneTypeFilter

None.

Length

decimal number

None.

Width

decimal number

None.

Filters

Collection of GemOptions

None.

NextPage

string

None.

Page

integer

None.

PageSize

integer

None.

Response Information

Resource Description

GemStoneResponse
NameDescriptionTypeAdditional information
GemStones

The list of serialized stones used to create exports.

Collection of GemStone

None.

NextPage

Used for paging the results. Stores which page the results are currently on.

string

None.

PageSize

The max amount of results to be on each page

integer

None.

TotalNumberOfGemstones

The total number of gemstones the result is returning.

integer

None.

Response Formats

Sample:

{
  "GemStones": [
    {
      "Length": "sample string 1",
      "Width": "sample string 2",
      "Height": "sample string 3",
      "SerialNumber": 4,
      "Shape": "sample string 5",
      "Clarity": "sample string 6",
      "CaratWeight": 7.0,
      "NormalizedWeight": "sample string 8",
      "Color": "sample string 9",
      "ColorDescription": "sample string 10",
      "Certification": "sample string 11",
      "CertificationNumber": "sample string 12",
      "Depth": 13.0,
      "Table": 14.0,
      "Girdle": "sample string 15",
      "Make": "sample string 16",
      "Polish": "sample string 17",
      "Symmetry": "sample string 18",
      "MMSize": "sample string 19",
      "LastUpdatedDate": "sample string 20",
      "Comments": "sample string 21",
      "WebAddress": "sample string 22",
      "CertificatePath": "sample string 23",
      "Cut": "sample string 24",
      "Measurements": "sample string 25",
      "StoneType": "sample string 26",
      "Active": true,
      "TotalDepth": "sample string 28",
      "Type": "sample string 29",
      "AGTA": "sample string 30",
      "ColorCode": "sample string 31",
      "Crown": "sample string 32",
      "Pavillion": "sample string 33",
      "Description": "sample string 34",
      "Images": [
        {
          "FullUrl": "sample string 1",
          "ThumbnailUrl": "sample string 2",
          "ZoomUrl": "sample string 3",
          "SortOrder": 4,
          "MaxHeight": 1,
          "MaxWidth": 1,
          "Angle": "sample string 5"
        },
        {
          "FullUrl": "sample string 1",
          "ThumbnailUrl": "sample string 2",
          "ZoomUrl": "sample string 3",
          "SortOrder": 4,
          "MaxHeight": 1,
          "MaxWidth": 1,
          "Angle": "sample string 5"
        }
      ],
      "Videos": [
        {
          "Url": "sample string 1",
          "DownloadUrl": "sample string 2"
        },
        {
          "Url": "sample string 1",
          "DownloadUrl": "sample string 2"
        }
      ],
      "Size": "sample string 35",
      "Price": {
        "Value": 1.0,
        "CurrencyCode": "sample string 2"
      },
      "PricePerCarat": {
        "Value": 1.0,
        "CurrencyCode": "sample string 2"
      },
      "ShowcasePrice": {
        "Value": 1.0,
        "CurrencyCode": "sample string 2"
      },
      "ShowcasePricePerCarat": {
        "Value": 1.0,
        "CurrencyCode": "sample string 2"
      },
      "MatchedSetId": "sample string 36"
    },
    {
      "Length": "sample string 1",
      "Width": "sample string 2",
      "Height": "sample string 3",
      "SerialNumber": 4,
      "Shape": "sample string 5",
      "Clarity": "sample string 6",
      "CaratWeight": 7.0,
      "NormalizedWeight": "sample string 8",
      "Color": "sample string 9",
      "ColorDescription": "sample string 10",
      "Certification": "sample string 11",
      "CertificationNumber": "sample string 12",
      "Depth": 13.0,
      "Table": 14.0,
      "Girdle": "sample string 15",
      "Make": "sample string 16",
      "Polish": "sample string 17",
      "Symmetry": "sample string 18",
      "MMSize": "sample string 19",
      "LastUpdatedDate": "sample string 20",
      "Comments": "sample string 21",
      "WebAddress": "sample string 22",
      "CertificatePath": "sample string 23",
      "Cut": "sample string 24",
      "Measurements": "sample string 25",
      "StoneType": "sample string 26",
      "Active": true,
      "TotalDepth": "sample string 28",
      "Type": "sample string 29",
      "AGTA": "sample string 30",
      "ColorCode": "sample string 31",
      "Crown": "sample string 32",
      "Pavillion": "sample string 33",
      "Description": "sample string 34",
      "Images": [
        {
          "FullUrl": "sample string 1",
          "ThumbnailUrl": "sample string 2",
          "ZoomUrl": "sample string 3",
          "SortOrder": 4,
          "MaxHeight": 1,
          "MaxWidth": 1,
          "Angle": "sample string 5"
        },
        {
          "FullUrl": "sample string 1",
          "ThumbnailUrl": "sample string 2",
          "ZoomUrl": "sample string 3",
          "SortOrder": 4,
          "MaxHeight": 1,
          "MaxWidth": 1,
          "Angle": "sample string 5"
        }
      ],
      "Videos": [
        {
          "Url": "sample string 1",
          "DownloadUrl": "sample string 2"
        },
        {
          "Url": "sample string 1",
          "DownloadUrl": "sample string 2"
        }
      ],
      "Size": "sample string 35",
      "Price": {
        "Value": 1.0,
        "CurrencyCode": "sample string 2"
      },
      "PricePerCarat": {
        "Value": 1.0,
        "CurrencyCode": "sample string 2"
      },
      "ShowcasePrice": {
        "Value": 1.0,
        "CurrencyCode": "sample string 2"
      },
      "ShowcasePricePerCarat": {
        "Value": 1.0,
        "CurrencyCode": "sample string 2"
      },
      "MatchedSetId": "sample string 36"
    }
  ],
  "NextPage": "sample string 1",
  "PageSize": 2,
  "TotalNumberOfGemstones": 3
}

Sample:

<GemStoneResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <GemStones>
    <GemStone>
      <AGTA>sample string 30</AGTA>
      <Active>true</Active>
      <CaratWeight>7</CaratWeight>
      <CertificatePath>sample string 23</CertificatePath>
      <Certification>sample string 11</Certification>
      <CertificationNumber>sample string 12</CertificationNumber>
      <Clarity>sample string 6</Clarity>
      <Color>sample string 9</Color>
      <ColorCode>sample string 31</ColorCode>
      <ColorDescription>sample string 10</ColorDescription>
      <Comments>sample string 21</Comments>
      <Crown>sample string 32</Crown>
      <Cut>sample string 24</Cut>
      <Depth>13</Depth>
      <Description>sample string 34</Description>
      <Girdle>sample string 15</Girdle>
      <Height>sample string 3</Height>
      <Images>
        <Image>
          <FullUrl>sample string 1</FullUrl>
          <ThumbnailUrl>sample string 2</ThumbnailUrl>
          <ZoomUrl>sample string 3</ZoomUrl>
          <MaxHeight>1</MaxHeight>
          <MaxWidth>1</MaxWidth>
          <SortOrder>4</SortOrder>
          <Angle>sample string 5</Angle>
        </Image>
        <Image>
          <FullUrl>sample string 1</FullUrl>
          <ThumbnailUrl>sample string 2</ThumbnailUrl>
          <ZoomUrl>sample string 3</ZoomUrl>
          <MaxHeight>1</MaxHeight>
          <MaxWidth>1</MaxWidth>
          <SortOrder>4</SortOrder>
          <Angle>sample string 5</Angle>
        </Image>
      </Images>
      <LastUpdatedDate>sample string 20</LastUpdatedDate>
      <Length>sample string 1</Length>
      <MMSize>sample string 19</MMSize>
      <Make>sample string 16</Make>
      <MatchedSetId>sample string 36</MatchedSetId>
      <Measurements>sample string 25</Measurements>
      <NormalizedWeight>sample string 8</NormalizedWeight>
      <Pavillion>sample string 33</Pavillion>
      <Polish>sample string 17</Polish>
      <Price>
        <CurrencyCode>sample string 2</CurrencyCode>
        <Value>1</Value>
      </Price>
      <PricePerCarat>
        <CurrencyCode>sample string 2</CurrencyCode>
        <Value>1</Value>
      </PricePerCarat>
      <SerialNumber>4</SerialNumber>
      <Shape>sample string 5</Shape>
      <ShowcasePrice>
        <CurrencyCode>sample string 2</CurrencyCode>
        <Value>1</Value>
      </ShowcasePrice>
      <ShowcasePricePerCarat>
        <CurrencyCode>sample string 2</CurrencyCode>
        <Value>1</Value>
      </ShowcasePricePerCarat>
      <Size>sample string 35</Size>
      <StoneType>sample string 26</StoneType>
      <Symmetry>sample string 18</Symmetry>
      <Table>14</Table>
      <TotalDepth>sample string 28</TotalDepth>
      <Type>sample string 29</Type>
      <Videos>
        <Video>
          <Url>sample string 1</Url>
          <DownloadUrl>sample string 2</DownloadUrl>
        </Video>
        <Video>
          <Url>sample string 1</Url>
          <DownloadUrl>sample string 2</DownloadUrl>
        </Video>
      </Videos>
      <WebAddress>sample string 22</WebAddress>
      <Width>sample string 2</Width>
    </GemStone>
    <GemStone>
      <AGTA>sample string 30</AGTA>
      <Active>true</Active>
      <CaratWeight>7</CaratWeight>
      <CertificatePath>sample string 23</CertificatePath>
      <Certification>sample string 11</Certification>
      <CertificationNumber>sample string 12</CertificationNumber>
      <Clarity>sample string 6</Clarity>
      <Color>sample string 9</Color>
      <ColorCode>sample string 31</ColorCode>
      <ColorDescription>sample string 10</ColorDescription>
      <Comments>sample string 21</Comments>
      <Crown>sample string 32</Crown>
      <Cut>sample string 24</Cut>
      <Depth>13</Depth>
      <Description>sample string 34</Description>
      <Girdle>sample string 15</Girdle>
      <Height>sample string 3</Height>
      <Images>
        <Image>
          <FullUrl>sample string 1</FullUrl>
          <ThumbnailUrl>sample string 2</ThumbnailUrl>
          <ZoomUrl>sample string 3</ZoomUrl>
          <MaxHeight>1</MaxHeight>
          <MaxWidth>1</MaxWidth>
          <SortOrder>4</SortOrder>
          <Angle>sample string 5</Angle>
        </Image>
        <Image>
          <FullUrl>sample string 1</FullUrl>
          <ThumbnailUrl>sample string 2</ThumbnailUrl>
          <ZoomUrl>sample string 3</ZoomUrl>
          <MaxHeight>1</MaxHeight>
          <MaxWidth>1</MaxWidth>
          <SortOrder>4</SortOrder>
          <Angle>sample string 5</Angle>
        </Image>
      </Images>
      <LastUpdatedDate>sample string 20</LastUpdatedDate>
      <Length>sample string 1</Length>
      <MMSize>sample string 19</MMSize>
      <Make>sample string 16</Make>
      <MatchedSetId>sample string 36</MatchedSetId>
      <Measurements>sample string 25</Measurements>
      <NormalizedWeight>sample string 8</NormalizedWeight>
      <Pavillion>sample string 33</Pavillion>
      <Polish>sample string 17</Polish>
      <Price>
        <CurrencyCode>sample string 2</CurrencyCode>
        <Value>1</Value>
      </Price>
      <PricePerCarat>
        <CurrencyCode>sample string 2</CurrencyCode>
        <Value>1</Value>
      </PricePerCarat>
      <SerialNumber>4</SerialNumber>
      <Shape>sample string 5</Shape>
      <ShowcasePrice>
        <CurrencyCode>sample string 2</CurrencyCode>
        <Value>1</Value>
      </ShowcasePrice>
      <ShowcasePricePerCarat>
        <CurrencyCode>sample string 2</CurrencyCode>
        <Value>1</Value>
      </ShowcasePricePerCarat>
      <Size>sample string 35</Size>
      <StoneType>sample string 26</StoneType>
      <Symmetry>sample string 18</Symmetry>
      <Table>14</Table>
      <TotalDepth>sample string 28</TotalDepth>
      <Type>sample string 29</Type>
      <Videos>
        <Video>
          <Url>sample string 1</Url>
          <DownloadUrl>sample string 2</DownloadUrl>
        </Video>
        <Video>
          <Url>sample string 1</Url>
          <DownloadUrl>sample string 2</DownloadUrl>
        </Video>
      </Videos>
      <WebAddress>sample string 22</WebAddress>
      <Width>sample string 2</Width>
    </GemStone>
  </GemStones>
  <NextPage>sample string 1</NextPage>
  <PageSize>2</PageSize>
  <TotalNumberOfGemstones>3</TotalNumberOfGemstones>
</GemStoneResponse>