POST api/v1/product/search

Search into products

Request Information

URI Parameters

None.

Body Parameters

The parameters to search

Collection of ProductSearchModel

Name	Description	Type	Additional information
SearchKey		ProductSearchEnum	None.
SearchValue		string	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "SearchKey": 0,
    "SearchValue": "sample string 1"
  },
  {
    "SearchKey": 0,
    "SearchValue": "sample string 1"
  }
]

application/xml, text/xml

Sample:

<ArrayOfProductSearchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PromotionalOffice.WebApi.Models.Product">
  <ProductSearchModel>
    <SearchKey>OwnProductNumber</SearchKey>
    <SearchValue>sample string 1</SearchValue>
  </ProductSearchModel>
  <ProductSearchModel>
    <SearchKey>OwnProductNumber</SearchKey>
    <SearchValue>sample string 1</SearchValue>
  </ProductSearchModel>
</ArrayOfProductSearchModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'List`1'.

Response Information

Resource Description

Multiple products found by the search parameters

Collection of ProductSearchResult

Name	Description	Type	Additional information
ArticleNumber	Own article number	string	None.
OrderNumber	Article number of the supplier	string	None.
ProductName	Product name	string	None.
SupplierName	Name of the supplier	string	None.
IsActive	Is product active	boolean	None.
ArticleType	Tye of the article	ArticleTypeEnum	None.
ProductIdentifier	Product identifier, used for reference	globally unique identifier	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ArticleNumber": "sample string 1",
    "OrderNumber": "sample string 2",
    "ProductName": "sample string 3",
    "SupplierName": "sample string 4",
    "IsActive": true,
    "ArticleType": 0,
    "ProductIdentifier": "c1ac668c-d500-4517-ab5d-88de0ce9056c"
  },
  {
    "ArticleNumber": "sample string 1",
    "OrderNumber": "sample string 2",
    "ProductName": "sample string 3",
    "SupplierName": "sample string 4",
    "IsActive": true,
    "ArticleType": 0,
    "ProductIdentifier": "c1ac668c-d500-4517-ab5d-88de0ce9056c"
  }
]

application/xml, text/xml

Sample:

<ArrayOfProductSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://promotionaloffice.promidata.com/2012/08/08">
  <ProductSearchResult>
    <ArticleNumber>sample string 1</ArticleNumber>
    <ArticleType>Empty</ArticleType>
    <IsActive>true</IsActive>
    <OrderNumber>sample string 2</OrderNumber>
    <ProductIdentifier>c1ac668c-d500-4517-ab5d-88de0ce9056c</ProductIdentifier>
    <ProductName>sample string 3</ProductName>
    <SupplierName>sample string 4</SupplierName>
  </ProductSearchResult>
  <ProductSearchResult>
    <ArticleNumber>sample string 1</ArticleNumber>
    <ArticleType>Empty</ArticleType>
    <IsActive>true</IsActive>
    <OrderNumber>sample string 2</OrderNumber>
    <ProductIdentifier>c1ac668c-d500-4517-ab5d-88de0ce9056c</ProductIdentifier>
    <ProductName>sample string 3</ProductName>
    <SupplierName>sample string 4</SupplierName>
  </ProductSearchResult>
</ArrayOfProductSearchResult>