GET api/Products/GetProducts?pageIndex={pageIndex}&pageSize={pageSize}

Gets the products.

Request Information

URI Parameters

Name	Description	Type	Additional information
pageIndex		integer	None.
pageSize		integer	None.

Body Parameters

None.

Response Information

Resource Description

HttpStatusCode 200 OK.

GetProductsResult

Name	Description	Type	Additional information
PagedProducts	A page with Product rows.	GetProductResult	None.

Response Formats

application/json, text/json

Sample:

{
  "PagedProducts": {
    "PageIndex": 0,
    "PageSize": 10,
    "TotalItems": 1,
    "TotalPages": 1,
    "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:

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