Power.Dev Optimization Services

CommonOptimizerMonthlyRequest

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

**CommonOptimizerMonthlyRequest** Parameters:
Name	Parameter	Data Type	Required
Month	body	int	No
Group	body	BatteryScenarioKeyGroup	Yes
Key	body	BatteryScenarioKeyItem	Yes
ProjectGroup	body	BatteryProjectGroup	No

**MonthlyRequestBase** Parameters:
Name	Parameter	Data Type	Required
ProjectId	form	Guid	No
NodeAltId	form	int	No
Iso	form	DataProvider	No
UseEnergy	form	BooleanValue	No
UseAncillary	form	BooleanValue	No
UseCapacityTod	form	bool	No
BaseMarket	form	PriceMarketType	No
CapacityTODs	form	IEnumerable<BatteryProjectTodItem>	Yes
UseRegup	form	decimal	No
UseRegdown	form	decimal	No
UseSpinning	form	decimal	No
UseNonSpinning	form	decimal	No
ParaciticLossesOperation	form	decimal	No
ParaciticLossesResting	form	decimal	No
HVACLosses	form	decimal	No
AcCablingLosses	form	decimal	No
TransformatorLosses	form	decimal	No
OtherLosses	form	decimal	No
RepresentativeYear	form	int	No
IncrementReferanceYear	form	int	No
UseFutureData	form	int	No
MaxDailyCycle	form	decimal	No
MinDailyProfitPerMw	form	decimal	No
AncillaryFileId	form	int	No
LmpFileId	form	int	No
MaxChargingPriceCap	form	decimal	No
MaxDischargingPriceCap	form	decimal	No
MaxAncillaryPriceCap	form	decimal	No
RevenueStackingMode	form	RevenueStackingMode	No
OptimizationQuality	form	int	No
EnsureExlusive	form	int	No
NodeRefId	form	int	No
UseInternalSolver	form	bool	No

**DataProvider** Enum:
Name	Value
Undefined	0
SPP	1
ERCOT	2
MISO	3
CAISO	4
PJM	5
ISONE	6
NYISO	7
NW	8
SW	9
SE	10
AESO	11
IESO	12
CENACE	20
NONISO	99
EIA	100
PNM	150
NREL	200
NOAA	210
ENTSOE	1000
EPIAS	1010
SELF	10000

**BooleanValue** Enum:
Undefined
Yes
No
Custom

**PriceMarketType** Enum:
Name	Value
Undefined	0
Realtime	1
DayAhead	10
DART	101

**BatteryProjectTodItem** Parameters:
Name	Parameter	Data Type	Required
Month	form	int	No
WeekDay	form	int	No
Hour	form	int	No
Price	form	decimal	No
Id	form	string	No

**RevenueStackingMode** Enum:
SolveWithoutAncillary
SolveWithAncillary

**BatteryScenarioKeyGroup** Parameters:
Name	Parameter	Data Type	Required
KeyId	form	int	No
Year	form	int	No
NodeId	form	int	No
Provider	form	DataProvider	No
ZoneId	form	int	No
PlantType	form	PowerPlantType	No
SolarId	form	int	No
WindId	form	int	No
IsServerless	form	bool	No

**PowerPlantType** Enum:
Undefined
Solar
Wind
Hybrid

**BatteryScenarioKeyItem** Parameters:
Name	Parameter	Data Type	Required
ProjectId	form	Guid	No
KeyId	form	int	No
KeyType	form	BatteryScenarioType	No
RecordKey	form	string	No
JobStatus	form	int	No
Status	form	int	No
MinDate	form	DateTime	No
MaxDate	form	DateTime	No
Year	form	int	No
YoyStatus	form	int	No
UsableCapacity	form	decimal	No
UsableCapacityFactor	form	decimal	No
SolarUsableCapacity	form	decimal	No
SolarUsableCapacityFactor	form	decimal	No
BaseMarket	form	PriceMarketType	No
BaseCapacityRate	form	decimal	No
CapacityRate	form	decimal	No
SolarCapacityRate	form	decimal	No
WindCapacityRate	form	decimal	No
ChargeEfficinecy	form	decimal	No
DischargeEfficinecy	form	decimal	No
NodeId	form	int	No
Provider	form	DataProvider	No
ZoneId	form	int	No
LmpFileId	form	int	No
ProductionFileId	form	int	No
LoadFileId	form	int	No
CapacityFileId	form	int	No
PlantType	form	PowerPlantType	No
SolarId	form	int	No
WindId	form	int	No
AncillaryIncrementFactor	form	decimal	No
EnergyIncrementFactor	form	decimal	No
CapacityIncrementFactor	form	decimal	No

**BatteryScenarioType** Enum:
Undefined
Optimization
Sum
OptiSum
FullTod
CapacityTod

**BatteryProjectGroup** Enum:
Undefined
StandAlone
FTM
BTM

