POST 17.0/app/utilityswitching/switches/list

Description

Gets a list of Switches from Property Button

URI Parameters

None.

The Switches Filters to use

SwitchesFilters
Name Description Type Additional information
AgentID

string

None.
SwitchStatus

string

None.
SwitchTo

integer

None.
StartDate

date

None.
EndDate

date

None.

application/json, text/json
Sample: 
{
  "agentID": "sample string 1",
  "switchStatus": "sample string 2",
  "switchTo": 3,
  "startDate": "2025-01-09T20:34",
  "endDate": "2025-01-09T20:34"
}

application/xml, text/xml
Sample: 
<SwitchesFilters xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <AgentID>sample string 1</AgentID>
  <SwitchStatus>sample string 2</SwitchStatus>
  <SwitchTo>3</SwitchTo>
  <StartDate>2025-01-09T20:34:23.1939221+00:00</StartDate>
  <EndDate>2025-01-09T20:34:23.1939221+00:00</EndDate>
</SwitchesFilters>

application/x-www-form-urlencoded
Sample:

Sample not available.

List(Of Models.Switches)

Collection of SwitchesListItem
Name Description Type Additional information
SwitchTo

string

None.
Status

string

None.
GasSupplier

string

None.
ElectricSupplier

string

None.
CaseID

string

None.
AgentName

string

None.
CreatedDate

date

None.
PropertyAddress

string

None.
MPRN

string

None.
GPRN

string

None.
TenantName

string

None.
SwitchOverID

string

None.

application/json, text/json
Sample: 
[
  {
    "switchTo": "sample string 1",
    "status": "sample string 2",
    "gasSupplier": "sample string 3",
    "electricSupplier": "sample string 4",
    "caseID": "sample string 5",
    "agentName": "sample string 6",
    "createdDate": "2025-01-09T20:34",
    "propertyAddress": "sample string 8",
    "mprn": "sample string 9",
    "gprn": "sample string 10",
    "tenantName": "sample string 11",
    "switchOverID": "sample string 12"
  },
  {
    "switchTo": "sample string 1",
    "status": "sample string 2",
    "gasSupplier": "sample string 3",
    "electricSupplier": "sample string 4",
    "caseID": "sample string 5",
    "agentName": "sample string 6",
    "createdDate": "2025-01-09T20:34",
    "propertyAddress": "sample string 8",
    "mprn": "sample string 9",
    "gprn": "sample string 10",
    "tenantName": "sample string 11",
    "switchOverID": "sample string 12"
  }
]

application/xml, text/xml
Sample: 
<ArrayOfSwitchesListItem xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SwitchesListItem>
    <SwitchTo>sample string 1</SwitchTo>
    <Status>sample string 2</Status>
    <GasSupplier>sample string 3</GasSupplier>
    <ElectricSupplier>sample string 4</ElectricSupplier>
    <CaseID>sample string 5</CaseID>
    <AgentName>sample string 6</AgentName>
    <CreatedDate>2025-01-09T20:34:23.1939221+00:00</CreatedDate>
    <PropertyAddress>sample string 8</PropertyAddress>
    <MPRN>sample string 9</MPRN>
    <GPRN>sample string 10</GPRN>
    <TenantName>sample string 11</TenantName>
    <SwitchOverID>sample string 12</SwitchOverID>
  </SwitchesListItem>
  <SwitchesListItem>
    <SwitchTo>sample string 1</SwitchTo>
    <Status>sample string 2</Status>
    <GasSupplier>sample string 3</GasSupplier>
    <ElectricSupplier>sample string 4</ElectricSupplier>
    <CaseID>sample string 5</CaseID>
    <AgentName>sample string 6</AgentName>
    <CreatedDate>2025-01-09T20:34:23.1939221+00:00</CreatedDate>
    <PropertyAddress>sample string 8</PropertyAddress>
    <MPRN>sample string 9</MPRN>
    <GPRN>sample string 10</GPRN>
    <TenantName>sample string 11</TenantName>
    <SwitchOverID>sample string 12</SwitchOverID>
  </SwitchesListItem>
</ArrayOfSwitchesListItem>