Power.Dev Optimization Services

<back to all web services

TODOptimizerRequest

The following routes are available for this service:
POST/optimizer/tod
TodOptimizerRequestBase Parameters:
NameParameterData TypeRequiredDescription
ProjectIdformGuidNo
ChargeDischargeLimitformdecimalNo
BatteryCapacityformdecimalNo
ChargeEfficiencyformdecimalNo
DischargeEfficiencyformdecimalNo
ParaciticLossesOperationformdecimalNo
ParaciticLossesRestingformdecimalNo
HVACLossesformdecimalNo
AcCablingLossesformdecimalNo
TransformatorLossesformdecimalNo
ThermalLossesformdecimalNo
UnavailabilityLossformdecimalNo
OtherLossesformdecimalNo
EnableCapacityformboolNo
EnergyScheduleformIEnumerable<AnnualRateItem>No
CapacityScheduleformIEnumerable<AnnualRateItem>No
YoyFactorsformIEnumerable<YoyFactorOptimizarItem>No
DataformIEnumerable<TodOptimizerRequestItem>No
ApiActionIdformGuidNo
AnnualRateItem Parameters:
NameParameterData TypeRequiredDescription
YearformintNo
ValueformdecimalNo
YoyFactorOptimizarItem Parameters:
NameParameterData TypeRequiredDescription
YearformintNo
FactorformdecimalNo
TodOptimizerRequestItem Parameters:
NameParameterData TypeRequiredDescription
YearformintNo
MonthformintNo
HourformintNo
WeekDayformintNo
EnergyPriceformdecimalNo
CapacityPriceformdecimalNo
TodOptimizerResponse Parameters:
NameParameterData TypeRequiredDescription
StatusformApiResponseStatusNo
MessageformstringNo
ApiActionIdformGuidNo
TestItemsformList<TodOptimizerResponseItem>No
ApiResponseStatus Enum:
NameValue
Undefined0
Success1
Pending10
Failed100
TodOptimizerResponseItem Parameters:
NameParameterData TypeRequiredDescription
ChargeStateformdecimalNo
ChargingformdecimalNo
LossformdecimalNo
ChargeRateformdecimalNo

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

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"projectId":"00000000000000000000000000000000","chargeDischargeLimit":0,"batteryCapacity":0,"chargeEfficiency":0,"dischargeEfficiency":0,"paraciticLossesOperation":0,"paraciticLossesResting":0,"hvacLosses":0,"acCablingLosses":0,"transformatorLosses":0,"thermalLosses":0,"unavailabilityLoss":0,"otherLosses":0,"enableCapacity":false,"apiActionId":"00000000000000000000000000000000"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"status":"Undefined","message":"String","apiActionId":"00000000000000000000000000000000","testItems":[{"chargeState":0,"charging":0,"loss":0,"chargeRate":0,"year":0,"month":0,"hour":0,"weekDay":0,"energyPrice":0,"capacityPrice":0}]}