POST api/Dealer/GetDealer

Get details for the specified dealer. Authorization required.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
DealerId		string	None.

Request Formats

application/json, text/json

Sample:

{
  "DealerId": "sample string 1"
}

application/xml, text/xml

Sample:

<DealerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/data.hearthnhome.Models.Dealer">
  <DealerId>sample string 1</DealerId>
</DealerRequest>

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

Response Information

Resource Description

DealerResponse

Name	Type	Additional information
Dealer	vDealer	None.
Success	boolean	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Dealer": {
    "ID": "sample string 1",
    "Name": "sample string 2",
    "Address1": "sample string 3",
    "Address2": "sample string 4",
    "City": "sample string 5",
    "State": "sample string 6",
    "Zip": "sample string 7",
    "CountryName": "sample string 8",
    "Country": "sample string 9",
    "Phone": "sample string 10",
    "LeadEmailAddresses": "sample string 11",
    "ServiceEmail": "sample string 12",
    "ServicePhone": "sample string 13",
    "Website": "sample string 14",
    "TotalDisplays": 1,
    "AwardLevelFP": "sample string 15",
    "AwardLevelSTV": "sample string 16",
    "LocatorEligibility": "sample string 17",
    "DealerBrands": [
      {
        "DealerId": "sample string 1",
        "Brand": "sample string 2",
        "BrandName": "sample string 3",
        "Displays": 4,
        "ShowOnConsumerLocator": true,
        "ShowOnProfessionalLocator": true
      },
      {
        "DealerId": "sample string 1",
        "Brand": "sample string 2",
        "BrandName": "sample string 3",
        "Displays": 4,
        "ShowOnConsumerLocator": true,
        "ShowOnProfessionalLocator": true
      }
    ],
    "Categories": [
      {
        "DealerId": "sample string 1",
        "CategoryId": "sample string 2",
        "CategoryName": "sample string 3",
        "ImageUrl": "sample string 4",
        "Sort": 5,
        "CategoryBrands": "sample string 6",
        "Subcategories": [
          {
            "DealerId": "sample string 1",
            "SubcategoryId": "sample string 2",
            "CategoryID": "sample string 3",
            "SubcategoryName": "sample string 4",
            "SubcategoryImageUrl": "sample string 5",
            "SubcategorySort": 6,
            "SubcategoryBrands": "sample string 7"
          },
          {
            "DealerId": "sample string 1",
            "SubcategoryId": "sample string 2",
            "CategoryID": "sample string 3",
            "SubcategoryName": "sample string 4",
            "SubcategoryImageUrl": "sample string 5",
            "SubcategorySort": 6,
            "SubcategoryBrands": "sample string 7"
          }
        ]
      },
      {
        "DealerId": "sample string 1",
        "CategoryId": "sample string 2",
        "CategoryName": "sample string 3",
        "ImageUrl": "sample string 4",
        "Sort": 5,
        "CategoryBrands": "sample string 6",
        "Subcategories": [
          {
            "DealerId": "sample string 1",
            "SubcategoryId": "sample string 2",
            "CategoryID": "sample string 3",
            "SubcategoryName": "sample string 4",
            "SubcategoryImageUrl": "sample string 5",
            "SubcategorySort": 6,
            "SubcategoryBrands": "sample string 7"
          },
          {
            "DealerId": "sample string 1",
            "SubcategoryId": "sample string 2",
            "CategoryID": "sample string 3",
            "SubcategoryName": "sample string 4",
            "SubcategoryImageUrl": "sample string 5",
            "SubcategorySort": 6,
            "SubcategoryBrands": "sample string 7"
          }
        ]
      }
    ]
  },
  "Success": true,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample:

<DealerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/data.hearthnhome.Models.Dealer">
  <Message xmlns="http://schemas.datacontract.org/2004/07/data.hearthnhome.Models.Syndication.Response">sample string 2</Message>
  <Success xmlns="http://schemas.datacontract.org/2004/07/data.hearthnhome.Models.Syndication.Response">true</Success>
  <Dealer xmlns:d2p1="http://schemas.datacontract.org/2004/07/data.hearthnhome.DataAccess">
    <d2p1:Address1>sample string 3</d2p1:Address1>
    <d2p1:Address2>sample string 4</d2p1:Address2>
    <d2p1:AwardLevelFP>sample string 15</d2p1:AwardLevelFP>
    <d2p1:AwardLevelSTV>sample string 16</d2p1:AwardLevelSTV>
    <d2p1:Categories>
      <d2p1:vDealerCategory>
        <d2p1:CategoryBrands>sample string 6</d2p1:CategoryBrands>
        <d2p1:CategoryId>sample string 2</d2p1:CategoryId>
        <d2p1:CategoryName>sample string 3</d2p1:CategoryName>
        <d2p1:DealerId>sample string 1</d2p1:DealerId>
        <d2p1:ImageUrl>sample string 4</d2p1:ImageUrl>
        <d2p1:Sort>5</d2p1:Sort>
        <d2p1:Subcategories>
          <d2p1:vDealerSubcategory>
            <d2p1:CategoryID>sample string 3</d2p1:CategoryID>
            <d2p1:DealerId>sample string 1</d2p1:DealerId>
            <d2p1:SubcategoryBrands>sample string 7</d2p1:SubcategoryBrands>
            <d2p1:SubcategoryId>sample string 2</d2p1:SubcategoryId>
            <d2p1:SubcategoryImageUrl>sample string 5</d2p1:SubcategoryImageUrl>
            <d2p1:SubcategoryName>sample string 4</d2p1:SubcategoryName>
            <d2p1:SubcategorySort>6</d2p1:SubcategorySort>
          </d2p1:vDealerSubcategory>
          <d2p1:vDealerSubcategory>
            <d2p1:CategoryID>sample string 3</d2p1:CategoryID>
            <d2p1:DealerId>sample string 1</d2p1:DealerId>
            <d2p1:SubcategoryBrands>sample string 7</d2p1:SubcategoryBrands>
            <d2p1:SubcategoryId>sample string 2</d2p1:SubcategoryId>
            <d2p1:SubcategoryImageUrl>sample string 5</d2p1:SubcategoryImageUrl>
            <d2p1:SubcategoryName>sample string 4</d2p1:SubcategoryName>
            <d2p1:SubcategorySort>6</d2p1:SubcategorySort>
          </d2p1:vDealerSubcategory>
        </d2p1:Subcategories>
      </d2p1:vDealerCategory>
      <d2p1:vDealerCategory>
        <d2p1:CategoryBrands>sample string 6</d2p1:CategoryBrands>
        <d2p1:CategoryId>sample string 2</d2p1:CategoryId>
        <d2p1:CategoryName>sample string 3</d2p1:CategoryName>
        <d2p1:DealerId>sample string 1</d2p1:DealerId>
        <d2p1:ImageUrl>sample string 4</d2p1:ImageUrl>
        <d2p1:Sort>5</d2p1:Sort>
        <d2p1:Subcategories>
          <d2p1:vDealerSubcategory>
            <d2p1:CategoryID>sample string 3</d2p1:CategoryID>
            <d2p1:DealerId>sample string 1</d2p1:DealerId>
            <d2p1:SubcategoryBrands>sample string 7</d2p1:SubcategoryBrands>
            <d2p1:SubcategoryId>sample string 2</d2p1:SubcategoryId>
            <d2p1:SubcategoryImageUrl>sample string 5</d2p1:SubcategoryImageUrl>
            <d2p1:SubcategoryName>sample string 4</d2p1:SubcategoryName>
            <d2p1:SubcategorySort>6</d2p1:SubcategorySort>
          </d2p1:vDealerSubcategory>
          <d2p1:vDealerSubcategory>
            <d2p1:CategoryID>sample string 3</d2p1:CategoryID>
            <d2p1:DealerId>sample string 1</d2p1:DealerId>
            <d2p1:SubcategoryBrands>sample string 7</d2p1:SubcategoryBrands>
            <d2p1:SubcategoryId>sample string 2</d2p1:SubcategoryId>
            <d2p1:SubcategoryImageUrl>sample string 5</d2p1:SubcategoryImageUrl>
            <d2p1:SubcategoryName>sample string 4</d2p1:SubcategoryName>
            <d2p1:SubcategorySort>6</d2p1:SubcategorySort>
          </d2p1:vDealerSubcategory>
        </d2p1:Subcategories>
      </d2p1:vDealerCategory>
    </d2p1:Categories>
    <d2p1:City>sample string 5</d2p1:City>
    <d2p1:Country>sample string 9</d2p1:Country>
    <d2p1:CountryName>sample string 8</d2p1:CountryName>
    <d2p1:DealerBrands>
      <d2p1:vDealerBrand>
        <d2p1:Brand>sample string 2</d2p1:Brand>
        <d2p1:BrandName>sample string 3</d2p1:BrandName>
        <d2p1:DealerId>sample string 1</d2p1:DealerId>
        <d2p1:Displays>4</d2p1:Displays>
        <d2p1:ShowOnConsumerLocator>true</d2p1:ShowOnConsumerLocator>
        <d2p1:ShowOnProfessionalLocator>true</d2p1:ShowOnProfessionalLocator>
      </d2p1:vDealerBrand>
      <d2p1:vDealerBrand>
        <d2p1:Brand>sample string 2</d2p1:Brand>
        <d2p1:BrandName>sample string 3</d2p1:BrandName>
        <d2p1:DealerId>sample string 1</d2p1:DealerId>
        <d2p1:Displays>4</d2p1:Displays>
        <d2p1:ShowOnConsumerLocator>true</d2p1:ShowOnConsumerLocator>
        <d2p1:ShowOnProfessionalLocator>true</d2p1:ShowOnProfessionalLocator>
      </d2p1:vDealerBrand>
    </d2p1:DealerBrands>
    <d2p1:ID>sample string 1</d2p1:ID>
    <d2p1:LeadEmailAddresses>sample string 11</d2p1:LeadEmailAddresses>
    <d2p1:LocatorEligibility>sample string 17</d2p1:LocatorEligibility>
    <d2p1:Name>sample string 2</d2p1:Name>
    <d2p1:Phone>sample string 10</d2p1:Phone>
    <d2p1:ServiceEmail>sample string 12</d2p1:ServiceEmail>
    <d2p1:ServicePhone>sample string 13</d2p1:ServicePhone>
    <d2p1:State>sample string 6</d2p1:State>
    <d2p1:TotalDisplays>1</d2p1:TotalDisplays>
    <d2p1:Website>sample string 14</d2p1:Website>
    <d2p1:Zip>sample string 7</d2p1:Zip>
  </Dealer>
</DealerResponse>