POST request/Suppliers/Switch-From

Gets a list of possible suppliers a customer can switch from.

Request Information

URI Parameters

None.

Body Parameters

The supplier(s) filter.

Name	Type	Additional information
PayMethod	PayMethod	None.
Postcode	string	Data type: PostalCode Max length: 10
UserId	integer	None.
UtilityType	UtilityType	None.

Request Formats

application/json, text/json

Sample:

{
  "postcode": "sample string 1",
  "utilityType": "Electricity",
  "payMethod": "DirectDebit",
  "userId": 2
}

text/html

Sample:

{"postcode":"sample string 1","utilityType":"Electricity","payMethod":"DirectDebit","userId":2}

application/xml, text/xml

Sample:

<SuppliersBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Domain.Default.BindingModel">
  <PayMethod>DirectDebit</PayMethod>
  <Postcode>sample string 1</Postcode>
  <UserId>2</UserId>
  <UtilityType>Electricity</UtilityType>
</SuppliersBindingModel>

Response Information

Resource Description

SuppliersDtoResponse

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": {
    "suppliers": [
      {
        "id": 1,
        "name": "sample string 2",
        "description": "sample string 3"
      },
      {
        "id": 1,
        "name": "sample string 2",
        "description": "sample string 3"
      }
    ]
  }
}

text/html

Sample:

{"apiVersion":"sample string 1","uri":"sample string 2","suppliersDto":{"suppliers":[{"id":1,"name":"sample string 2","description":"sample string 3"},{"id":1,"name":"sample string 2","description":"sample string 3"}]}}

application/xml, text/xml

Sample:

<SuppliersDtoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.DtoResponse">
  <ApiVersion>sample string 1</ApiVersion>
  <SuppliersDto xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Dto">
    <d2p1:Suppliers>
      <d2p1:SupplierDto>
        <d2p1:Description>sample string 3</d2p1:Description>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Name>sample string 2</d2p1:Name>
      </d2p1:SupplierDto>
      <d2p1:SupplierDto>
        <d2p1:Description>sample string 3</d2p1:Description>
        <d2p1:Id>1</d2p1:Id>
        <d2p1:Name>sample string 2</d2p1:Name>
      </d2p1:SupplierDto>
    </d2p1:Suppliers>
  </SuppliersDto>
  <Uri>sample string 2</Uri>
</SuppliersDtoResponse>