POST api/Syndication/GetProductDetail

Get product details. Authorization required.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
ProductId		string	None.
SiteKey		string	None.

Request Formats

application/json, text/json

Sample:

{
  "ProductId": "sample string 1",
  "SiteKey": "sample string 2"
}

application/xml, text/xml

Sample:

<RequestGetProductDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/data.hearthnhome.Models.Syndication.Request">
  <SiteKey>sample string 2</SiteKey>
  <ProductId>sample string 1</ProductId>
</RequestGetProductDetail>

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 'RequestGetProductDetail'.

Response Information

Resource Description

ResponseProductDetail

Name	Type	Additional information
Product	jProduct	None.
Success	boolean	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Product": {
    "ProductID": "sample string 1",
    "ProductName": "sample string 2",
    "ProductDescription": "sample string 3",
    "MSRP": "sample string 4",
    "Brand": "sample string 5",
    "BrandCode": "sample string 6",
    "FuelType": "sample string 7",
    "ImageLarge": "sample string 8",
    "ListImage": "sample string 9",
    "ProductBrochures": "sample string 10",
    "InstallationManuals": "sample string 11",
    "OwnersManuals": "sample string 12",
    "ServiceParts": "sample string 13",
    "ArchitectGuides": "sample string 14",
    "CadDrawings": "sample string 15",
    "SpecificationsChart": "sample string 16",
    "EfficiencyChart": "sample string 17",
    "SpecificationImages": "sample string 18"
  },
  "Success": true,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<ResponseProductDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/data.hearthnhome.Models.Syndication.Response">
  <Message>sample string 2</Message>
  <Success>true</Success>
  <Product xmlns:d2p1="http://schemas.datacontract.org/2004/07/data.hearthnhome.Models.Syndication.Catalog">
    <d2p1:ArchitectGuides>sample string 14</d2p1:ArchitectGuides>
    <d2p1:Brand>sample string 5</d2p1:Brand>
    <d2p1:BrandCode>sample string 6</d2p1:BrandCode>
    <d2p1:CadDrawings>sample string 15</d2p1:CadDrawings>
    <d2p1:EfficiencyChart>sample string 17</d2p1:EfficiencyChart>
    <d2p1:FuelType>sample string 7</d2p1:FuelType>
    <d2p1:ImageLarge>sample string 8</d2p1:ImageLarge>
    <d2p1:InstallationManuals>sample string 11</d2p1:InstallationManuals>
    <d2p1:ListImage>sample string 9</d2p1:ListImage>
    <d2p1:MSRP>sample string 4</d2p1:MSRP>
    <d2p1:OwnersManuals>sample string 12</d2p1:OwnersManuals>
    <d2p1:ProductBrochures>sample string 10</d2p1:ProductBrochures>
    <d2p1:ProductDescription>sample string 3</d2p1:ProductDescription>
    <d2p1:ProductID>sample string 1</d2p1:ProductID>
    <d2p1:ProductName>sample string 2</d2p1:ProductName>
    <d2p1:ServiceParts>sample string 13</d2p1:ServiceParts>
    <d2p1:SpecificationImages>sample string 18</d2p1:SpecificationImages>
    <d2p1:SpecificationsChart>sample string 16</d2p1:SpecificationsChart>
  </Product>
</ResponseProductDetail>