**MonthlyApiStatusResponse** Parameters:
Name	Parameter	Data Type	Required	Description
FailedCount	form	int	No

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/monthly HTTP/1.1 
Host: dev-optimization.power.dev 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CommonOptimizerMonthlyRequest 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.Optimization.Models">0</AcCablingLosses>
  <AncillaryFileId xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">0</AncillaryFileId>
  <BaseMarket xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">Undefined</BaseMarket>
  <CapacityTODs xmlns:d2p1="http://schemas.datacontract.org/2004/07/powerDev.Common.Models" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models" />
  <EnsureExlusive xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">0</EnsureExlusive>
  <HVACLosses xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">0</HVACLosses>
  <IncrementReferanceYear xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">0</IncrementReferanceYear>
  <Iso xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">Undefined</Iso>
  <LmpFileId xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">0</LmpFileId>
  <MaxAncillaryPriceCap xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">0</MaxAncillaryPriceCap>
  <MaxChargingPriceCap xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">0</MaxChargingPriceCap>
  <MaxDailyCycle xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">0</MaxDailyCycle>
  <MaxDischargingPriceCap xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">0</MaxDischargingPriceCap>
  <MinDailyProfitPerMw xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">0</MinDailyProfitPerMw>
  <NodeAltId xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">0</NodeAltId>
  <NodeRefId xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">0</NodeRefId>
  <OptimizationQuality xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">0</OptimizationQuality>
  <OtherLosses xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">0</OtherLosses>
  <ParaciticLossesOperation xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">0</ParaciticLossesOperation>
  <ParaciticLossesResting xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">0</ParaciticLossesResting>
  <ProjectId xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">00000000-0000-0000-0000-000000000000</ProjectId>
  <RepresentativeYear xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">0</RepresentativeYear>
  <RevenueStackingMode xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">SolveWithoutAncillary</RevenueStackingMode>
  <TransformatorLosses xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">0</TransformatorLosses>
  <UseAncillary xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">Undefined</UseAncillary>
  <UseCapacityTod xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">false</UseCapacityTod>
  <UseEnergy xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">Undefined</UseEnergy>
  <UseFutureData xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">0</UseFutureData>
  <UseInternalSolver xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">false</UseInternalSolver>
  <UseNonSpinning xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">0</UseNonSpinning>
  <UseRegdown xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">0</UseRegdown>
  <UseRegup xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">0</UseRegup>
  <UseSpinning xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">0</UseSpinning>
  <Group xmlns:d2p1="http://schemas.datacontract.org/2004/07/powerDev.Common.Models">
    <d2p1:IsServerless>false</d2p1:IsServerless>
    <d2p1:KeyId>0</d2p1:KeyId>
    <d2p1:NodeId>0</d2p1:NodeId>
    <d2p1:PlantType>Undefined</d2p1:PlantType>
    <d2p1:Provider>Undefined</d2p1:Provider>
    <d2p1:SolarId>0</d2p1:SolarId>
    <d2p1:WindId>0</d2p1:WindId>
    <d2p1:Year>0</d2p1:Year>
    <d2p1:ZoneId>0</d2p1:ZoneId>
  </Group>
  <Key xmlns:d2p1="http://schemas.datacontract.org/2004/07/powerDev.Common.Models">
    <d2p1:AncillaryIncrementFactor>0</d2p1:AncillaryIncrementFactor>
    <d2p1:BaseCapacityRate>0</d2p1:BaseCapacityRate>
    <d2p1:BaseMarket>Undefined</d2p1:BaseMarket>
    <d2p1:CapacityFileId>0</d2p1:CapacityFileId>
    <d2p1:CapacityIncrementFactor>0</d2p1:CapacityIncrementFactor>
    <d2p1:CapacityRate>0</d2p1:CapacityRate>
    <d2p1:ChargeEfficinecy>0</d2p1:ChargeEfficinecy>
    <d2p1:DischargeEfficinecy>0</d2p1:DischargeEfficinecy>
    <d2p1:EnergyIncrementFactor>0</d2p1:EnergyIncrementFactor>
    <d2p1:JobStatus>0</d2p1:JobStatus>
    <d2p1:KeyId>0</d2p1:KeyId>
    <d2p1:KeyType>Undefined</d2p1:KeyType>
    <d2p1:LmpFileId>0</d2p1:LmpFileId>
    <d2p1:LoadFileId>0</d2p1:LoadFileId>
    <d2p1:MaxDate>0001-01-01T00:00:00</d2p1:MaxDate>
    <d2p1:MinDate>0001-01-01T00:00:00</d2p1:MinDate>
    <d2p1:NodeId>0</d2p1:NodeId>
    <d2p1:PlantType>Undefined</d2p1:PlantType>
    <d2p1:ProductionFileId>0</d2p1:ProductionFileId>
    <d2p1:ProjectId>00000000-0000-0000-0000-000000000000</d2p1:ProjectId>
    <d2p1:Provider>Undefined</d2p1:Provider>
    <d2p1:RecordKey>String</d2p1:RecordKey>
    <d2p1:SolarCapacityRate>0</d2p1:SolarCapacityRate>
    <d2p1:SolarId>0</d2p1:SolarId>
    <d2p1:SolarUsableCapacity>0</d2p1:SolarUsableCapacity>
    <d2p1:SolarUsableCapacityFactor>0</d2p1:SolarUsableCapacityFactor>
    <d2p1:Status>0</d2p1:Status>
    <d2p1:UsableCapacity>0</d2p1:UsableCapacity>
    <d2p1:UsableCapacityFactor>0</d2p1:UsableCapacityFactor>
    <d2p1:WindCapacityRate>0</d2p1:WindCapacityRate>
    <d2p1:WindId>0</d2p1:WindId>
    <d2p1:Year>0</d2p1:Year>
    <d2p1:YoyStatus>0</d2p1:YoyStatus>
    <d2p1:ZoneId>0</d2p1:ZoneId>
  </Key>
  <Month>0</Month>
  <ProjectGroup>Undefined</ProjectGroup>
</CommonOptimizerMonthlyRequest>

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

<MonthlyApiStatusResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/powerDev.Optimization.Models">
  <FailedCount>0</FailedCount>
</MonthlyApiStatusResponse>