POST api/Syndication/GetDealerBrands

Get a list of brands the specified dealer carries. Authorization required.

Request Information

URI Parameters

None.

Body Parameters

RequestDealerBrands
NameDescriptionTypeAdditional information
SiteKey

string

None.

Request Formats

application/json, text/json

Sample:
{
  "SiteKey": "sample string 1"
}

application/xml, text/xml

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

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

Response Information

Resource Description

ResponseDealerBrands
NameDescriptionTypeAdditional information
Brands

Collection of jDealerBrand

None.

Success

boolean

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Brands": [
    {
      "BrandCode": "sample string 1",
      "BrandName": "sample string 2"
    },
    {
      "BrandCode": "sample string 1",
      "BrandName": "sample string 2"
    }
  ],
  "Success": true,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:
<ResponseDealerBrands 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>
  <Brands xmlns:d2p1="http://schemas.datacontract.org/2004/07/data.hearthnhome.Models.Syndication.Catalog">
    <d2p1:jDealerBrand>
      <d2p1:BrandCode>sample string 1</d2p1:BrandCode>
      <d2p1:BrandName>sample string 2</d2p1:BrandName>
    </d2p1:jDealerBrand>
    <d2p1:jDealerBrand>
      <d2p1:BrandCode>sample string 1</d2p1:BrandCode>
      <d2p1:BrandName>sample string 2</d2p1:BrandName>
    </d2p1:jDealerBrand>
  </Brands>
</ResponseDealerBrands>