GET request/admin/brand/all

Displays all the Brand Details

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of BrandAllView

Name	Description	Type	Additional information
brandDetail		BrandDetail	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "brandDetail": {
      "brandName": "sample string 1",
      "registerAddress": {
        "line1": "sample string 1",
        "line2": "sample string 2",
        "city": "sample string 3",
        "county": "sample string 4",
        "postcode": "sample string 5"
      },
      "postalAddress": {
        "line1": "sample string 1",
        "line2": "sample string 2",
        "city": "sample string 3",
        "county": "sample string 4",
        "postcode": "sample string 5"
      },
      "billingAddress": {
        "line1": "sample string 1",
        "line2": "sample string 2",
        "city": "sample string 3",
        "county": "sample string 4",
        "postcode": "sample string 5"
      },
      "brokerCode": "sample string 2",
      "agentReference": "sample string 3",
      "aggregator": true,
      "tier": 64,
      "isCommissionPercentage": true,
      "instantCommissionPercentage": 1.0,
      "bespokeCommissionPercentage": 1.0,
      "isEnergyQuoteAllowed": true,
      "isBespokeQuoteAllowed": true,
      "isDcdaQuoteAllowed": true,
      "leadPartnerId": 1,
      "leadPartnerName": "sample string 9"
    }
  },
  {
    "brandDetail": {
      "brandName": "sample string 1",
      "registerAddress": {
        "line1": "sample string 1",
        "line2": "sample string 2",
        "city": "sample string 3",
        "county": "sample string 4",
        "postcode": "sample string 5"
      },
      "postalAddress": {
        "line1": "sample string 1",
        "line2": "sample string 2",
        "city": "sample string 3",
        "county": "sample string 4",
        "postcode": "sample string 5"
      },
      "billingAddress": {
        "line1": "sample string 1",
        "line2": "sample string 2",
        "city": "sample string 3",
        "county": "sample string 4",
        "postcode": "sample string 5"
      },
      "brokerCode": "sample string 2",
      "agentReference": "sample string 3",
      "aggregator": true,
      "tier": 64,
      "isCommissionPercentage": true,
      "instantCommissionPercentage": 1.0,
      "bespokeCommissionPercentage": 1.0,
      "isEnergyQuoteAllowed": true,
      "isBespokeQuoteAllowed": true,
      "isDcdaQuoteAllowed": true,
      "leadPartnerId": 1,
      "leadPartnerName": "sample string 9"
    }
  }
]

text/html

Sample:

[{"brandDetail":{"brandName":"sample string 1","registerAddress":{"line1":"sample string 1","line2":"sample string 2","city":"sample string 3","county":"sample string 4","postcode":"sample string 5"},"postalAddress":{"line1":"sample string 1","line2":"sample string 2","city":"sample string 3","county":"sample string 4","postcode":"sample string 5"},"billingAddress":{"line1":"sample string 1","line2":"sample string 2","city":"sample string 3","county":"sample string 4","postcode":"sample string 5"},"brokerCode":"sample string 2","agentReference":"sample string 3","aggregator":true,"tier":64,"isCommissionPercentage":true,"instantCommissionPercentage":1.0,"bespokeCommissionPercentage":1.0,"isEnergyQuoteAllowed":true,"isBespokeQuoteAllowed":true,"isDcdaQuoteAllowed":true,"leadPartnerId":1,"leadPartnerName":"sample string 9"}},{"brandDetail":{"brandName":"sample string 1","registerAddress":{"line1":"sample string 1","line2":"sample string 2","city":"sample string 3","county":"sample string 4","postcode":"sample string 5"},"postalAddress":{"line1":"sample string 1","line2":"sample string 2","city":"sample string 3","county":"sample string 4","postcode":"sample string 5"},"billingAddress":{"line1":"sample string 1","line2":"sample string 2","city":"sample string 3","county":"sample string 4","postcode":"sample string 5"},"brokerCode":"sample string 2","agentReference":"sample string 3","aggregator":true,"tier":64,"isCommissionPercentage":true,"instantCommissionPercentage":1.0,"bespokeCommissionPercentage":1.0,"isEnergyQuoteAllowed":true,"isBespokeQuoteAllowed":true,"isDcdaQuoteAllowed":true,"leadPartnerId":1,"leadPartnerName":"sample string 9"}}]

