OptimizeService

Operations

Index Method Parameters Response Type Description
1 getSize
OptimizeService___GetSize
OptimizeServiceGetSizeResponse
2 getLayout
OptimizeService___GetLayout
OptimizeServiceGetLayoutResponse
3 createDefaultLayout
OptimizeService___CreateDefaultLayout
OptimizeServiceCreateDefaultLayoutResponse
4 getLayoutDefaultSetup
OptimizeService___GetLayoutDefaultSetup
OptimizeServiceGetLayoutDefaultSetupResponse
5 apiRealiseLayout
OptimizeService___ApiRealiseLayout
OptimizeServiceApiRealiseLayoutResponse
6 startRuns
OptimizeService___StartRuns
OptimizeServiceStartRunsResponse
7 setWTG
OptimizeService___SetWTG
OptimizeServiceSetWTGResponse
8 addSite
OptimizeService___AddSite
OptimizeServiceAddSiteResponse
9 getStatus
OptimizeService___GetStatus
OptimizeServiceGetStatusResponse
10 addWTG
OptimizeService___AddWTG
OptimizeServiceAddWTGResponse
11 getSession
OptimizeService___GetSession
OptimizeServiceGetSessionResponse
12 addSession
OptimizeService___AddSession
OptimizeServiceAddSessionResponse
13 getSessionNames
OptimizeService___GetSessionNames
OptimizeServiceGetSessionNamesResponse
14 getSite
OptimizeService___GetSite
OptimizeServiceGetSiteResponse
15 getSiteNames
OptimizeService___GetSiteNames
OptimizeServiceGetSiteNamesResponse
16 getWTGNames
OptimizeService___GetWTGNames
OptimizeServiceGetWTGNamesResponse
17 getWTG
OptimizeService___GetWTG
OptimizeServiceGetWTGResponse
18 closeSession
OptimizeService___CloseSession
OptimizeServiceCloseSessionResponse
19 setSite
OptimizeService___SetSite
OptimizeServiceSetSiteResponse
20 openSession
OptimizeService___OpenSession
OptimizeServiceOpenSessionResponse
21 freeSessionList
OptimizeService___FreeSessionList
OptimizeServiceFreeSessionListResponse
22 createLayout
OptimizeService___CreateLayout
OptimizeServiceCreateLayoutResponse

getSize

Parameters

Name Type Required Description
OptimizeService___GetSize
OptimizeServiceGetSize
Property Type Required Description
sizeGuid String Y
Y

Response

Name Type Required Description
OptimizeService___GetSizeResponse
OptimizeServiceGetSizeResponse
Property Type Required Description
Result TApiOptimizeRun Y
Result.Guid String Y
Result.Name String Y
Result.LayoutList TROArrayApiOptimizeServiceImplTApiOptimizeNameGuid Y
Result.LayoutList.TApiOptimizeNameGuid[] TApiOptimizeNameGuid[] N
Result.LayoutList.TApiOptimizeNameGuid[].Name String Y
Result.LayoutList.TApiOptimizeNameGuid[].Guid String Y
Result.NumWTG Integer Y
Y

getLayout

Parameters

Name Type Required Description
OptimizeService___GetLayout
OptimizeServiceGetLayout
Property Type Required Description
layoutGuid String Y
Y

Response

