Power.Dev Optimization Services

CommonOptimizerRequest

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

**CommonOptimizerPortalRequestBase** Parameters:
Name	Parameter	Data Type	Required
ProjectId	form	Guid	No
IsBatchSimulation	form	bool	No
Force	form	bool	No
DisableEBSSpot	form	bool	No
IsServerless	form	bool	No
ApiActionId	form	Guid	No
NodeId	form	int	No
ParallelProject	form	int	No
ParallelYears	form	int	No
EnsureExlusive	form	int	No

**CommonOptimizerResponse** Parameters:
Name	Parameter	Data Type	Required
Status	form	ApiResponseStatus	No
Message	form	string	No
ApiActionId	form	Guid	No
Detail	form	string	No
Items	form	IEnumerable<BatteryProjectForOptimizer>	No

**ApiResponseStatus** Enum:
Name	Value
Undefined	0
Success	1
Pending	10
Failed	100

**BatteryProjectForOptimizer** Parameters:
Name	Parameter	Data Type	Required
ProjectId	form	Guid	No
Version	form	string	No
BaseId	form	Guid	No
AltId	form	int	No
SimulationType	form	BatterySimulationType	No
ProjectGroup	form	BatteryProjectGroup	No
ProjectAction	form	BatteryProjectAction	No
Iso	form	DataProvider	No
Name	form	string	No
BaseNodeId	form	int	No
OrgNodeId	form	int	No
BaseZoneId	form	int	No
DataSource	form	BatteryDataSoruce	No
BaseMarket	form	PriceMarketType	No
PriceGranularity	form	TimeGranularity	No
StartDate	form	DateTime	No
EndDate	form	DateTime	No
BatteryCapacity	form	decimal	No
InterconnectionLimit	form	decimal	No
NamepaletCapacity	form	decimal	No
ChargeDischargeLimit	form	decimal	No
BaseCapacityRate	form	decimal	No
CapacityRate	form	decimal	No
ChargeEfficiency	form	decimal	No
DisChargeEfficiency	form	decimal	No
ParaciticLossesOperation	form	decimal	No
ParaciticLossesResting	form	decimal	No
HVACLosses	form	decimal	No
AcCablingLosses	form	decimal	No
TransformatorLosses	form	decimal	No
ThermalLosses	form	decimal	No
OtherLosses	form	decimal	No
UseEnergy	form	BooleanValue	No
UseCapacity	form	BooleanValue	No
CapacityBasis	form	CapacityMethod	No
CapacityPayment	form	decimal	No
NetCapacityFactor	form	decimal	No
UseAncillary	form	BooleanValue	No
ProductionDataSource	form	BatteryProductionDataSource	No
PowerPlantType	form	PowerPlantType	No
SolarAcCapacity	form	decimal	No
SolarDcCapacity	form	decimal	No
WindAcCapacity	form	decimal	No
SolarCapacityRate	form	decimal	No
WindCapacityRate	form	decimal	No
Status	form	int	No
SimulationStatus	form	int	No
LastSimulationDate	form	DateTime	No
DataStartDate	form	DateTime	No
DataEndDate	form	DateTime	No
SolarId	form	int	No
WindId	form	int	No
LmpFileId	form	int	No
ProductionFileId	form	int	No
LoadFileId	form	int	No
CapacityFileId	form	int	No
NodeAltId	form	int	No
NodeRefId	form	int	No
UseRegup	form	decimal	No
UseRegdown	form	decimal	No
UseSpinning	form	decimal	No
UseNonSpinning	form	decimal	No
SolarDegredation	form	decimal	No
BatteryDegredation	form	decimal	No
Augmentation	form	decimal	No
AugmentationFrequency	form	decimal	No
EnergyIncrement	form	decimal	No
AncillaryIncrement	form	decimal	No
EnableGridArbitrage	form	int	No
IncrementReferanceYear	form	int	No
RepresentativeYear	form	int	No
UseFutureData	form	int	No
MaxDailyCycle	form	decimal	No
MinDailyProfitPerMw	form	decimal	No
AncillaryFileId	form	int	No
MaxChargingPriceCap	form	decimal	No
MaxDischargingPriceCap	form	decimal	No
MaxAncillaryPriceCap	form	decimal	No
RevenueStackingMode	form	RevenueStackingMode	No
OptimizationQuality	form	int	No
UseInternalSolver	form	bool	No

**BatterySimulationType** Enum:
Name	Value
Undefined	0
SingleRun	1
BatchSimulation	2
BatchSub	21
Siting	100

**BatteryProjectGroup** Enum:
Undefined
StandAlone
FTM
BTM

**BatteryProjectAction** Enum:
Undefined
Arbitrage
PeakShaving
Smooting
Firming

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

**BatteryDataSoruce** Enum:
Undefined
Merchant
Future
TOD

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

**TimeGranularity** Enum:
Name	Value
Undefined	0
hourly	1
daily	2
weekly	3
monthy	4
yearly	5
fivemin	10
tenmin	11
fifteenmin	12
halfhour	13
quarterly	14
twohours	21
threehours	22
fourhours	24
sixhours	26
eighthours	28
twelvehours	32
irregular	100

**BooleanValue** Enum:
Undefined
Yes
No
Custom

**CapacityMethod** Enum:
Undefined
Annual
Tod
Schedule

**BatteryProductionDataSource** Enum:
Undefined
SetClosest
UploadedFile

**PowerPlantType** Enum:
Undefined
Solar
Wind
Hybrid

**RevenueStackingMode** Enum:
SolveWithoutAncillary
SolveWithAncillary

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /optimizer/ftm HTTP/1.1 
Host: dev-optimization.power.dev 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	projectId: 00000000000000000000000000000000,
	isBatchSimulation: False,
	force: False,
	disableEBSSpot: False,
	isServerless: False,
	apiActionId: 00000000000000000000000000000000,
	nodeId: 0,
	parallelProject: 0,
	parallelYears: 0,
	ensureExlusive: 0
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	status: Undefined,
	message: String,
	apiActionId: 00000000000000000000000000000000,
	detail: String
}