GET v1/ServiceProduct/GetServiceProducts?searchField={searchField}&pageSize={pageSize}&pageNumber={pageNumber}

Get list of ServiceProductInfo for all available employee's shop groups. Pagination info included into response header.

Request Information

URI Parameters

Name	Description	Type	Additional information
searchField	Optionally specify a term to search within product's name, shop group and product brand.	string	Is Optional. Default value is (null).
pageSize	The max number of items returned. Default this value is 100.	integer	Is Optional. Default value is 100.
pageNumber	The page to return. Default page 1 will be returned.	integer	Is Optional. Default value is 1.

Name

Description

Type

Additional information

searchField

Optionally specify a term to search within product's name, shop group and product brand.

string

Is Optional.

Default value is (null).

pageSize

The max number of items returned. Default this value is 100.

integer

Is Optional.

Default value is 100.

pageNumber

The page to return. Default page 1 will be returned.

integer

Is Optional.

Default value is 1.

Body Parameters

None.

Response Information

Resource Description

A list of the ServiceProductInfo objects.

Collection of ServiceProductInfo

Name	Type	Additional information
Id	integer	Required
Name	string	Required Max length: 50
ShopGroupId	integer	Required
ShopGroupName	string	None.
ShopGroupIconUrl	string	None.
ProductBrandId	integer	Required
ProductBrandName	string	None.
WarrantyMonths	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Name": "sample string 2",
    "ShopGroupId": 3,
    "ShopGroupName": "sample string 4",
    "ShopGroupIconUrl": "sample string 5",
    "ProductBrandId": 6,
    "ProductBrandName": "sample string 7",
    "WarrantyMonths": 1
  },
  {
    "Id": 1,
    "Name": "sample string 2",
    "ShopGroupId": 3,
    "ShopGroupName": "sample string 4",
    "ShopGroupIconUrl": "sample string 5",
    "ProductBrandId": 6,
    "ProductBrandName": "sample string 7",
    "WarrantyMonths": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfServiceProductInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <ServiceProductInfo>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <ShopGroupId>3</ShopGroupId>
    <ShopGroupName>sample string 4</ShopGroupName>
    <ShopGroupIconUrl>sample string 5</ShopGroupIconUrl>
    <ProductBrandId>6</ProductBrandId>
    <ProductBrandName>sample string 7</ProductBrandName>
    <WarrantyMonths>1</WarrantyMonths>
  </ServiceProductInfo>
  <ServiceProductInfo>
    <Id>1</Id>
    <Name>sample string 2</Name>
    <ShopGroupId>3</ShopGroupId>
    <ShopGroupName>sample string 4</ShopGroupName>
    <ShopGroupIconUrl>sample string 5</ShopGroupIconUrl>
    <ProductBrandId>6</ProductBrandId>
    <ProductBrandName>sample string 7</ProductBrandName>
    <WarrantyMonths>1</WarrantyMonths>
  </ServiceProductInfo>
</ArrayOfServiceProductInfo>