POST request/Info/Switch/State

Provides the information about the state of a switch

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
SiteId		integer	Required

Request Formats

application/json, text/json

Sample:

{
  "siteId": 1
}

text/html

Sample:

{"siteId":1}

application/xml, text/xml

Sample:

<SiteMonitoredInfoBindingModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Domain.Default.BindingModel">
  <SiteId>1</SiteId>
</SiteMonitoredInfoBindingModel>

Response Information

Resource Description

SwitchStateDtoResponse

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

Response Formats

application/json, text/json

Sample:

{
  "apiVersion": "sample string 1",
  "uri": "sample string 2",
  "switchStateDto": {
    "exists": true,
    "started": true,
    "isForSwitchingPurpose": true,
    "inProgress": true,
    "obtainedSwitchableEnergyPlans": true,
    "awaitingFinalChecks": true,
    "isCompleted": true,
    "submittedToSupplier": true,
    "acceptedBySupplier": true
  }
}

text/html

Sample:

{"apiVersion":"sample string 1","uri":"sample string 2","switchStateDto":{"exists":true,"started":true,"isForSwitchingPurpose":true,"inProgress":true,"obtainedSwitchableEnergyPlans":true,"awaitingFinalChecks":true,"isCompleted":true,"submittedToSupplier":true,"acceptedBySupplier":true}}

application/xml, text/xml

Sample:

<SwitchStateDtoResponse 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>
  <SwitchStateDto xmlns:d2p1="http://schemas.datacontract.org/2004/07/MyUtilityGeniusForBusiness.Api.Models.Dto">
    <d2p1:AcceptedBySupplier>true</d2p1:AcceptedBySupplier>
    <d2p1:AwaitingFinalChecks>true</d2p1:AwaitingFinalChecks>
    <d2p1:Exists>true</d2p1:Exists>
    <d2p1:InProgress>true</d2p1:InProgress>
    <d2p1:IsCompleted>true</d2p1:IsCompleted>
    <d2p1:IsForSwitchingPurpose>true</d2p1:IsForSwitchingPurpose>
    <d2p1:ObtainedSwitchableEnergyPlans>true</d2p1:ObtainedSwitchableEnergyPlans>
    <d2p1:Started>true</d2p1:Started>
    <d2p1:SubmittedToSupplier>true</d2p1:SubmittedToSupplier>
  </SwitchStateDto>
  <Uri>sample string 2</Uri>
</SwitchStateDtoResponse>