GET request/admin/brand/{id}

Displays any particular Brand Details

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

BrandView

Name	Type	Additional information
brandDetail	BrandDetailView	None.
Channels	Collection of integer	None.
CommissionTerms	CommissionTerm	None.
CommissionTypeId	integer	None.
FlatFee	FlatFeeList	None.
Uplift	Collection of UpliftCommission	None.

Response Formats

application/json, text/json

Sample:

{
  "brandDetail": {
    "brandId": 1,
    "brandName": "sample string 2",
    "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 3",
    "agentReference": "sample string 4",
    "aggregator": true,
    "tier": 64,
    "isCommissionPercentage": true,
    "instantCommissionPercentage": 1.0,
    "bespokeCommissionPercentage": 1.0,
    "isEnergyQuoteAllowed": true,
    "isBespokeQuoteAllowed": true,
    "isDcdaQuoteAllowed": true,
    "leadPartnerId": 1,
    "leadPartnerName": "sample string 10"
  },
  "channels": [
    1,
    2
  ],
  "flatFee": {
    "electricity": [
      {
        "contractTermId": 1,
        "contractTermDescription": "sample string 2",
        "profileCodeId": 3,
        "profileCodeDescription": "sample string 4",
        "bands": [
          {
            "configurationId": 1,
            "bandId": 1,
            "bandDescription": "sample string 2",
            "bandRange": "sample string 3",
            "fee": 4.0
          },
          {
            "configurationId": 1,
            "bandId": 1,
            "bandDescription": "sample string 2",
            "bandRange": "sample string 3",
            "fee": 4.0
          }
        ]
      },
      {
        "contractTermId": 1,
        "contractTermDescription": "sample string 2",
        "profileCodeId": 3,
        "profileCodeDescription": "sample string 4",
        "bands": [
          {
            "configurationId": 1,
            "bandId": 1,
            "bandDescription": "sample string 2",
            "bandRange": "sample string 3",
            "fee": 4.0
          },
          {
            "configurationId": 1,
            "bandId": 1,
            "bandDescription": "sample string 2",
            "bandRange": "sample string 3",
            "fee": 4.0
          }
        ]
      }
    ],
    "gas": [
      {
        "contractTermId": 1,
        "contractTermDescription": "sample string 2",
        "profileCodeId": 3,
        "profileCodeDescription": "sample string 4",
        "bands": [
          {
            "configurationId": 1,
            "bandId": 1,
            "bandDescription": "sample string 2",
            "bandRange": "sample string 3",
            "fee": 4.0
          },
          {
            "configurationId": 1,
            "bandId": 1,
            "bandDescription": "sample string 2",
            "bandRange": "sample string 3",
            "fee": 4.0
          }
        ]
      },
      {
        "contractTermId": 1,
        "contractTermDescription": "sample string 2",
        "profileCodeId": 3,
        "profileCodeDescription": "sample string 4",
        "bands": [
          {
            "configurationId": 1,
            "bandId": 1,
            "bandDescription": "sample string 2",
            "bandRange": "sample string 3",
            "fee": 4.0
          },
          {
            "configurationId": 1,
            "bandId": 1,
            "bandDescription": "sample string 2",
            "bandRange": "sample string 3",
            "fee": 4.0
          }
        ]
      }
    ]
  },
  "commissionTypeId": 1,
  "uplift": [
    {
      "configurationId": 1,
      "contractTermId": 1,
      "contractTermDescription": "sample string 2",
      "cap": 3.0
    },
    {
      "configurationId": 1,
      "contractTermId": 1,
      "contractTermDescription": "sample string 2",
      "cap": 3.0
    }
  ],
  "commissionTerms": {
    "paymentTermId": 1,
    "numberOfDays": 1,
    "startPercentage": 1.0,
    "endPercentage": 1.0
  }
}

text/html

Sample:

