POST v3/Products/Search

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SearchString	string	None.
CategoryId	integer	None.
VendorId	integer	None.
SortByName	boolean	None.
Descending	boolean	None.
IsFeatured	boolean	None.
ScreenWidth	integer	None.
Skip	integer	None.
Top	integer	None.
PromotionId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "SearchString": "sample string 1",
  "CategoryId": 2,
  "VendorId": 3,
  "SortByName": true,
  "Descending": true,
  "IsFeatured": true,
  "ScreenWidth": 7,
  "Skip": 8,
  "Top": 9,
  "PromotionId": 10
}

application/xml, text/xml

Sample:

<ProductSearchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Go4Gold.WebAPI.Models">
  <CategoryId>2</CategoryId>
  <Descending>true</Descending>
  <IsFeatured>true</IsFeatured>
  <PromotionId>10</PromotionId>
  <ScreenWidth>7</ScreenWidth>
  <SearchString>sample string 1</SearchString>
  <Skip>8</Skip>
  <SortByName>true</SortByName>
  <Top>9</Top>
  <VendorId>3</VendorId>
</ProductSearchModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of ItemModel

Name	Type	Additional information
Id	integer	None.
Number	string	None.
Name	string	None.
Description	string	None.
Points	integer	None.
VendorName	string	None.
CategoryName	string	None.
ManufacturerName	string	None.
ImageId	integer	None.
IsFeatured	boolean	None.
IsDoublePoints	boolean	None.
ImageBytes	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Number": "sample string 2",
    "Name": "sample string 3",
    "Description": "sample string 4",
    "Points": 5,
    "VendorName": "sample string 6",
    "CategoryName": "sample string 7",
    "ManufacturerName": "sample string 8",
    "ImageId": 9,
    "IsFeatured": true,
    "IsDoublePoints": true,
    "ImageBytes": "sample string 12"
  },
  {
    "Id": 1,
    "Number": "sample string 2",
    "Name": "sample string 3",
    "Description": "sample string 4",
    "Points": 5,
    "VendorName": "sample string 6",
    "CategoryName": "sample string 7",
    "ManufacturerName": "sample string 8",
    "ImageId": 9,
    "IsFeatured": true,
    "IsDoublePoints": true,
    "ImageBytes": "sample string 12"
  }
]

application/xml, text/xml

Sample:

<ArrayOfItemModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Go4Gold.WebAPI.Models">
  <ItemModel>
    <CategoryName>sample string 7</CategoryName>
    <Description>sample string 4</Description>
    <Id>1</Id>
    <ImageBytes>sample string 12</ImageBytes>
    <ImageId>9</ImageId>
    <IsDoublePoints>true</IsDoublePoints>
    <IsFeatured>true</IsFeatured>
    <ManufacturerName>sample string 8</ManufacturerName>
    <Name>sample string 3</Name>
    <Number>sample string 2</Number>
    <Points>5</Points>
    <VendorName>sample string 6</VendorName>
  </ItemModel>
  <ItemModel>
    <CategoryName>sample string 7</CategoryName>
    <Description>sample string 4</Description>
    <Id>1</Id>
    <ImageBytes>sample string 12</ImageBytes>
    <ImageId>9</ImageId>
    <IsDoublePoints>true</IsDoublePoints>
    <IsFeatured>true</IsFeatured>
    <ManufacturerName>sample string 8</ManufacturerName>
    <Name>sample string 3</Name>
    <Number>sample string 2</Number>
    <Points>5</Points>
    <VendorName>sample string 6</VendorName>
  </ItemModel>
</ArrayOfItemModel>