GET request/user/currentuser/brand

Gets brand information for the currently logged-in user.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

BrandDetailWithMug
NameDescriptionTypeAdditional information
brandDetailView

BrandDetailView

None.

mugDetailView

BrandDetailView

None.

Response Formats

application/json, text/json

Sample:
{
  "brandDetailView": {
    "brandId": 1,
    "brandName": "sample string 2",
    "brandRegistrationNumber": "sample string 3",
    "landline": "sample string 4",
    "mobileNumber": "sample string 5",
    "email": "sample string 6",
    "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 7",
    "tier": 64,
    "isCommissionPercentage": true,
    "mugGasCommission": 1.0,
    "mugElecCommission": 1.0,
    "brandElecCommission": 1.0,
    "brandGasCommission": 1.0,
    "instantCommissionPercentage": 1.0,
    "bespokeCommissionPercentage": 1.0,
    "isEnergyQuoteAllowed": true,
    "isBespokeQuoteAllowed": true,
    "isDcdaQuoteAllowed": true,
    "leadPartnerId": 1,
    "leadPartnerName": "sample string 12"
  },
  "mugDetailView": {
    "brandId": 1,
    "brandName": "sample string 2",
    "brandRegistrationNumber": "sample string 3",
    "landline": "sample string 4",
    "mobileNumber": "sample string 5",
    "email": "sample string 6",
    "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 7",
    "tier": 64,
    "isCommissionPercentage": true,
    "mugGasCommission": 1.0,
    "mugElecCommission": 1.0,
    "brandElecCommission": 1.0,
    "brandGasCommission": 1.0,
    "instantCommissionPercentage": 1.0,
    "bespokeCommissionPercentage": 1.0,
    "isEnergyQuoteAllowed": true,
    "isBespokeQuoteAllowed": true,
    "isDcdaQuoteAllowed": true,
    "leadPartnerId": 1,
    "leadPartnerName": "sample string 12"
  }
}

text/html

Sample:
{"brandDetailView":{"brandId":1,"brandName":"sample string 2","brandRegistrationNumber":"sample string 3","landline":"sample string 4","mobileNumber":"sample string 5","email":"sample string 6","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 7","tier":64,"isCommissionPercentage":true,"mugGasCommission":1.0,"mugElecCommission":1.0,"brandElecCommission":1.0,"brandGasCommission":1.0,"instantCommissionPercentage":1.0,"bespokeCommissionPercentage":1.0,"isEnergyQuoteAllowed":true,"isBespokeQuoteAllowed":true,"isDcdaQuoteAllowed":true,"leadPartnerId":1,"leadPartnerName":"sample string 12"},"mugDetailView":{"brandId":1,"brandName":"sample string 2","brandRegistrationNumber":"sample string 3","landline":"sample string 4","mobileNumber":"sample string 5","email":"sample string 6","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 7","tier":64,"isCommissionPercentage":true,"mugGasCommission":1.0,"mugElecCommission":1.0,"brandElecCommission":1.0,"brandGasCommission":1.0,"instantCommissionPercentage":1.0,"bespokeCommissionPercentage":1.0,"isEnergyQuoteAllowed":true,"isBespokeQuoteAllowed":true,"isDcdaQuoteAllowed":true,"leadPartnerId":1,"leadPartnerName":"sample string 12"}}

application/xml, text/xml

Sample:
<BrandDetailWithMug xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.BrandDto">
  <brandDetailView>
    <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>
    <BrandElecCommission>1</BrandElecCommission>
    <BrandGasCommission>1</BrandGasCommission>
    <BrandId>0</BrandId>
    <BrandName>sample string 2</BrandName>
    <BrandRegistrationNumber>sample string 3</BrandRegistrationNumber>
    <BrokerCode>sample string 7</BrokerCode>
    <Email>sample string 6</Email>
    <InstantCommissionPercentage>1</InstantCommissionPercentage>
    <IsBespokeQuoteAllowed>true</IsBespokeQuoteAllowed>
    <IsCommissionPercentage>true</IsCommissionPercentage>
    <IsDcdaQuoteAllowed>true</IsDcdaQuoteAllowed>
    <IsEnergyQuoteAllowed>true</IsEnergyQuoteAllowed>
    <Landline>sample string 4</Landline>
    <LeadPartnerId>1</LeadPartnerId>
    <LeadPartnerName>sample string 12</LeadPartnerName>
    <MUGElecCommission>1</MUGElecCommission>
    <MUGGasCommission>1</MUGGasCommission>
    <MobileNumber>sample string 5</MobileNumber>
    <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>
  </brandDetailView>
  <mugDetailView>
    <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>
    <BrandElecCommission>1</BrandElecCommission>
    <BrandGasCommission>1</BrandGasCommission>
    <BrandId>0</BrandId>
    <BrandName>sample string 2</BrandName>
    <BrandRegistrationNumber>sample string 3</BrandRegistrationNumber>
    <BrokerCode>sample string 7</BrokerCode>
    <Email>sample string 6</Email>
    <InstantCommissionPercentage>1</InstantCommissionPercentage>
    <IsBespokeQuoteAllowed>true</IsBespokeQuoteAllowed>
    <IsCommissionPercentage>true</IsCommissionPercentage>
    <IsDcdaQuoteAllowed>true</IsDcdaQuoteAllowed>
    <IsEnergyQuoteAllowed>true</IsEnergyQuoteAllowed>
    <Landline>sample string 4</Landline>
    <LeadPartnerId>1</LeadPartnerId>
    <LeadPartnerName>sample string 12</LeadPartnerName>
    <MUGElecCommission>1</MUGElecCommission>
    <MUGGasCommission>1</MUGGasCommission>
    <MobileNumber>sample string 5</MobileNumber>
    <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>
  </mugDetailView>
</BrandDetailWithMug>