GET api/Products/GetProduct/{id}

Gets the product.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

integer

Required

Body Parameters

None.

Response Information

Resource Description

HttpStatusCode 200 OK.

GetProductResult
NameDescriptionTypeAdditional information
Id

Product id

integer

None.

Name

Name

string

None.

Code

Code

string

None.

Description

Description

string

None.

IsDisabled

True if product is disabled

boolean

None.

ProductCategoryId

Product category id

integer

None.

Image

Image for product if is empty use FontIcon

Collection of byte

None.

FontIcon

Font awesome icon should be used when Image is null

string

None.

Color

Color for font awesome icon

string

None.

Response Formats

application/json, text/json

Sample:
{
  "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:
<GetProductResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RequestorApiDataStructures.Results">
  <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>