Name Type Required Description
OptimizeService___GetLayoutResponse
OptimizeServiceGetLayoutResponse
Property Type Required Description
Result TApiOptimizeLayout Y
Result.Name String Y
Result.Id Integer Y
Result.ErrorMessage String Y
Result.Guid String Y
Result.Continous Boolean Y
Result.StartModelXMLName String Y
Result.StepModelXMLName String Y
Result.StartModelName String Y
Result.StepModelName String Y
Result.StartModelConfiguration String Y
Result.StepModelConfiguration String Y
Result.StartModelUsedSeed Integer Y
Result.StatusText String Y
Result.MaxObjective Double Y
Result.MinObjective Double Y
Result.MaxAEP Double Y
Result.MinAEP Double Y
Result.MaxCost Double Y
Result.MinCost Double Y
Result.RunTime Double Y
Result.MaxFruitlessTries Integer Y
Result.CoorSysSystem String Y
Result.CoorSysZone Integer Y
Result.CoorSysDasum String Y
Result.CostModelCurrencyIsoName String Y
Result.Layout TApiDoubleMatrix Y
Result.Layout.TApiDoubleArray[] TApiDoubleArray[] N
Result.Layout.TApiDoubleArray[].double[] Double[] N
Result.XMin Double Y
Result.YMin Double Y
Result.Width Integer Y
Result.Height Integer Y
Result.XDelta Double Y
Result.YDelta Double Y
Result.StepList TROArrayApiOptimizeServiceImplTApiOptimizeLayoutStep Y
Result.StepList.TApiOptimizeLayoutStep[] TApiOptimizeLayoutStep[] N
Result.StepList.TApiOptimizeLayoutStep[].AEP Double Y
Result.StepList.TApiOptimizeLayoutStep[].Cost Double Y
Result.StepList.TApiOptimizeLayoutStep[].LCOE Double Y
Result.StepList.TApiOptimizeLayoutStep[].NPV Double Y
Result.StepList.TApiOptimizeLayoutStep[].StepNr Integer Y
Result.StepList.TApiOptimizeLayoutStep[].RuntimeDays Double Y
Result.StepList.TApiOptimizeLayoutStep[].ValidLayout Boolean Y
Result.GridConnectionPoints TApiDoubleMatrix Y
Result.GridConnectionPoints.TApiDoubleArray[] TApiDoubleArray[] N
Result.GridConnectionPoints.TApiDoubleArray[].double[] Double[] N
Result.NeighbourTurbines TApiDoubleMatrix Y
Result.NeighbourTurbines.TApiDoubleArray[] TApiDoubleArray[] N
Result.NeighbourTurbines.TApiDoubleArray[].double[] Double[] N
Result.ResourceList TROArrayApiOptimizeServiceImplTApiOptimizeAreaResourceData Y
Result.ResourceList.TApiOptimizeAreaResourceData[] TApiOptimizeAreaResourceData[] N
Result.ResourceList.TApiOptimizeAreaResourceData[].X0 Double Y
Result.ResourceList.TApiOptimizeAreaResourceData[].Y0 Double Y
Result.ResourceList.TApiOptimizeAreaResourceData[].XDelta Double Y
Result.ResourceList.TApiOptimizeAreaResourceData[].YDelta Double Y
Result.ResourceList.TApiOptimizeAreaResourceData[].MinValue Double Y
Result.ResourceList.TApiOptimizeAreaResourceData[].MaxValue Double Y
Result.AreaPolygons TApiDoubleMatrix Y
Result.AreaPolygons.TApiDoubleArray[] TApiDoubleArray[] N
Result.AreaPolygons.TApiDoubleArray[].double[] Double[] N
Result.NSAObj TApiDoubleMatrix Y
Result.NSAObj.TApiDoubleArray[] TApiDoubleArray[] N
Result.NSAObj.TApiDoubleArray[].double[] Double[] N
Result.State EApiOptimizeLayoutState Y
Result.TerminationReason EApiOptimizeV2TerminateReason Y
Result.UserRequestedStop Boolean Y
Result.NoiseSensorNames TApiStringArray Y
Result.NoiseSensorNames.string[] String[] Y
Result.LoadSensorNames TApiStringArray Y
Result.LoadSensorNames.string[] String[] Y
Y

createDefaultLayout

Parameters

Name Type Required Description
OptimizeService___CreateDefaultLayout
OptimizeServiceCreateDefaultLayout
Property Type Required Description
wtgGuid String Y
numTurbines Integer Y
Y

Response

Name Type Required Description
OptimizeService___CreateDefaultLayoutResponse
OptimizeServiceCreateDefaultLayoutResponse
Property Type Required Description
Result Boolean Y
Y

