POST request/user/brokerbuyerportal

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
brokerCustomers	Collection of BrokerUploadCustomer	None.
brokersites	Collection of BrokerUploadSite	None.
brokeruser	Collection of BrokerUser	None.

Request Formats

application/json, text/json

Sample:

{
  "brokeruser": [
    {
      "email": "sample string 1",
      "userFirstName": "sample string 2",
      "userLastName": "sample string 3"
    },
    {
      "email": "sample string 1",
      "userFirstName": "sample string 2",
      "userLastName": "sample string 3"
    }
  ],
  "brokerCustomers": [
    {
      "organisationName": "sample string 1",
      "city": "sample string 2",
      "county": "sample string 3",
      "businessType": 64,
      "sicCode": 1,
      "postCode": "sample string 4",
      "primaryContactTitle": "sample string 5",
      "primaryContactFirstName": "sample string 6",
      "primaryContactLastName": "sample string 7",
      "primaryContactEmail": "sample string 8",
      "primaryContactLandline": "sample string 9",
      "registeredNumber": "sample string 10",
      "sicDescription": "sample string 11",
      "vatRate": 1.0
    },
    {
      "organisationName": "sample string 1",
      "city": "sample string 2",
      "county": "sample string 3",
      "businessType": 64,
      "sicCode": 1,
      "postCode": "sample string 4",
      "primaryContactTitle": "sample string 5",
      "primaryContactFirstName": "sample string 6",
      "primaryContactLastName": "sample string 7",
      "primaryContactEmail": "sample string 8",
      "primaryContactLandline": "sample string 9",
      "registeredNumber": "sample string 10",
      "sicDescription": "sample string 11",
      "vatRate": 1.0
    }
  ],
  "brokersites": [
    {
      "organisationName": "sample string 1",
      "fuelType": "sample string 2",
      "postCode": "sample string 3",
      "siteName": "sample string 4",
      "addressLine1": "sample string 5",
      "addressLine2": "sample string 6",
      "city": "sample string 7",
      "county": "sample string 8",
      "supplierName": "sample string 9",
      "mpanOrMPRN": "sample string 10",
      "meterIntelligence": 64,
      "contractEndDate": "sample string 12",
      "elecDayUnitRate": 1.0,
      "standingChargePerDay": 1.0,
      "elecNightUnitRate": 1.0,
      "elecDaykWh": 1,
      "elecNightkWh": 1,
      "elecEveningUnitRate": 1.0,
      "elecEveningkWh": 1,
      "gasAnnualConsumption": 1,
      "gasUnitRate": 1.0
    },
    {
      "organisationName": "sample string 1",
      "fuelType": "sample string 2",
      "postCode": "sample string 3",
      "siteName": "sample string 4",
      "addressLine1": "sample string 5",
      "addressLine2": "sample string 6",
      "city": "sample string 7",
      "county": "sample string 8",
      "supplierName": "sample string 9",
      "mpanOrMPRN": "sample string 10",
      "meterIntelligence": 64,
      "contractEndDate": "sample string 12",
      "elecDayUnitRate": 1.0,
      "standingChargePerDay": 1.0,
      "elecNightUnitRate": 1.0,
      "elecDaykWh": 1,
      "elecNightkWh": 1,
      "elecEveningUnitRate": 1.0,
      "elecEveningkWh": 1,
      "gasAnnualConsumption": 1,
      "gasUnitRate": 1.0
    }
  ]
}

text/html

Sample:

{"brokeruser":[{"email":"sample string 1","userFirstName":"sample string 2","userLastName":"sample string 3"},{"email":"sample string 1","userFirstName":"sample string 2","userLastName":"sample string 3"}],"brokerCustomers":[{"organisationName":"sample string 1","city":"sample string 2","county":"sample string 3","businessType":64,"sicCode":1,"postCode":"sample string 4","primaryContactTitle":"sample string 5","primaryContactFirstName":"sample string 6","primaryContactLastName":"sample string 7","primaryContactEmail":"sample string 8","primaryContactLandline":"sample string 9","registeredNumber":"sample string 10","sicDescription":"sample string 11","vatRate":1.0},{"organisationName":"sample string 1","city":"sample string 2","county":"sample string 3","businessType":64,"sicCode":1,"postCode":"sample string 4","primaryContactTitle":"sample string 5","primaryContactFirstName":"sample string 6","primaryContactLastName":"sample string 7","primaryContactEmail":"sample string 8","primaryContactLandline":"sample string 9","registeredNumber":"sample string 10","sicDescription":"sample string 11","vatRate":1.0}],"brokersites":[{"organisationName":"sample string 1","fuelType":"sample string 2","postCode":"sample string 3","siteName":"sample string 4","addressLine1":"sample string 5","addressLine2":"sample string 6","city":"sample string 7","county":"sample string 8","supplierName":"sample string 9","mpanOrMPRN":"sample string 10","meterIntelligence":64,"contractEndDate":"sample string 12","elecDayUnitRate":1.0,"standingChargePerDay":1.0,"elecNightUnitRate":1.0,"elecDaykWh":1,"elecNightkWh":1,"elecEveningUnitRate":1.0,"elecEveningkWh":1,"gasAnnualConsumption":1,"gasUnitRate":1.0},{"organisationName":"sample string 1","fuelType":"sample string 2","postCode":"sample string 3","siteName":"sample string 4","addressLine1":"sample string 5","addressLine2":"sample string 6","city":"sample string 7","county":"sample string 8","supplierName":"sample string 9","mpanOrMPRN":"sample string 10","meterIntelligence":64,"contractEndDate":"sample string 12","elecDayUnitRate":1.0,"standingChargePerDay":1.0,"elecNightUnitRate":1.0,"elecDaykWh":1,"elecNightkWh":1,"elecEveningUnitRate":1.0,"elecEveningkWh":1,"gasAnnualConsumption":1,"gasUnitRate":1.0}]}

