POST request/Suppliers

Returns energy suppliers applicable on the type of quote being rendered through ‘Switch Request’ and the consumer’s current payment method captured

Request Information

URI Parameters

None.

Body Parameters

The supplier(s) filter.

SuppliersBindingModel

Name	Type	Additional information
CurrentPayMethod	PayMethod	Required
Economy7Percentage	decimal number	Required Range: inclusive between 0 and 100
Postcode	string	Required Data type: PostalCode
SwitchType	SwitchType	Required

Request Formats

application/json, text/json

Sample:

{
  "postcode": "sample string 1",
  "switchType": "DualConsolidatedToDualConsolidated",
  "currentPayMethod": "MonthlyDirectDebit",
  "economy7Percentage": 2.0
}

application/xml, text/xml

Sample:

<SuppliersBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Domain.Default.BindingModel">
  <CurrentPayMethod>MonthlyDirectDebit</CurrentPayMethod>
  <Economy7Percentage>2</Economy7Percentage>
  <Postcode>sample string 1</Postcode>
  <SwitchType>DualConsolidatedToDualConsolidated</SwitchType>
</SuppliersBindingModel>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Postcode"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SwitchType"

DualConsolidatedToDualConsolidated
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="CurrentPayMethod"

MonthlyDirectDebit
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Economy7Percentage"

2
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

SampleSuppliersDtoResponse

Name	Type	Additional information
ApiVersion	string	None.
SuppliersDto	SuppliersDto	None.
Uri	string	None.

Response Formats

application/json, text/json

Sample:

{
  "apiVersion": "sample string 1",
  "uri": "sample string 2",
  "suppliersDto": {
    "dualConsolidatedSuppliers": [
      {
        "id": 1,
        "name": "sample string 2",
        "websiteUrl": "sample string 3",
        "billSampleUrl": "sample string 4",
        "hasWarmHomeDiscount": true
      },
      {
        "id": 1,
        "name": "sample string 2",
        "websiteUrl": "sample string 3",
        "billSampleUrl": "sample string 4",
        "hasWarmHomeDiscount": true
      }
    ],
    "electricitySuppliers": [
      {
        "id": 1,
        "name": "sample string 2",
        "websiteUrl": "sample string 3",
        "billSampleUrl": "sample string 4",
        "hasWarmHomeDiscount": true
      },
      {
        "id": 1,
        "name": "sample string 2",
        "websiteUrl": "sample string 3",
        "billSampleUrl": "sample string 4",
        "hasWarmHomeDiscount": true
      }
    ],
    "gasSuppliers": [
      {
        "id": 1,
        "name": "sample string 2",
        "websiteUrl": "sample string 3",
        "billSampleUrl": "sample string 4",
        "hasWarmHomeDiscount": true
      },
      {
        "id": 1,
        "name": "sample string 2",
        "websiteUrl": "sample string 3",
        "billSampleUrl": "sample string 4",
        "hasWarmHomeDiscount": true
      }
    ]
  }
}

application/xml, text/xml

Sample:

<SampleSuppliersDtoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGenius.Api.Domain.Default.Suppliers">
  <ApiVersion>sample string 1</ApiVersion>
  <SuppliersDto>
    <DualConsolidatedSuppliers>
      <SupplierDto>
        <BillSampleUrl>sample string 4</BillSampleUrl>
        <HasWarmHomeDiscount>true</HasWarmHomeDiscount>
        <Id>1</Id>
        <Name>sample string 2</Name>
        <WebsiteUrl>sample string 3</WebsiteUrl>
      </SupplierDto>
      <SupplierDto>
        <BillSampleUrl>sample string 4</BillSampleUrl>
        <HasWarmHomeDiscount>true</HasWarmHomeDiscount>
        <Id>1</Id>
        <Name>sample string 2</Name>
        <WebsiteUrl>sample string 3</WebsiteUrl>
      </SupplierDto>
    </DualConsolidatedSuppliers>
    <ElectricitySuppliers>
      <SupplierDto>
        <BillSampleUrl>sample string 4</BillSampleUrl>
        <HasWarmHomeDiscount>true</HasWarmHomeDiscount>
        <Id>1</Id>
        <Name>sample string 2</Name>
        <WebsiteUrl>sample string 3</WebsiteUrl>
      </SupplierDto>
      <SupplierDto>
        <BillSampleUrl>sample string 4</BillSampleUrl>
        <HasWarmHomeDiscount>true</HasWarmHomeDiscount>
        <Id>1</Id>
        <Name>sample string 2</Name>
        <WebsiteUrl>sample string 3</WebsiteUrl>
      </SupplierDto>
    </ElectricitySuppliers>
    <GasSuppliers>
      <SupplierDto>
        <BillSampleUrl>sample string 4</BillSampleUrl>
        <HasWarmHomeDiscount>true</HasWarmHomeDiscount>
        <Id>1</Id>
        <Name>sample string 2</Name>
        <WebsiteUrl>sample string 3</WebsiteUrl>
      </SupplierDto>
      <SupplierDto>
        <BillSampleUrl>sample string 4</BillSampleUrl>
        <HasWarmHomeDiscount>true</HasWarmHomeDiscount>
        <Id>1</Id>
        <Name>sample string 2</Name>
        <WebsiteUrl>sample string 3</WebsiteUrl>
      </SupplierDto>
    </GasSuppliers>
  </SuppliersDto>
  <Uri>sample string 2</Uri>
</SampleSuppliersDtoResponse>

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="ApiVersion"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Uri"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.DualConsolidatedSuppliers[0].Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.DualConsolidatedSuppliers[0].Name"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.DualConsolidatedSuppliers[0].WebsiteUrl"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.DualConsolidatedSuppliers[0].BillSampleUrl"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.DualConsolidatedSuppliers[0].HasWarmHomeDiscount"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.DualConsolidatedSuppliers[1].Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.DualConsolidatedSuppliers[1].Name"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.DualConsolidatedSuppliers[1].WebsiteUrl"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.DualConsolidatedSuppliers[1].BillSampleUrl"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.DualConsolidatedSuppliers[1].HasWarmHomeDiscount"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.ElectricitySuppliers[0].Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.ElectricitySuppliers[0].Name"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.ElectricitySuppliers[0].WebsiteUrl"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.ElectricitySuppliers[0].BillSampleUrl"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.ElectricitySuppliers[0].HasWarmHomeDiscount"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.ElectricitySuppliers[1].Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.ElectricitySuppliers[1].Name"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.ElectricitySuppliers[1].WebsiteUrl"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.ElectricitySuppliers[1].BillSampleUrl"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.ElectricitySuppliers[1].HasWarmHomeDiscount"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.GasSuppliers[0].Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.GasSuppliers[0].Name"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.GasSuppliers[0].WebsiteUrl"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.GasSuppliers[0].BillSampleUrl"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.GasSuppliers[0].HasWarmHomeDiscount"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.GasSuppliers[1].Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.GasSuppliers[1].Name"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.GasSuppliers[1].WebsiteUrl"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.GasSuppliers[1].BillSampleUrl"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="SuppliersDto.GasSuppliers[1].HasWarmHomeDiscount"

True
--MultipartDataMediaFormatterBoundary1q2w3e--