{"brandDetail":{"brandId":1,"brandName":"sample string 2","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 3","agentReference":"sample string 4","aggregator":true,"tier":64,"isCommissionPercentage":true,"instantCommissionPercentage":1.0,"bespokeCommissionPercentage":1.0,"isEnergyQuoteAllowed":true,"isBespokeQuoteAllowed":true,"isDcdaQuoteAllowed":true,"leadPartnerId":1,"leadPartnerName":"sample string 10"},"channels":[1,2],"flatFee":{"electricity":[{"contractTermId":1,"contractTermDescription":"sample string 2","profileCodeId":3,"profileCodeDescription":"sample string 4","bands":[{"configurationId":1,"bandId":1,"bandDescription":"sample string 2","bandRange":"sample string 3","fee":4.0},{"configurationId":1,"bandId":1,"bandDescription":"sample string 2","bandRange":"sample string 3","fee":4.0}]},{"contractTermId":1,"contractTermDescription":"sample string 2","profileCodeId":3,"profileCodeDescription":"sample string 4","bands":[{"configurationId":1,"bandId":1,"bandDescription":"sample string 2","bandRange":"sample string 3","fee":4.0},{"configurationId":1,"bandId":1,"bandDescription":"sample string 2","bandRange":"sample string 3","fee":4.0}]}],"gas":[{"contractTermId":1,"contractTermDescription":"sample string 2","profileCodeId":3,"profileCodeDescription":"sample string 4","bands":[{"configurationId":1,"bandId":1,"bandDescription":"sample string 2","bandRange":"sample string 3","fee":4.0},{"configurationId":1,"bandId":1,"bandDescription":"sample string 2","bandRange":"sample string 3","fee":4.0}]},{"contractTermId":1,"contractTermDescription":"sample string 2","profileCodeId":3,"profileCodeDescription":"sample string 4","bands":[{"configurationId":1,"bandId":1,"bandDescription":"sample string 2","bandRange":"sample string 3","fee":4.0},{"configurationId":1,"bandId":1,"bandDescription":"sample string 2","bandRange":"sample string 3","fee":4.0}]}]},"commissionTypeId":1,"uplift":[{"configurationId":1,"contractTermId":1,"contractTermDescription":"sample string 2","cap":3.0},{"configurationId":1,"contractTermId":1,"contractTermDescription":"sample string 2","cap":3.0}],"commissionTerms":{"paymentTermId":1,"numberOfDays":1,"startPercentage":1.0,"endPercentage":1.0}}

application/xml, text/xml

Sample:

