GET request/user/currentuser/brand
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
BrandDetailView| Name | Description | Type | Additional information |
|---|---|---|---|
| BespokeCommissionPercentage | decimal number |
None. |
|
| BillingAddress | BandAddressInfo |
None. |
|
| BrandElecCommission | decimal number |
None. |
|
| BrandGasCommission | decimal number |
None. |
|
| BrandId | integer |
None. |
|
| BrandName | string |
None. |
|
| BrokerCode | string |
None. |
|
| InstantCommissionPercentage | decimal number |
None. |
|
| IsBespokeQuoteAllowed | boolean |
None. |
|
| IsCommissionPercentage | boolean |
None. |
|
| IsDcdaQuoteAllowed | boolean |
None. |
|
| IsEnergyQuoteAllowed | boolean |
None. |
|
| LandLine | string |
None. |
|
| LeadPartnerId | integer |
None. |
|
| LeadPartnerName | string |
None. |
|
| MobileNumber | string |
None. |
|
| MUGElecCommission | decimal number |
None. |
|
| MUGGasCommission | decimal number |
None. |
|
| PostalAddress | BandAddressInfo |
None. |
|
| RegisterAddress | BandAddressInfo |
None. |
|
| Tier | byte |
None. |
Response Formats
application/json, text/json
Sample:
{
"brandId": 1,
"landLine": "sample string 2",
"mobileNumber": "sample string 3",
"brandName": "sample string 4",
"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 5",
"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 10"
}
text/html
Sample:
{"brandId":1,"landLine":"sample string 2","mobileNumber":"sample string 3","brandName":"sample string 4","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 5","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 10"}
application/xml, text/xml
Sample:
<BrandDetailView xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.BrandDto">
<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 4</BrandName>
<BrokerCode>sample string 5</BrokerCode>
<InstantCommissionPercentage>1</InstantCommissionPercentage>
<IsBespokeQuoteAllowed>true</IsBespokeQuoteAllowed>
<IsCommissionPercentage>true</IsCommissionPercentage>
<IsDcdaQuoteAllowed>true</IsDcdaQuoteAllowed>
<IsEnergyQuoteAllowed>true</IsEnergyQuoteAllowed>
<LeadPartnerId>1</LeadPartnerId>
<LeadPartnerName>sample string 10</LeadPartnerName>
<MUGElecCommission>1</MUGElecCommission>
<MUGGasCommission>1</MUGGasCommission>
<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>
<LandLine>sample string 2</LandLine>
<MobileNumber>sample string 3</MobileNumber>
</BrandDetailView>