POST api/Products/SearchProducts

Search products

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PageIndex	Page index	integer	None.
PageSize	Page size	integer	None.
Value	Text to search. Required. Case insensitive	string	None.

Request Formats

application/json, text/json

Sample:

{
  "PageIndex": 0,
  "PageSize": 10,
  "Value": "test"
}

application/xml, text/xml

Sample:

<SearchProductsPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Posts">
  <PageIndex>0</PageIndex>
  <PageSize>10</PageSize>
  <Value>test</Value>
</SearchProductsPost>

Response Information

Resource Description

SearchProductsResult

Name	Description	Type	Additional information
Products	A scroll with Products.	SearchProduct	None.

Response Formats

application/json, text/json

Sample:

{
  "Products": {
    "PageIndex": 0,
    "PageSize": 10,
    "IsNextPage": false,
    "Items": [
      {
        "Id": 1,
        "Name": "Product",
        "Code": null,
        "Description": null,
        "IsDisabled": false,
        "ProductCategoryId": null,
        "Image": null,
        "FontIcon": "fas fa-address-book",
        "Color": "#ffffff"
      }
    ]
  }
}

application/xml, text/xml

Sample:

<SearchProductsResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <Products>
    <IsNextPage>false</IsNextPage>
    <Items xmlns:d3p1="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.DataStructures">
      <d3p1:SearchProduct>
        <d3p1:Code i:nil="true" />
        <d3p1:Color>#ffffff</d3p1:Color>
        <d3p1:Description i:nil="true" />
        <d3p1:FontIcon>fas fa-address-book</d3p1:FontIcon>
        <d3p1:Id>1</d3p1:Id>
        <d3p1:Image i:nil="true" />
        <d3p1:IsDisabled>false</d3p1:IsDisabled>
        <d3p1:Name>Product</d3p1:Name>
        <d3p1:ProductCategoryId i:nil="true" />
      </d3p1:SearchProduct>
    </Items>
    <PageIndex>0</PageIndex>
    <PageSize>10</PageSize>
  </Products>
</SearchProductsResult>