POST | /optimizer/tod |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ProjectId | form | Guid | No | |
ChargeDischargeLimit | form | decimal | No | |
BatteryCapacity | 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 | |
UnavailabilityLoss | form | decimal | No | |
OtherLosses | form | decimal | No | |
EnableCapacity | form | bool | No | |
EnergySchedule | form | IEnumerable<AnnualRateItem> | No | |
CapacitySchedule | form | IEnumerable<AnnualRateItem> | No | |
YoyFactors | form | IEnumerable<YoyFactorOptimizarItem> | No | |
Data | form | IEnumerable<TodOptimizerRequestItem> | No | |
ApiActionId | form | Guid | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Year | form | int | No | |
Value | form | decimal | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Year | form | int | No | |
Factor | form | decimal | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Year | form | int | No | |
Month | form | int | No | |
Hour | form | int | No | |
WeekDay | form | int | No | |
EnergyPrice | form | decimal | No | |
CapacityPrice | form | decimal | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Status | form | ApiResponseStatus | No | |
Message | form | string | No | |
ApiActionId | form | Guid | No | |
TestItems | form | List<TodOptimizerResponseItem> | No |
Name | Value | |
---|---|---|
Undefined | 0 | |
Success | 1 | |
Pending | 10 | |
Failed | 100 |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ChargeState | form | decimal | No | |
Charging | form | decimal | No | |
Loss | form | decimal | No | |
ChargeRate | form | decimal | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
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/jsv 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 } ] }