getLayoutDefaultSetup

Parameters

Name Type Required Description
OptimizeService___GetLayoutDefaultSetup
OptimizeServiceGetLayoutDefaultSetup
 Y

Response

Name Type Required Description
OptimizeService___GetLayoutDefaultSetupResponse
OptimizeServiceGetLayoutDefaultSetupResponse
Property Type Required Description
Result TApiOptimizeSetupRun Y
Result.NumberOfTurbines Integer Y
Result.Seed Integer Y
Result.MaxFruitlessTries Integer Y
Result.MaxMinutes Double Y
Result.UseSeed Boolean Y
Result.MaxFruitless Boolean Y
Result.AllowInvalid Boolean Y
Result.Stocastic Boolean Y
Result.StepModelRunType EApiOptimizeV2Type Y
Result.StartModel EApiOptimizeV2StartModel Y
Result.StepModel EApiOptimizeV2StepModel Y
Result.WTGList TApiWtgIds Y
Result.WTGList.TApiWtgId[] TApiWtgId[] N
Result.WTGList.TApiWtgId[].Handle Integer Y
Result.WTGList.TApiWtgId[].Rowindex Integer Y
Y

apiRealiseLayout

Parameters

Name Type Required Description
OptimizeService___ApiRealiseLayout
OptimizeServiceApiRealiseLayout
Property Type Required Description
layoutGuid String Y
layerName String Y
Y

Response

Name Type Required Description
OptimizeService___ApiRealiseLayoutResponse
OptimizeServiceApiRealiseLayoutResponse
Property Type Required Description
Result TApiObjectHandles Y
Result.int[] Integer[] N
Y

startRuns

Parameters

Name Type Required Description
OptimizeService___StartRuns
OptimizeServiceStartRuns
Property Type Required Description
layoutGuid TApiStringArray Y
layoutGuid.string[] String[] Y
Y

Response

Name Type Required Description
OptimizeService___StartRunsResponse
OptimizeServiceStartRunsResponse
Property Type Required Description
Result String Y
Y

setWTG

Parameters

Name Type Required Description
OptimizeService___SetWTG
OptimizeServiceSetWTG
Property Type Required Description
apiWTG TApiOptimizeTurbine Y
apiWTG.Guid String Y
apiWTG.Name String Y
apiWTG.OverrideCostModelHandle Boolean Y
apiWTG.CostModelHandle Integer Y
apiWTG.RunList TROArrayApiOptimizeServiceImplTApiOptimizeNameGuid Y
apiWTG.RunList.TApiOptimizeNameGuid[] TApiOptimizeNameGuid[] N
apiWTG.RunList.TApiOptimizeNameGuid[].Name String Y
apiWTG.RunList.TApiOptimizeNameGuid[].Guid String Y
apiWTG.Version Integer Y
apiWTG.LegacyMode Boolean Y
apiWTG.PowerMatrixMode Boolean Y
apiWTG.ActiveLevel Integer Y
apiWTG.PMActiveLevel Integer Y
apiWTG.Filename String Y
apiWTG.OrgName String Y
apiWTG.UID String Y
apiWTG.Hubheight Double Y
apiWTG.UseDefault Boolean Y
apiWTG.PCNoise String Y
apiWTG.PowerMatrix String Y
apiWTG.Powercurve String Y
apiWTG.Noisedata String Y
apiWTG.VisualData String Y
apiWTG.eGridData String Y
apiWTG.ShortName String Y
apiWTG.DesignStandard Integer Y
apiWTG.DesignClass Integer Y
apiWTG.UseUncertainty Boolean Y
apiWTG.Uncertainty Double Y
apiWTG.LoadConstraintFilename String Y
apiWTG.LoadConstraintAllSensors Boolean Y
apiWTG.LoadResponseSensors TApiIntegerArray Y
apiWTG.LoadResponseSensors.int[] Integer[] N
Y

Response

Name Type Required Description
OptimizeService___SetWTGResponse
OptimizeServiceSetWTGResponse
Property Type Required Description
Result Boolean Y
Y

