Power.Dev Optimization Services

<back to all web services

TODOptimizerRequest

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

public class TODOptimizerRequest : TodOptimizerRequestBase
{
    required public init(){ super.init() }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
    }
}

public class TodOptimizerRequestBase : Codable
{
    public var projectId:String
    public var chargeDischargeLimit:Double
    public var batteryCapacity:Double
    public var chargeEfficiency:Double
    public var dischargeEfficiency:Double
    public var paraciticLossesOperation:Double
    public var paraciticLossesResting:Double
    public var hvacLosses:Double
    public var acCablingLosses:Double
    public var transformatorLosses:Double
    public var thermalLosses:Double
    public var unavailabilityLoss:Double
    public var otherLosses:Double
    public var enableCapacity:Bool
    public var energySchedule:[AnnualRateItem] = []
    public var capacitySchedule:[AnnualRateItem] = []
    public var yoyFactors:[YoyFactorOptimizarItem] = []
    public var data:[TodOptimizerRequestItem] = []
    public var apiActionId:String

    required public init(){}
}

public class AnnualRateItem : Codable
{
    public var year:Int
    public var value:Double

    required public init(){}
}

public class YoyFactorOptimizarItem : Codable
{
    public var year:Int
    public var factor:Double

    required public init(){}
}

public class TodOptimizerRequestItem : Codable
{
    public var year:Int
    public var month:Int
    public var hour:Int
    public var weekDay:Int
    public var energyPrice:Double
    public var capacityPrice:Double

    required public init(){}
}

public class TodOptimizerResponse : Codable
{
    public var status:ApiResponseStatus
    public var message:String
    public var apiActionId:String
    public var testItems:[TodOptimizerResponseItem] = []

    required public init(){}
}

public enum ApiResponseStatus : Int, Codable
{
    case Undefined = 0
    case Success = 1
    case Pending = 10
    case Failed = 100
}

public class TodOptimizerResponseItem : TodOptimizerRequestItem
{
    public var chargeState:Double
    public var charging:Double
    public var loss:Double
    public var chargeRate:Double

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case chargeState
        case charging
        case loss
        case chargeRate
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        chargeState = try container.decodeIfPresent(Double.self, forKey: .chargeState)
        charging = try container.decodeIfPresent(Double.self, forKey: .charging)
        loss = try container.decodeIfPresent(Double.self, forKey: .loss)
        chargeRate = try container.decodeIfPresent(Double.self, forKey: .chargeRate)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if chargeState != nil { try container.encode(chargeState, forKey: .chargeState) }
        if charging != nil { try container.encode(charging, forKey: .charging) }
        if loss != nil { try container.encode(loss, forKey: .loss) }
        if chargeRate != nil { try container.encode(chargeRate, forKey: .chargeRate) }
    }
}

Swift 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>