Power.Dev Optimization Services

TODOptimizerRequest

The following routes are available for this service:
POST	/optimizer/tod

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class TODOptimizerRequest : TodOptimizerRequestBase()
{
}

open class TodOptimizerRequestBase
{
    var projectId:UUID? = null
    var chargeDischargeLimit:BigDecimal? = null
    var batteryCapacity:BigDecimal? = null
    var chargeEfficiency:BigDecimal? = null
    var dischargeEfficiency:BigDecimal? = null
    var paraciticLossesOperation:BigDecimal? = null
    var paraciticLossesResting:BigDecimal? = null
    var hvacLosses:BigDecimal? = null
    var acCablingLosses:BigDecimal? = null
    var transformatorLosses:BigDecimal? = null
    var thermalLosses:BigDecimal? = null
    var unavailabilityLoss:BigDecimal? = null
    var otherLosses:BigDecimal? = null
    var enableCapacity:Boolean? = null
    var energySchedule:ArrayList<AnnualRateItem> = ArrayList<AnnualRateItem>()
    var capacitySchedule:ArrayList<AnnualRateItem> = ArrayList<AnnualRateItem>()
    var yoyFactors:ArrayList<YoyFactorOptimizarItem> = ArrayList<YoyFactorOptimizarItem>()
    @SerializedName("data") var Data:ArrayList<TodOptimizerRequestItem> = ArrayList<TodOptimizerRequestItem>()
    var apiActionId:UUID? = null
}

open class AnnualRateItem
{
    var year:Int? = null
    var value:BigDecimal? = null
}

open class YoyFactorOptimizarItem
{
    var year:Int? = null
    var factor:BigDecimal? = null
}

open class TodOptimizerRequestItem
{
    var year:Int? = null
    var month:Int? = null
    var hour:Int? = null
    var weekDay:Int? = null
    var energyPrice:BigDecimal? = null
    var capacityPrice:BigDecimal? = null
}

open class TodOptimizerResponse
{
    var status:ApiResponseStatus? = null
    var message:String? = null
    var apiActionId:UUID? = null
    var testItems:ArrayList<TodOptimizerResponseItem> = ArrayList<TodOptimizerResponseItem>()
}

enum class ApiResponseStatus(val value:Int)
{
    Undefined(0),
    Success(1),
    Pending(10),
    Failed(100),
}

open class TodOptimizerResponseItem : TodOptimizerRequestItem()
{
    var chargeState:BigDecimal? = null
    var charging:BigDecimal? = null
    var loss:BigDecimal? = null
    var chargeRate:BigDecimal? = null
}

Kotlin TODOptimizerRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /optimizer/tod HTTP/1.1 
Host: dev-optimization.power.dev 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<TODOptimizerRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.ServiceModel">
  <AcCablingLosses xmlns="http://schemas.datacontract.org/2004/07/powerDev.Common.Models">0</AcCablingLosses>
  <ApiActionId xmlns="http://schemas.datacontract.org/2004/07/powerDev.Common.Models">00000000-0000-0000-0000-000000000000</ApiActionId>
  <BatteryCapacity xmlns="http://schemas.datacontract.org/2004/07/powerDev.Common.Models">0</BatteryCapacity>
  <CapacitySchedule i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/powerDev.Common.Models" />
  <ChargeDischargeLimit xmlns="http://schemas.datacontract.org/2004/07/powerDev.Common.Models">0</ChargeDischargeLimit>
  <ChargeEfficiency xmlns="http://schemas.datacontract.org/2004/07/powerDev.Common.Models">0</ChargeEfficiency>
  <Data i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/powerDev.Common.Models" />
  <DischargeEfficiency xmlns="http://schemas.datacontract.org/2004/07/powerDev.Common.Models">0</DischargeEfficiency>
  <EnableCapacity xmlns="http://schemas.datacontract.org/2004/07/powerDev.Common.Models">false</EnableCapacity>
  <EnergySchedule i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/powerDev.Common.Models" />
  <HVACLosses xmlns="http://schemas.datacontract.org/2004/07/powerDev.Common.Models">0</HVACLosses>
  <OtherLosses xmlns="http://schemas.datacontract.org/2004/07/powerDev.Common.Models">0</OtherLosses>
  <ParaciticLossesOperation xmlns="http://schemas.datacontract.org/2004/07/powerDev.Common.Models">0</ParaciticLossesOperation>
  <ParaciticLossesResting xmlns="http://schemas.datacontract.org/2004/07/powerDev.Common.Models">0</ParaciticLossesResting>
  <ProjectId xmlns="http://schemas.datacontract.org/2004/07/powerDev.Common.Models">00000000-0000-0000-0000-000000000000</ProjectId>
  <ThermalLosses xmlns="http://schemas.datacontract.org/2004/07/powerDev.Common.Models">0</ThermalLosses>
  <TransformatorLosses xmlns="http://schemas.datacontract.org/2004/07/powerDev.Common.Models">0</TransformatorLosses>
  <UnavailabilityLoss xmlns="http://schemas.datacontract.org/2004/07/powerDev.Common.Models">0</UnavailabilityLoss>
  <YoyFactors i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/powerDev.Common.Models" />
</TODOptimizerRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TodOptimizerResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/powerDev.Common.Models">
  <ApiActionId>00000000-0000-0000-0000-000000000000</ApiActionId>
  <Message>String</Message>
  <Status>Undefined</Status>
  <TestItems>
    <TodOptimizerResponseItem>
      <CapacityPrice>0</CapacityPrice>
      <EnergyPrice>0</EnergyPrice>
      <Hour>0</Hour>
      <Month>0</Month>
      <WeekDay>0</WeekDay>
      <Year>0</Year>
      <ChargeRate>0</ChargeRate>
      <ChargeState>0</ChargeState>
      <Charging>0</Charging>
      <Loss>0</Loss>
    </TodOptimizerResponseItem>
  </TestItems>
</TodOptimizerResponse>