addSite

Parameters

Name Type Required Description
OptimizeService___AddSite
OptimizeServiceAddSite
Property Type Required Description
name String Y
Y

Response

Name Type Required Description
OptimizeService___AddSiteResponse
OptimizeServiceAddSiteResponse
Property Type Required Description
Result String Y
Y

getStatus

Parameters

Name Type Required Description
OptimizeService___GetStatus
OptimizeServiceGetStatus
Property Type Required Description
layoutGuid String Y
Y

Response

Name Type Required Description
OptimizeService___GetStatusResponse
OptimizeServiceGetStatusResponse
Property Type Required Description
Result EApiOptimizeLayoutState Y
Y

addWTG

Parameters

Name Type Required Description
OptimizeService___AddWTG
OptimizeServiceAddWTG
Property Type Required Description
siteGuid String Y
name String Y
wtgFile String Y
Y

Response

Name Type Required Description
OptimizeService___AddWTGResponse
OptimizeServiceAddWTGResponse
Property Type Required Description
Result String Y
Y

getSession

Parameters

Name Type Required Description
OptimizeService___GetSession
OptimizeServiceGetSession
 Y

Response

Name Type Required Description
OptimizeService___GetSessionResponse
OptimizeServiceGetSessionResponse
Property Type Required Description
Result TApiOptimizeV2Session Y
Result.Name String Y
Result.SessionType String Y
Result.CreateDateTime XMLGregorianCalendar Y
Result.LastEditDateTime XMLGregorianCalendar Y
Result.SiteList TROArrayApiOptimizeServiceImplTApiOptimizeNameGuid Y
Result.SiteList.TApiOptimizeNameGuid[] TApiOptimizeNameGuid[] N
Result.SiteList.TApiOptimizeNameGuid[].Name String Y
Result.SiteList.TApiOptimizeNameGuid[].Guid String Y
Y

addSession

Parameters

Name Type Required Description
OptimizeService___AddSession
OptimizeServiceAddSession
Property Type Required Description
name String Y
Y

Response

Name Type Required Description
OptimizeService___AddSessionResponse
OptimizeServiceAddSessionResponse
Property Type Required Description
Result String Y
Y

getSessionNames

Parameters

Name Type Required Description
OptimizeService___GetSessionNames
OptimizeServiceGetSessionNames
 Y

Response

Name Type Required Description
OptimizeService___GetSessionNamesResponse
OptimizeServiceGetSessionNamesResponse
Property Type Required Description
Result TROArrayApiOptimizeServiceImplTApiOptimizeNameGuid Y
Result.TApiOptimizeNameGuid[] TApiOptimizeNameGuid[] N
Result.TApiOptimizeNameGuid[].Name String Y
Result.TApiOptimizeNameGuid[].Guid String Y
Y

getSite

Parameters

Name Type Required Description
OptimizeService___GetSite
OptimizeServiceGetSite
Property Type Required Description
siteGuid String Y
Y

Response

Name Type Required Description
OptimizeService___GetSiteResponse
OptimizeServiceGetSiteResponse
Property Type Required Description
Result TApiOptimizeV2Site Y
Result.Guid String Y
Result.Name String Y
Result.LifeTimeY Integer Y
Result.Pattern EApiOptimizeV2SitePattern Y
Result.WakeDecayDefTerID EWakeDecayEnum Y
Result.UserDefWakeDecay Double Y
Result.WTGCostModelHandle Integer Y
Result.TurbineList TROArrayApiOptimizeServiceImplTApiOptimizeNameGuid Y
Result.TurbineList.TApiOptimizeNameGuid[] TApiOptimizeNameGuid[] N
Result.TurbineList.TApiOptimizeNameGuid[].Name String Y
Result.TurbineList.TApiOptimizeNameGuid[].Guid String Y
Result.WTGAreaHandle Integer Y
Result.GridConnectionPointHandles TApiIntegerArray Y
Result.GridConnectionPointHandles.int[] Integer[] N
Result.NSAHandles TApiIntegerArray Y
Result.NSAHandles.int[] Integer[] N
Result.WindResourceFiles TApiStringArray Y
Result.WindResourceFiles.string[] String[] Y
Result.NPVElectricityPrice Double Y
Result.NPVElectricityPriceCDD Integer Y
Result.ObjectiveMode EApiOptimizeV2ObjectiveMode Y
Result.DiscountRate Double Y
Result.NeighbourTurbineHandles TApiIntegerArray Y
Result.NeighbourTurbineHandles.int[] Integer[] N
Result.LifetimeConstraintEnable Boolean Y
Result.NoiseConstraintEnable Boolean Y
Result.DistanceConstraintEnable Boolean Y
Y

