Power.Dev Optimization Services

<back to all web services

TODOptimizerRequest

The following routes are available for this service:
POST/optimizer/tod
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using powerDev.Optimization.ServiceModel;
using powerDev.Common.Models;
using powerDev.Common.Types;

namespace powerDev.Common.Models
{
    public partial class AnnualRateItem
    {
        public virtual int Year { get; set; }
        public virtual decimal Value { get; set; }
    }

    public partial class TodOptimizerRequestBase
    {
        public virtual Guid ProjectId { get; set; }
        public virtual decimal ChargeDischargeLimit { get; set; }
        public virtual decimal BatteryCapacity { get; set; }
        public virtual decimal ChargeEfficiency { get; set; }
        public virtual decimal DischargeEfficiency { get; set; }
        public virtual decimal ParaciticLossesOperation { get; set; }
        public virtual decimal ParaciticLossesResting { get; set; }
        public virtual decimal HVACLosses { get; set; }
        public virtual decimal AcCablingLosses { get; set; }
        public virtual decimal TransformatorLosses { get; set; }
        public virtual decimal ThermalLosses { get; set; }
        public virtual decimal UnavailabilityLoss { get; set; }
        public virtual decimal OtherLosses { get; set; }
        public virtual bool EnableCapacity { get; set; }
        public virtual IEnumerable<AnnualRateItem> EnergySchedule { get; set; }
        public virtual IEnumerable<AnnualRateItem> CapacitySchedule { get; set; }
        public virtual IEnumerable<YoyFactorOptimizarItem> YoyFactors { get; set; }
        public virtual IEnumerable<TodOptimizerRequestItem> Data { get; set; }
        public virtual Guid ApiActionId { get; set; }
    }

    public partial class TodOptimizerRequestItem
    {
        public virtual int Year { get; set; }
        public virtual int Month { get; set; }
        public virtual int Hour { get; set; }
        public virtual int WeekDay { get; set; }
        public virtual decimal EnergyPrice { get; set; }
        public virtual decimal CapacityPrice { get; set; }
    }

    public partial class TodOptimizerResponse
    {
        public TodOptimizerResponse()
        {
            TestItems = new List<TodOptimizerResponseItem>{};
        }

        public virtual ApiResponseStatus Status { get; set; }
        public virtual string Message { get; set; }
        public virtual Guid ApiActionId { get; set; }
        public virtual List<TodOptimizerResponseItem> TestItems { get; set; }
    }

    public partial class TodOptimizerResponseItem
        : TodOptimizerRequestItem
    {
        public virtual decimal ChargeState { get; set; }
        public virtual decimal Charging { get; set; }
        public virtual decimal Loss { get; set; }
        public virtual decimal ChargeRate { get; set; }
    }

    public partial class YoyFactorOptimizarItem
    {
        public virtual int Year { get; set; }
        public virtual decimal Factor { get; set; }
    }

}

namespace powerDev.Common.Types
{
    public enum ApiResponseStatus
    {
        Undefined = 0,
        Success = 1,
        Pending = 10,
        Failed = 100,
    }

}

namespace powerDev.Optimization.ServiceModel
{
    public partial class TODOptimizerRequest
        : TodOptimizerRequestBase
    {
    }

}

C# 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>