<BrandView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CCSCommercialAPI.Models.Admin">
  <Channels xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>1</d2p1:long>
    <d2p1:long>2</d2p1:long>
  </Channels>
  <CommissionTerms>
    <EndPercentage>1</EndPercentage>
    <NumberOfDays>1</NumberOfDays>
    <PaymentTermId>1</PaymentTermId>
    <StartPercentage>1</StartPercentage>
  </CommissionTerms>
  <CommissionTypeId>1</CommissionTypeId>
  <FlatFee>
    <Electricity>
      <FlatFeeCommission>
        <Bands>
          <BandCommission>
            <BandDescription>sample string 2</BandDescription>
            <BandId>1</BandId>
            <BandRange>sample string 3</BandRange>
            <ConfigurationId>1</ConfigurationId>
            <Fee>4</Fee>
          </BandCommission>
          <BandCommission>
            <BandDescription>sample string 2</BandDescription>
            <BandId>1</BandId>
            <BandRange>sample string 3</BandRange>
            <ConfigurationId>1</ConfigurationId>
            <Fee>4</Fee>
          </BandCommission>
        </Bands>
        <ContractTermDescription>sample string 2</ContractTermDescription>
        <ContractTermId>1</ContractTermId>
        <ProfileCodeDescription>sample string 4</ProfileCodeDescription>
        <ProfileCodeId>3</ProfileCodeId>
      </FlatFeeCommission>
      <FlatFeeCommission>
        <Bands>
          <BandCommission>
            <BandDescription>sample string 2</BandDescription>
            <BandId>1</BandId>
            <BandRange>sample string 3</BandRange>
            <ConfigurationId>1</ConfigurationId>
            <Fee>4</Fee>
          </BandCommission>
          <BandCommission>
            <BandDescription>sample string 2</BandDescription>
            <BandId>1</BandId>
            <BandRange>sample string 3</BandRange>
            <ConfigurationId>1</ConfigurationId>
            <Fee>4</Fee>
          </BandCommission>
        </Bands>
        <ContractTermDescription>sample string 2</ContractTermDescription>
        <ContractTermId>1</ContractTermId>
        <ProfileCodeDescription>sample string 4</ProfileCodeDescription>
        <ProfileCodeId>3</ProfileCodeId>
      </FlatFeeCommission>
    </Electricity>
    <Gas>
      <FlatFeeCommission>
        <Bands>
          <BandCommission>
            <BandDescription>sample string 2</BandDescription>
            <BandId>1</BandId>
            <BandRange>sample string 3</BandRange>
            <ConfigurationId>1</ConfigurationId>
            <Fee>4</Fee>
          </BandCommission>
          <BandCommission>
            <BandDescription>sample string 2</BandDescription>
            <BandId>1</BandId>
            <BandRange>sample string 3</BandRange>
            <ConfigurationId>1</ConfigurationId>
            <Fee>4</Fee>
          </BandCommission>
        </Bands>
        <ContractTermDescription>sample string 2</ContractTermDescription>
        <ContractTermId>1</ContractTermId>
        <ProfileCodeDescription>sample string 4</ProfileCodeDescription>
        <ProfileCodeId>3</ProfileCodeId>
      </FlatFeeCommission>
      <FlatFeeCommission>
        <Bands>
          <BandCommission>
            <BandDescription>sample string 2</BandDescription>
            <BandId>1</BandId>
            <BandRange>sample string 3</BandRange>
            <ConfigurationId>1</ConfigurationId>
            <Fee>4</Fee>
          </BandCommission>
          <BandCommission>
            <BandDescription>sample string 2</BandDescription>
            <BandId>1</BandId>
            <BandRange>sample string 3</BandRange>
            <ConfigurationId>1</ConfigurationId>
            <Fee>4</Fee>
          </BandCommission>
        </Bands>
        <ContractTermDescription>sample string 2</ContractTermDescription>
        <ContractTermId>1</ContractTermId>
        <ProfileCodeDescription>sample string 4</ProfileCodeDescription>
        <ProfileCodeId>3</ProfileCodeId>
      </FlatFeeCommission>
    </Gas>
  </FlatFee>
  <Uplift>
    <UpliftCommission>
      <Cap>3</Cap>
      <ConfigurationId>1</ConfigurationId>
      <ContractTermDescription>sample string 2</ContractTermDescription>
      <ContractTermId>1</ContractTermId>
    </UpliftCommission>
    <UpliftCommission>
      <Cap>3</Cap>
      <ConfigurationId>1</ConfigurationId>
      <ContractTermDescription>sample string 2</ContractTermDescription>
      <ContractTermId>1</ContractTermId>
    </UpliftCommission>
  </Uplift>
  <brandDetail>
    <AgentReference>sample string 4</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 2</BrandName>
    <BrokerCode>sample string 3</BrokerCode>
    <InstantCommissionPercentage>1</InstantCommissionPercentage>
    <IsBespokeQuoteAllowed>true</IsBespokeQuoteAllowed>
    <IsCommissionPercentage>true</IsCommissionPercentage>
    <IsDcdaQuoteAllowed>true</IsDcdaQuoteAllowed>
    <IsEnergyQuoteAllowed>true</IsEnergyQuoteAllowed>
    <LeadPartnerId>1</LeadPartnerId>
    <LeadPartnerName>sample string 10</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>
    <BrandId>1</BrandId>
  </brandDetail>
</BrandView>