application/xml, text/xml

Sample:

<ArrayOfBrandAllView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CCSCommercialAPI.Models.Admin">
  <BrandAllView>
    <brandDetail>
      <AgentReference>sample string 3</AgentReference>
      <Aggregator>true</Aggregator>
      <BespokeCommissionPercentage>1</BespokeCommissionPercentage>
      <BillingAddress>
        <City>sample string 3</City>
        <County>sample string 4</County>
        <Line1>sample string 1</Line1>
        <Line2>sample string 2</Line2>
        <Postcode>sample string 5</Postcode>
      </BillingAddress>
      <BrandName>sample string 1</BrandName>
      <BrokerCode>sample string 2</BrokerCode>
      <InstantCommissionPercentage>1</InstantCommissionPercentage>
      <IsBespokeQuoteAllowed>true</IsBespokeQuoteAllowed>
      <IsCommissionPercentage>true</IsCommissionPercentage>
      <IsDcdaQuoteAllowed>true</IsDcdaQuoteAllowed>
      <IsEnergyQuoteAllowed>true</IsEnergyQuoteAllowed>
      <LeadPartnerId>1</LeadPartnerId>
      <LeadPartnerName>sample string 9</LeadPartnerName>
      <PostalAddress>
        <City>sample string 3</City>
        <County>sample string 4</County>
        <Line1>sample string 1</Line1>
        <Line2>sample string 2</Line2>
        <Postcode>sample string 5</Postcode>
      </PostalAddress>
      <RegisterAddress>
        <City>sample string 3</City>
        <County>sample string 4</County>
        <Line1>sample string 1</Line1>
        <Line2>sample string 2</Line2>
        <Postcode>sample string 5</Postcode>
      </RegisterAddress>
      <Tier>64</Tier>
    </brandDetail>
  </BrandAllView>
  <BrandAllView>
    <brandDetail>
      <AgentReference>sample string 3</AgentReference>
      <Aggregator>true</Aggregator>
      <BespokeCommissionPercentage>1</BespokeCommissionPercentage>
      <BillingAddress>
        <City>sample string 3</City>
        <County>sample string 4</County>
        <Line1>sample string 1</Line1>
        <Line2>sample string 2</Line2>
        <Postcode>sample string 5</Postcode>
      </BillingAddress>
      <BrandName>sample string 1</BrandName>
      <BrokerCode>sample string 2</BrokerCode>
      <InstantCommissionPercentage>1</InstantCommissionPercentage>
      <IsBespokeQuoteAllowed>true</IsBespokeQuoteAllowed>
      <IsCommissionPercentage>true</IsCommissionPercentage>
      <IsDcdaQuoteAllowed>true</IsDcdaQuoteAllowed>
      <IsEnergyQuoteAllowed>true</IsEnergyQuoteAllowed>
      <LeadPartnerId>1</LeadPartnerId>
      <LeadPartnerName>sample string 9</LeadPartnerName>
      <PostalAddress>
        <City>sample string 3</City>
        <County>sample string 4</County>
        <Line1>sample string 1</Line1>
        <Line2>sample string 2</Line2>
        <Postcode>sample string 5</Postcode>
      </PostalAddress>
      <RegisterAddress>
        <City>sample string 3</City>
        <County>sample string 4</County>
        <Line1>sample string 1</Line1>
        <Line2>sample string 2</Line2>
        <Postcode>sample string 5</Postcode>
      </RegisterAddress>
      <Tier>64</Tier>
    </brandDetail>
  </BrandAllView>
</ArrayOfBrandAllView>