application/xml, text/xml

Sample:

<BrokerBuyerUpload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.CustomerDto">
  <brokerCustomers>
    <BrokerUploadCustomer>
      <BusinessType>64</BusinessType>
      <City>sample string 2</City>
      <County>sample string 3</County>
      <OrganisationName>sample string 1</OrganisationName>
      <PostCode>sample string 4</PostCode>
      <PrimaryContactEmail>sample string 8</PrimaryContactEmail>
      <PrimaryContactFirstName>sample string 6</PrimaryContactFirstName>
      <PrimaryContactLandline>sample string 9</PrimaryContactLandline>
      <PrimaryContactLastName>sample string 7</PrimaryContactLastName>
      <PrimaryContactTitle>sample string 5</PrimaryContactTitle>
      <RegisteredNumber>sample string 10</RegisteredNumber>
      <SICCode>1</SICCode>
      <SicDescription>sample string 11</SicDescription>
      <VatRate>1</VatRate>
    </BrokerUploadCustomer>
    <BrokerUploadCustomer>
      <BusinessType>64</BusinessType>
      <City>sample string 2</City>
      <County>sample string 3</County>
      <OrganisationName>sample string 1</OrganisationName>
      <PostCode>sample string 4</PostCode>
      <PrimaryContactEmail>sample string 8</PrimaryContactEmail>
      <PrimaryContactFirstName>sample string 6</PrimaryContactFirstName>
      <PrimaryContactLandline>sample string 9</PrimaryContactLandline>
      <PrimaryContactLastName>sample string 7</PrimaryContactLastName>
      <PrimaryContactTitle>sample string 5</PrimaryContactTitle>
      <RegisteredNumber>sample string 10</RegisteredNumber>
      <SICCode>1</SICCode>
      <SicDescription>sample string 11</SicDescription>
      <VatRate>1</VatRate>
    </BrokerUploadCustomer>
  </brokerCustomers>
  <brokersites>
    <BrokerUploadSite>
      <AddressLine1>sample string 5</AddressLine1>
      <AddressLine2>sample string 6</AddressLine2>
      <City>sample string 7</City>
      <ContractEndDate>sample string 12</ContractEndDate>
      <County>sample string 8</County>
      <ElecDayUnitRate>1</ElecDayUnitRate>
      <ElecDaykWh>1</ElecDaykWh>
      <ElecEveningUnitRate>1</ElecEveningUnitRate>
      <ElecEveningkWh>1</ElecEveningkWh>
      <ElecNightUnitRate>1</ElecNightUnitRate>
      <ElecNightkWh>1</ElecNightkWh>
      <FuelType>sample string 2</FuelType>
      <GasAnnualConsumption>1</GasAnnualConsumption>
      <GasUnitRate>1</GasUnitRate>
      <MPANOrMPRN>sample string 10</MPANOrMPRN>
      <MeterIntelligence>64</MeterIntelligence>
      <OrganisationName>sample string 1</OrganisationName>
      <PostCode>sample string 3</PostCode>
      <SiteName>sample string 4</SiteName>
      <StandingChargePerDay>1</StandingChargePerDay>
      <SupplierName>sample string 9</SupplierName>
    </BrokerUploadSite>
    <BrokerUploadSite>
      <AddressLine1>sample string 5</AddressLine1>
      <AddressLine2>sample string 6</AddressLine2>
      <City>sample string 7</City>
      <ContractEndDate>sample string 12</ContractEndDate>
      <County>sample string 8</County>
      <ElecDayUnitRate>1</ElecDayUnitRate>
      <ElecDaykWh>1</ElecDaykWh>
      <ElecEveningUnitRate>1</ElecEveningUnitRate>
      <ElecEveningkWh>1</ElecEveningkWh>
      <ElecNightUnitRate>1</ElecNightUnitRate>
      <ElecNightkWh>1</ElecNightkWh>
      <FuelType>sample string 2</FuelType>
      <GasAnnualConsumption>1</GasAnnualConsumption>
      <GasUnitRate>1</GasUnitRate>
      <MPANOrMPRN>sample string 10</MPANOrMPRN>
      <MeterIntelligence>64</MeterIntelligence>
      <OrganisationName>sample string 1</OrganisationName>
      <PostCode>sample string 3</PostCode>
      <SiteName>sample string 4</SiteName>
      <StandingChargePerDay>1</StandingChargePerDay>
      <SupplierName>sample string 9</SupplierName>
    </BrokerUploadSite>
  </brokersites>
  <brokeruser>
    <BrokerUser>
      <Email>sample string 1</Email>
      <UserFirstName>sample string 2</UserFirstName>
      <UserLastName>sample string 3</UserLastName>
    </BrokerUser>
    <BrokerUser>
      <Email>sample string 1</Email>
      <UserFirstName>sample string 2</UserFirstName>
      <UserLastName>sample string 3</UserLastName>
    </BrokerUser>
  </brokeruser>
</BrokerBuyerUpload>

Response Information

Resource Description

Collection of string

Response Formats

application/json, text/json

Sample:

[
  "sample string 1",
  "sample string 2"
]

text/html

Sample:

["sample string 1","sample string 2"]

application/xml, text/xml

Sample:

<ArrayOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <string>sample string 1</string>
  <string>sample string 2</string>
</ArrayOfstring>