GET api/Syndication/GetSyndicationAccounts

Add or update a syndication dealer account. Authorization required.

Request Information

URI Parameters

None.

Body Parameters

RequestGetSyndicationAccounts
NameDescriptionTypeAdditional information
DealerIds

List of DealerIds applicable to current MyHHT syndication registration page

Collection of string

None.

Request Formats

application/json, text/json

Sample:
{
  "DealerIds": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<RequestGetSyndicationAccounts xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/data.hearthnhome.Models.Syndication.Request">
  <DealerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </DealerIds>
</RequestGetSyndicationAccounts>

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

Response Information

Resource Description

ResponseGetSyndicationAccounts
NameDescriptionTypeAdditional information
SyndicationAccounts

Collection of syndication accounts requested

Collection of RegisteredSyndicationAccount

None.

CurrentTermsAndConditions

Current terms and conditions for UI presentation and acceptance

string

None.

Success

boolean

None.

Message

string

None.

Response Formats

application/json, text/json

Sample:
{
  "SyndicationAccounts": [
    {
      "DealerId": "sample string 1",
      "Email": "sample string 2",
      "Name": "sample string 3",
      "Domain": "sample string 4",
      "TermsAccepted": true
    },
    {
      "DealerId": "sample string 1",
      "Email": "sample string 2",
      "Name": "sample string 3",
      "Domain": "sample string 4",
      "TermsAccepted": true
    }
  ],
  "CurrentTermsAndConditions": "sample string 1",
  "Success": true,
  "Message": "sample string 3"
}

application/xml, text/xml

Sample:
<ResponseGetSyndicationAccounts xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/data.hearthnhome.Models.Syndication.Response">
  <Message>sample string 3</Message>
  <Success>true</Success>
  <CurrentTermsAndConditions>sample string 1</CurrentTermsAndConditions>
  <SyndicationAccounts>
    <RegisteredSyndicationAccount>
      <DealerId>sample string 1</DealerId>
      <Domain>sample string 4</Domain>
      <Email>sample string 2</Email>
      <Name>sample string 3</Name>
      <TermsAccepted>true</TermsAccepted>
    </RegisteredSyndicationAccount>
    <RegisteredSyndicationAccount>
      <DealerId>sample string 1</DealerId>
      <Domain>sample string 4</Domain>
      <Email>sample string 2</Email>
      <Name>sample string 3</Name>
      <TermsAccepted>true</TermsAccepted>
    </RegisteredSyndicationAccount>
  </SyndicationAccounts>
</ResponseGetSyndicationAccounts>