POST | /optimizer/tod |
---|
export class AnnualRateItem
{
public year: number;
public value: number;
public constructor(init?: Partial<AnnualRateItem>) { (Object as any).assign(this, init); }
}
export class YoyFactorOptimizarItem
{
public year: number;
public factor: number;
public constructor(init?: Partial<YoyFactorOptimizarItem>) { (Object as any).assign(this, init); }
}
export class TodOptimizerRequestItem
{
public year: number;
public month: number;
public hour: number;
public weekDay: number;
public energyPrice: number;
public capacityPrice: number;
public constructor(init?: Partial<TodOptimizerRequestItem>) { (Object as any).assign(this, init); }
}
export class TodOptimizerRequestBase
{
public projectId: string;
public chargeDischargeLimit: number;
public batteryCapacity: number;
public chargeEfficiency: number;
public dischargeEfficiency: number;
public paraciticLossesOperation: number;
public paraciticLossesResting: number;
public hvacLosses: number;
public acCablingLosses: number;
public transformatorLosses: number;
public thermalLosses: number;
public unavailabilityLoss: number;
public otherLosses: number;
public enableCapacity: boolean;
public energySchedule: AnnualRateItem[];
public capacitySchedule: AnnualRateItem[];
public yoyFactors: YoyFactorOptimizarItem[];
public data: TodOptimizerRequestItem[];
public apiActionId: string;
public constructor(init?: Partial<TodOptimizerRequestBase>) { (Object as any).assign(this, init); }
}
export class TODOptimizerRequest extends TodOptimizerRequestBase
{
public constructor(init?: Partial<TODOptimizerRequest>) { super(init); (Object as any).assign(this, init); }
}
export enum ApiResponseStatus
{
Undefined = 0,
Success = 1,
Pending = 10,
Failed = 100,
}
export class TodOptimizerResponseItem extends TodOptimizerRequestItem
{
public chargeState: number;
public charging: number;
public loss: number;
public chargeRate: number;
public constructor(init?: Partial<TodOptimizerResponseItem>) { super(init); (Object as any).assign(this, init); }
}
export class TodOptimizerResponse
{
public status: ApiResponseStatus;
public message: string;
public apiActionId: string;
public testItems: TodOptimizerResponseItem[];
public constructor(init?: Partial<TodOptimizerResponse>) { (Object as any).assign(this, init); }
}
TypeScript TODOptimizerRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
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/csv 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}]}