getSiteNames

Parameters

Name Type Required Description
OptimizeService___GetSiteNames
OptimizeServiceGetSiteNames
 Y

Response

Name Type Required Description
OptimizeService___GetSiteNamesResponse
OptimizeServiceGetSiteNamesResponse
Property Type Required Description
Result TROArrayApiOptimizeServiceImplTApiOptimizeNameGuid Y
Result.TApiOptimizeNameGuid[] TApiOptimizeNameGuid[] N
Result.TApiOptimizeNameGuid[].Name String Y
Result.TApiOptimizeNameGuid[].Guid String Y
Y

getWTGNames

Parameters

Name Type Required Description
OptimizeService___GetWTGNames
OptimizeServiceGetWTGNames
Property Type Required Description
siteGuid String Y
Y

Response

Name Type Required Description
OptimizeService___GetWTGNamesResponse
OptimizeServiceGetWTGNamesResponse
Property Type Required Description
Result TROArrayApiOptimizeServiceImplTApiOptimizeNameGuid Y
Result.TApiOptimizeNameGuid[] TApiOptimizeNameGuid[] N
Result.TApiOptimizeNameGuid[].Name String Y
Result.TApiOptimizeNameGuid[].Guid String Y
Y

getWTG

Parameters

Name Type Required Description
OptimizeService___GetWTG
OptimizeServiceGetWTG
Property Type Required Description
wtgGuid String Y
Y

Response

Name Type Required Description
OptimizeService___GetWTGResponse
OptimizeServiceGetWTGResponse
Property Type Required Description
Result TApiOptimizeTurbine Y
Result.Guid String Y
Result.Name String Y
Result.OverrideCostModelHandle Boolean Y
Result.CostModelHandle Integer Y
Result.RunList TROArrayApiOptimizeServiceImplTApiOptimizeNameGuid Y
Result.RunList.TApiOptimizeNameGuid[] TApiOptimizeNameGuid[] N
Result.RunList.TApiOptimizeNameGuid[].Name String Y
Result.RunList.TApiOptimizeNameGuid[].Guid String Y
Result.Version Integer Y
Result.LegacyMode Boolean Y
Result.PowerMatrixMode Boolean Y
Result.ActiveLevel Integer Y
Result.PMActiveLevel Integer Y
Result.Filename String Y
Result.OrgName String Y
Result.UID String Y
Result.Hubheight Double Y
Result.UseDefault Boolean Y
Result.PCNoise String Y
Result.PowerMatrix String Y
Result.Powercurve String Y
Result.Noisedata String Y
Result.VisualData String Y
Result.eGridData String Y
Result.ShortName String Y
Result.DesignStandard Integer Y
Result.DesignClass Integer Y
Result.UseUncertainty Boolean Y
Result.Uncertainty Double Y
Result.LoadConstraintFilename String Y
Result.LoadConstraintAllSensors Boolean Y
Result.LoadResponseSensors TApiIntegerArray Y
Result.LoadResponseSensors.int[] Integer[] N
Y

closeSession

Parameters

Name Type Required Description
OptimizeService___CloseSession
OptimizeServiceCloseSession
Property Type Required Description
doSave Boolean Y
Y

Response

