POST 17.0/app/utilityswitching/switches/council/surrender

Description

No description available.

URI Parameters

None.

NewSurrenderSwitch
Name Description Type Additional information
Property

Property

Required
SwitchType

SwitchType

Required
MeterReadings

MeterReadings

Required
IsNewDevelopment

boolean

Required

application/json, text/json
Sample: 
{
  "property": {
    "address": {
      "countryCode": 1,
      "postCode": "sample string 2",
      "propertyName": "sample string 3",
      "street": "sample string 4",
      "locality": "sample string 5",
      "town": "sample string 6",
      "region": "sample string 7",
      "country": "sample string 8"
    },
    "mprn": "sample string 1",
    "gprn": "sample string 2",
    "electricMeterType": 0,
    "payAsYouGoGasMeter": true,
    "propertyId": 4
  },
  "switchType": 1,
  "meterReadings": {
    "twentyFourHourMeterRead": 1,
    "nightSaverMeterRead": 2,
    "dayMeterRead": 3,
    "nightMeterRead": 4,
    "peakMeterRead": 5,
    "meterReadingDate": "2025-01-09T20:50",
    "gasMeterRead": 7
  },
  "isNewDevelopment": true
}

application/xml, text/xml
Sample: 
<NewSurrenderSwitch xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Property>
    <Address>
      <CountryCode>1</CountryCode>
      <PostCode>sample string 2</PostCode>
      <PropertyName>sample string 3</PropertyName>
      <Street>sample string 4</Street>
      <Locality>sample string 5</Locality>
      <Town>sample string 6</Town>
      <Region>sample string 7</Region>
      <Country>sample string 8</Country>
    </Address>
    <Mprn>sample string 1</Mprn>
    <Gprn>sample string 2</Gprn>
    <ElectricMeterType>Standard</ElectricMeterType>
    <PayAsYouGoGasMeter>true</PayAsYouGoGasMeter>
    <PropertyId>4</PropertyId>
  </Property>
  <SwitchType>DualFuel</SwitchType>
  <MeterReadings>
    <TwentyFourHourMeterRead>1</TwentyFourHourMeterRead>
    <NightSaverMeterRead>2</NightSaverMeterRead>
    <DayMeterRead>3</DayMeterRead>
    <NightMeterRead>4</NightMeterRead>
    <PeakMeterRead>5</PeakMeterRead>
    <MeterReadingDate>2025-01-09T20:50:18.2533303+00:00</MeterReadingDate>
    <GasMeterRead>7</GasMeterRead>
  </MeterReadings>
  <IsNewDevelopment>true</IsNewDevelopment>
</NewSurrenderSwitch>

application/x-www-form-urlencoded
Sample:

Sample not available.

CreateSwitchResponse
Name Description Type Additional information
CaseID

string

None.
SwitchOverID

string

None.

application/json, text/json
Sample: 
{
  "caseID": "sample string 1",
  "switchOverID": "sample string 2"
}

application/xml, text/xml
Sample: 
<CreateSwitchResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <CaseID>sample string 1</CaseID>
  <SwitchOverID>sample string 2</SwitchOverID>
</CreateSwitchResponse>