Power.Dev Optimization Services

<back to all web services

TODOptimizerRequest

The following routes are available for this service:
POST/optimizer/tod
"use strict";
export class AnnualRateItem {
    /** @param {{year?:number,value?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    year;
    /** @type {number} */
    value;
}
export class YoyFactorOptimizarItem {
    /** @param {{year?:number,factor?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    year;
    /** @type {number} */
    factor;
}
export class TodOptimizerRequestItem {
    /** @param {{year?:number,month?:number,hour?:number,weekDay?:number,energyPrice?:number,capacityPrice?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    year;
    /** @type {number} */
    month;
    /** @type {number} */
    hour;
    /** @type {number} */
    weekDay;
    /** @type {number} */
    energyPrice;
    /** @type {number} */
    capacityPrice;
}
export class TodOptimizerRequestBase {
    /** @param {{projectId?:string,chargeDischargeLimit?:number,batteryCapacity?:number,chargeEfficiency?:number,dischargeEfficiency?:number,paraciticLossesOperation?:number,paraciticLossesResting?:number,hvacLosses?:number,acCablingLosses?:number,transformatorLosses?:number,thermalLosses?:number,unavailabilityLoss?:number,otherLosses?:number,enableCapacity?:boolean,energySchedule?:AnnualRateItem[],capacitySchedule?:AnnualRateItem[],yoyFactors?:YoyFactorOptimizarItem[],data?:TodOptimizerRequestItem[],apiActionId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    projectId;
    /** @type {number} */
    chargeDischargeLimit;
    /** @type {number} */
    batteryCapacity;
    /** @type {number} */
    chargeEfficiency;
    /** @type {number} */
    dischargeEfficiency;
    /** @type {number} */
    paraciticLossesOperation;
    /** @type {number} */
    paraciticLossesResting;
    /** @type {number} */
    hvacLosses;
    /** @type {number} */
    acCablingLosses;
    /** @type {number} */
    transformatorLosses;
    /** @type {number} */
    thermalLosses;
    /** @type {number} */
    unavailabilityLoss;
    /** @type {number} */
    otherLosses;
    /** @type {boolean} */
    enableCapacity;
    /** @type {AnnualRateItem[]} */
    energySchedule;
    /** @type {AnnualRateItem[]} */
    capacitySchedule;
    /** @type {YoyFactorOptimizarItem[]} */
    yoyFactors;
    /** @type {TodOptimizerRequestItem[]} */
    data;
    /** @type {string} */
    apiActionId;
}
export class TODOptimizerRequest extends TodOptimizerRequestBase {
    /** @param {{projectId?:string,chargeDischargeLimit?:number,batteryCapacity?:number,chargeEfficiency?:number,dischargeEfficiency?:number,paraciticLossesOperation?:number,paraciticLossesResting?:number,hvacLosses?:number,acCablingLosses?:number,transformatorLosses?:number,thermalLosses?:number,unavailabilityLoss?:number,otherLosses?:number,enableCapacity?:boolean,energySchedule?:AnnualRateItem[],capacitySchedule?:AnnualRateItem[],yoyFactors?:YoyFactorOptimizarItem[],data?:TodOptimizerRequestItem[],apiActionId?:string}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
}
/** @typedef {number} */
export var ApiResponseStatus;
(function (ApiResponseStatus) {
    ApiResponseStatus[ApiResponseStatus["Undefined"] = 0] = "Undefined"
    ApiResponseStatus[ApiResponseStatus["Success"] = 1] = "Success"
    ApiResponseStatus[ApiResponseStatus["Pending"] = 10] = "Pending"
    ApiResponseStatus[ApiResponseStatus["Failed"] = 100] = "Failed"
})(ApiResponseStatus || (ApiResponseStatus = {}));
export class TodOptimizerResponseItem extends TodOptimizerRequestItem {
    /** @param {{chargeState?:number,charging?:number,loss?:number,chargeRate?:number,year?:number,month?:number,hour?:number,weekDay?:number,energyPrice?:number,capacityPrice?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {number} */
    chargeState;
    /** @type {number} */
    charging;
    /** @type {number} */
    loss;
    /** @type {number} */
    chargeRate;
}
export class TodOptimizerResponse {
    /** @param {{status?:ApiResponseStatus,message?:string,apiActionId?:string,testItems?:TodOptimizerResponseItem[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ApiResponseStatus} */
    status;
    /** @type {string} */
    message;
    /** @type {string} */
    apiActionId;
    /** @type {TodOptimizerResponseItem[]} */
    testItems;
}

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