POST 17.0/app/utilityswitching/switches/council/allocation

Description

No description available.

URI Parameters

None.

Name Description Type Additional information
Property

Property

Required

SwitchType

SwitchType

Required

MeterReadings

MeterReadings

Required

TenancyStartDate

date

Required

Tenant

Tenant

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:30",
    "gasMeterRead": 7
  },
  "tenancyStartDate": "2025-01-09T20:30",
  "tenant": {
    "titleId": 1,
    "firstName": "sample string 2",
    "lastName": "sample string 3",
    "telephoneNumber": "sample string 4",
    "email": "sample string 5",
    "dateOfBirth": "2025-01-09T20:30",
    "criticalCare": true,
    "tenantId": 8
  }
}

application/xml, text/xml

Sample:
<NewAllocationSwitch 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:30:21.791382+00:00</MeterReadingDate>
    <GasMeterRead>7</GasMeterRead>
  </MeterReadings>
  <TenancyStartDate>2025-01-09T20:30:21.791382+00:00</TenancyStartDate>
  <Tenant>
    <TitleId>1</TitleId>
    <FirstName>sample string 2</FirstName>
    <LastName>sample string 3</LastName>
    <TelephoneNumber>sample string 4</TelephoneNumber>
    <Email>sample string 5</Email>
    <DateOfBirth>2025-01-09T20:30:21.791382+00:00</DateOfBirth>
    <CriticalCare>true</CriticalCare>
    <TenantId>8</TenantId>
  </Tenant>
</NewAllocationSwitch>

application/x-www-form-urlencoded

Sample:

Sample not available.

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>