Name Type Required Description
OptimizeService___CloseSessionResponse
OptimizeServiceCloseSessionResponse
Property Type Required Description
Result Boolean Y
Y

setSite

Parameters

Name Type Required Description
OptimizeService___SetSite
OptimizeServiceSetSite
Property Type Required Description
apiSite TApiOptimizeV2Site Y
apiSite.Guid String Y
apiSite.Name String Y
apiSite.LifeTimeY Integer Y
apiSite.Pattern EApiOptimizeV2SitePattern Y
apiSite.WakeDecayDefTerID EWakeDecayEnum Y
apiSite.UserDefWakeDecay Double Y
apiSite.WTGCostModelHandle Integer Y
apiSite.TurbineList TROArrayApiOptimizeServiceImplTApiOptimizeNameGuid Y
apiSite.TurbineList.TApiOptimizeNameGuid[] TApiOptimizeNameGuid[] N
apiSite.TurbineList.TApiOptimizeNameGuid[].Name String Y
apiSite.TurbineList.TApiOptimizeNameGuid[].Guid String Y
apiSite.WTGAreaHandle Integer Y
apiSite.GridConnectionPointHandles TApiIntegerArray Y
apiSite.GridConnectionPointHandles.int[] Integer[] N
apiSite.NSAHandles TApiIntegerArray Y
apiSite.NSAHandles.int[] Integer[] N
apiSite.WindResourceFiles TApiStringArray Y
apiSite.WindResourceFiles.string[] String[] Y
apiSite.NPVElectricityPrice Double Y
apiSite.NPVElectricityPriceCDD Integer Y
apiSite.ObjectiveMode EApiOptimizeV2ObjectiveMode Y
apiSite.DiscountRate Double Y
apiSite.NeighbourTurbineHandles TApiIntegerArray Y
apiSite.NeighbourTurbineHandles.int[] Integer[] N
apiSite.LifetimeConstraintEnable Boolean Y
apiSite.NoiseConstraintEnable Boolean Y
apiSite.DistanceConstraintEnable Boolean Y
Y

Response

Name Type Required Description
OptimizeService___SetSiteResponse
OptimizeServiceSetSiteResponse
Property Type Required Description
Result Boolean Y
Y

openSession

Parameters

Name Type Required Description
OptimizeService___OpenSession
OptimizeServiceOpenSession
Property Type Required Description
sessionGuid String Y
Y

Response

Name Type Required Description
OptimizeService___OpenSessionResponse
OptimizeServiceOpenSessionResponse
Property Type Required Description
Result Boolean Y
Y

freeSessionList

Parameters

Name Type Required Description
OptimizeService___FreeSessionList
OptimizeServiceFreeSessionList
 Y

Response

Name Type Required Description
OptimizeService___FreeSessionListResponse
OptimizeServiceFreeSessionListResponse
Property Type Required Description
Result Boolean Y
Y

createLayout

Parameters

Name Type Required Description
OptimizeService___CreateLayout
OptimizeServiceCreateLayout
Property Type Required Description
wtgGuid String Y
Setup TApiOptimizeSetupRun Y
Setup.NumberOfTurbines Integer Y
Setup.Seed Integer Y
Setup.MaxFruitlessTries Integer Y
Setup.MaxMinutes Double Y
Setup.UseSeed Boolean Y
Setup.MaxFruitless Boolean Y
Setup.AllowInvalid Boolean Y
Setup.Stocastic Boolean Y
Setup.StepModelRunType EApiOptimizeV2Type Y
Setup.StartModel EApiOptimizeV2StartModel Y
Setup.StepModel EApiOptimizeV2StepModel Y
Setup.WTGList TApiWtgIds Y
Setup.WTGList.TApiWtgId[] TApiWtgId[] N
Setup.WTGList.TApiWtgId[].Handle Integer Y
Setup.WTGList.TApiWtgId[].Rowindex Integer Y
Y

Response

Name Type Required Description
OptimizeService___CreateLayoutResponse
OptimizeServiceCreateLayoutResponse
Property Type Required Description
Result Boolean Y
Y