Documentation for Dragonfly model schema
This C# SDK is automatically generated by the OpenAPI Generator project:
- API version: 1.12.0
- SDK version: 1.12.0
- Build package: org.openapitools.codegen.languages.CSharpClientCodegen For more information, please visit https://github.com/ladybug-tools/dragonfly-core
- .NET Core >=1.0
- .NET Framework >=4.5
- RestSharp - 105.1.0 or later
- Json.NET - 7.0.0 or later
- JsonSubTypes - 1.2.0 or later
The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:
Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes
NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742
Run the following command to generate the DLL
- [Mac/Linux]
/bin/sh build.sh
- [Windows]
build.bat
Then include the DLL (under the bin
folder) in the C# project, and use the namespaces:
using DragonflySchema.Api;
using DragonflySchema.Client;
using DragonflySchema.Model;
A .nuspec
is included with the project. You can follow the Nuget quickstart to create and publish packages.
This .nuspec
uses placeholders from the .csproj
, so build the .csproj
directly:
nuget pack -Build -OutputDirectory out DragonflySchema.csproj
Then, publish to a local feed or other host and consume the new package via Nuget as usual.
using System.Collections.Generic;
using System.Diagnostics;
using DragonflySchema.Api;
using DragonflySchema.Client;
using DragonflySchema.Model;
namespace Example
{
public class Example
{
public static void Main()
{
}
}
}
All URIs are relative to http://localhost
Class | Method | HTTP request | Description |
---|
- Model.AFNCrack
- Model.AFNCrackAllOf
- Model.Adiabatic
- Model.AdiabaticAllOf
- Model.AirBoundaryConstruction
- Model.AirBoundaryConstructionAbridged
- Model.AirBoundaryConstructionAbridgedAllOf
- Model.AirBoundaryConstructionAllOf
- Model.AllAirBase
- Model.AllAirBaseAllOf
- Model.AllAirEconomizerType
- Model.Aperture
- Model.ApertureAllOf
- Model.ApertureConstructionSet
- Model.ApertureConstructionSetAbridged
- Model.ApertureConstructionSetAbridgedAllOf
- Model.ApertureConstructionSetAllOf
- Model.ApertureEnergyPropertiesAbridged
- Model.ApertureEnergyPropertiesAbridgedAllOf
- Model.ApertureModifierSet
- Model.ApertureModifierSetAbridged
- Model.ApertureModifierSetAbridgedAllOf
- Model.ApertureModifierSetAllOf
- Model.AperturePropertiesAbridged
- Model.AperturePropertiesAbridgedAllOf
- Model.ApertureRadiancePropertiesAbridged
- Model.ApertureRadiancePropertiesAbridgedAllOf
- Model.Autocalculate
- Model.AutocalculateAllOf
- Model.Autosize
- Model.AutosizeAllOf
- Model.BSDF
- Model.BSDFAllOf
- Model.BaseModifierSet
- Model.BaseModifierSetAbridged
- Model.BaseModifierSetAbridgedAllOf
- Model.BaseModifierSetAllOf
- Model.Baseboard
- Model.BaseboardAllOf
- Model.BaseboardEquipmentType
- Model.Building
- Model.BuildingAllOf
- Model.BuildingEnergyPropertiesAbridged
- Model.BuildingEnergyPropertiesAbridgedAllOf
- Model.BuildingPropertiesAbridged
- Model.BuildingPropertiesAbridgedAllOf
- Model.BuildingRadiancePropertiesAbridged
- Model.BuildingRadiancePropertiesAbridgedAllOf
- Model.Color
- Model.ColorAllOf
- Model.ConstructionSet
- Model.ConstructionSetAbridged
- Model.ConstructionSetAbridgedAllOf
- Model.ConstructionSetAllOf
- Model.ContextShade
- Model.ContextShadeAllOf
- Model.ContextShadeEnergyPropertiesAbridged
- Model.ContextShadeEnergyPropertiesAbridgedAllOf
- Model.ContextShadePropertiesAbridged
- Model.ContextShadePropertiesAbridgedAllOf
- Model.ContextShadeRadiancePropertiesAbridged
- Model.ContextShadeRadiancePropertiesAbridgedAllOf
- Model.ControlType
- Model.DOASBase
- Model.DOASBaseAllOf
- Model.DatedBaseModel
- Model.DatedBaseModelAllOf
- Model.DaylightingControl
- Model.DaylightingControlAllOf
- Model.DetailedHVAC
- Model.DetailedHVACAllOf
- Model.DetailedSkylights
- Model.DetailedSkylightsAllOf
- Model.DetailedWindows
- Model.DetailedWindowsAllOf
- Model.Door
- Model.DoorAllOf
- Model.DoorConstructionSet
- Model.DoorConstructionSetAbridged
- Model.DoorConstructionSetAbridgedAllOf
- Model.DoorConstructionSetAllOf
- Model.DoorEnergyPropertiesAbridged
- Model.DoorEnergyPropertiesAbridgedAllOf
- Model.DoorModifierSet
- Model.DoorModifierSetAbridged
- Model.DoorModifierSetAbridgedAllOf
- Model.DoorModifierSetAllOf
- Model.DoorPropertiesAbridged
- Model.DoorPropertiesAbridgedAllOf
- Model.DoorRadiancePropertiesAbridged
- Model.DoorRadiancePropertiesAbridgedAllOf
- Model.EconomizerType
- Model.ElectricEquipment
- Model.ElectricEquipmentAbridged
- Model.ElectricEquipmentAbridgedAllOf
- Model.ElectricEquipmentAllOf
- Model.EnergyBaseModel
- Model.EnergyBaseModelAllOf
- Model.EnergyMaterial
- Model.EnergyMaterialAllOf
- Model.EnergyMaterialNoMass
- Model.EnergyMaterialNoMassAllOf
- Model.EnergyMaterialVegetation
- Model.EnergyMaterialVegetationAllOf
- Model.EnergyWindowFrame
- Model.EnergyWindowFrameAllOf
- Model.EnergyWindowMaterialBlind
- Model.EnergyWindowMaterialBlindAllOf
- Model.EnergyWindowMaterialGas
- Model.EnergyWindowMaterialGasAllOf
- Model.EnergyWindowMaterialGasCustom
- Model.EnergyWindowMaterialGasCustomAllOf
- Model.EnergyWindowMaterialGasMixture
- Model.EnergyWindowMaterialGasMixtureAllOf
- Model.EnergyWindowMaterialGlazing
- Model.EnergyWindowMaterialGlazingAllOf
- Model.EnergyWindowMaterialShade
- Model.EnergyWindowMaterialShadeAllOf
- Model.EnergyWindowMaterialSimpleGlazSys
- Model.EnergyWindowMaterialSimpleGlazSysAllOf
- Model.EquipmentBase
- Model.EquipmentBaseAllOf
- Model.EvaporativeCooler
- Model.EvaporativeCoolerAllOf
- Model.EvaporativeCoolerEquipmentType
- Model.ExteriorApertureGridParameter
- Model.ExteriorApertureGridParameterAllOf
- Model.ExteriorApertureType
- Model.ExteriorFaceGridParameter
- Model.ExteriorFaceGridParameterAllOf
- Model.ExteriorFaceType
- Model.ExtrudedBorder
- Model.ExtrudedBorderAllOf
- Model.FCU
- Model.FCUAllOf
- Model.FCUEquipmentType
- Model.FCUwithDOASAbridged
- Model.FCUwithDOASAbridgedAllOf
- Model.FCUwithDOASEquipmentType
- Model.Face
- Model.Face3D
- Model.Face3DAllOf
- Model.FaceAllOf
- Model.FaceEnergyPropertiesAbridged
- Model.FaceEnergyPropertiesAbridgedAllOf
- Model.FacePropertiesAbridged
- Model.FacePropertiesAbridgedAllOf
- Model.FaceRadiancePropertiesAbridged
- Model.FaceRadiancePropertiesAbridgedAllOf
- Model.FaceSubSet
- Model.FaceSubSetAbridged
- Model.FaceSubSetAbridgedAllOf
- Model.FaceSubSetAllOf
- Model.FaceType
- Model.FloorConstructionSet
- Model.FloorConstructionSetAbridged
- Model.FloorConstructionSetAbridgedAllOf
- Model.FloorConstructionSetAllOf
- Model.FloorModifierSet
- Model.FloorModifierSetAbridged
- Model.FloorModifierSetAbridgedAllOf
- Model.FloorModifierSetAllOf
- Model.ForcedAirFurnace
- Model.ForcedAirFurnaceAllOf
- Model.FuelTypes
- Model.FurnaceEquipmentType
- Model.GasEquipment
- Model.GasEquipmentAbridged
- Model.GasEquipmentAbridgedAllOf
- Model.GasEquipmentAllOf
- Model.GasType
- Model.GasUnitHeater
- Model.GasUnitHeaterAllOf
- Model.GasUnitHeaterEquipmentType
- Model.Glass
- Model.GlassAllOf
- Model.GlobalConstructionSet
- Model.GlobalConstructionSetAllOf
- Model.GlobalModifierSet
- Model.GlobalModifierSetAllOf
- Model.Glow
- Model.GlowAllOf
- Model.GridParameterBase
- Model.GridParameterBaseAllOf
- Model.GriddedSkylightArea
- Model.GriddedSkylightAreaAllOf
- Model.GriddedSkylightRatio
- Model.GriddedSkylightRatioAllOf
- Model.Ground
- Model.GroundAllOf
- Model.HeatCoolBase
- Model.HeatCoolBaseAllOf
- Model.IDdBaseModel
- Model.IDdBaseModelAllOf
- Model.IDdEnergyBaseModel
- Model.IDdEnergyBaseModelAllOf
- Model.IDdRadianceBaseModel
- Model.IDdRadianceBaseModelAllOf
- Model.IdealAirSystemAbridged
- Model.IdealAirSystemAbridgedAllOf
- Model.Infiltration
- Model.InfiltrationAbridged
- Model.InfiltrationAbridgedAllOf
- Model.InfiltrationAllOf
- Model.InternalMassAbridged
- Model.InternalMassAbridgedAllOf
- Model.Light
- Model.LightAllOf
- Model.Lighting
- Model.LightingAbridged
- Model.LightingAbridgedAllOf
- Model.LightingAllOf
- Model.LouversBase
- Model.LouversBaseAllOf
- Model.LouversByCount
- Model.LouversByCountAllOf
- Model.LouversByDistance
- Model.LouversByDistanceAllOf
- Model.Mesh3D
- Model.Mesh3DAllOf
- Model.Metal
- Model.MetalAllOf
- Model.Mirror
- Model.MirrorAllOf
- Model.Model
- Model.ModelAllOf
- Model.ModelEnergyProperties
- Model.ModelEnergyPropertiesAllOf
- Model.ModelProperties
- Model.ModelPropertiesAllOf
- Model.ModelRadianceProperties
- Model.ModelRadiancePropertiesAllOf
- Model.ModifierBase
- Model.ModifierBaseAllOf
- Model.ModifierSet
- Model.ModifierSetAbridged
- Model.ModifierSetAbridgedAllOf
- Model.ModifierSetAllOf
- Model.ModuleType
- Model.MoistureDiffusionModel
- Model.MountingType
- Model.NoLimit
- Model.NoLimitAllOf
- Model.OpaqueConstruction
- Model.OpaqueConstructionAbridged
- Model.OpaqueConstructionAbridgedAllOf
- Model.OpaqueConstructionAllOf
- Model.OpenAPIGenBaseModel
- Model.OtherSideTemperature
- Model.OtherSideTemperatureAllOf
- Model.Outdoors
- Model.OutdoorsAllOf
- Model.Overhang
- Model.OverhangAllOf
- Model.PSZ
- Model.PSZAllOf
- Model.PSZEquipmentType
- Model.PTAC
- Model.PTACAllOf
- Model.PTACEquipmentType
- Model.PVAV
- Model.PVAVAllOf
- Model.PVAVEquipmentType
- Model.PVProperties
- Model.PVPropertiesAllOf
- Model.People
- Model.PeopleAbridged
- Model.PeopleAbridgedAllOf
- Model.PeopleAllOf
- Model.Plane
- Model.PlaneAllOf
- Model.Plastic
- Model.PlasticAllOf
- Model.ProcessAbridged
- Model.ProcessAbridgedAllOf
- Model.ProgramType
- Model.ProgramTypeAbridged
- Model.ProgramTypeAbridgedAllOf
- Model.ProgramTypeAllOf
- Model.PropertiesBaseAbridged
- Model.PropertiesBaseAbridgedAllOf
- Model.RadianceShadeStateAbridged
- Model.RadianceShadeStateAbridgedAllOf
- Model.RadianceSubFaceStateAbridged
- Model.RadianceSubFaceStateAbridgedAllOf
- Model.Radiant
- Model.RadiantAllOf
- Model.RadiantEquipmentType
- Model.RadiantFaceTypes
- Model.RadiantwithDOASAbridged
- Model.RadiantwithDOASAbridgedAllOf
- Model.RadiantwithDOASEquipmentType
- Model.RectangularWindows
- Model.RectangularWindowsAllOf
- Model.RepeatingWindowRatio
- Model.RepeatingWindowRatioAllOf
- Model.Residential
- Model.ResidentialAllOf
- Model.ResidentialEquipmentType
- Model.RoofCeilingConstructionSet
- Model.RoofCeilingConstructionSetAbridged
- Model.RoofCeilingConstructionSetAbridgedAllOf
- Model.RoofCeilingConstructionSetAllOf
- Model.RoofCeilingModifierSet
- Model.RoofCeilingModifierSetAbridged
- Model.RoofCeilingModifierSetAbridgedAllOf
- Model.RoofCeilingModifierSetAllOf
- Model.RoofSpecification
- Model.RoofSpecificationAllOf
- Model.Room
- Model.Room2D
- Model.Room2DAllOf
- Model.Room2DEnergyPropertiesAbridged
- Model.Room2DEnergyPropertiesAbridgedAllOf
- Model.Room2DPropertiesAbridged
- Model.Room2DPropertiesAbridgedAllOf
- Model.Room2DRadiancePropertiesAbridged
- Model.Room2DRadiancePropertiesAbridgedAllOf
- Model.RoomAllOf
- Model.RoomDoe2Properties
- Model.RoomDoe2PropertiesAllOf
- Model.RoomEnergyPropertiesAbridged
- Model.RoomEnergyPropertiesAbridgedAllOf
- Model.RoomGridParameter
- Model.RoomGridParameterAllOf
- Model.RoomPropertiesAbridged
- Model.RoomPropertiesAbridgedAllOf
- Model.RoomRadialGridParameter
- Model.RoomRadialGridParameterAllOf
- Model.RoomRadiancePropertiesAbridged
- Model.RoomRadiancePropertiesAbridgedAllOf
- Model.Roughness
- Model.SHWEquipmentType
- Model.SHWSystem
- Model.SHWSystemAllOf
- Model.ScheduleDay
- Model.ScheduleDayAllOf
- Model.ScheduleFixedInterval
- Model.ScheduleFixedIntervalAbridged
- Model.ScheduleFixedIntervalAbridgedAllOf
- Model.ScheduleFixedIntervalAllOf
- Model.ScheduleNumericType
- Model.ScheduleRuleAbridged
- Model.ScheduleRuleAbridgedAllOf
- Model.ScheduleRuleset
- Model.ScheduleRulesetAbridged
- Model.ScheduleRulesetAbridgedAllOf
- Model.ScheduleRulesetAllOf
- Model.ScheduleTypeLimit
- Model.ScheduleTypeLimitAllOf
- Model.ScheduleUnitType
- Model.ServiceHotWater
- Model.ServiceHotWaterAbridged
- Model.ServiceHotWaterAbridgedAllOf
- Model.ServiceHotWaterAllOf
- Model.Setpoint
- Model.SetpointAbridged
- Model.SetpointAbridgedAllOf
- Model.SetpointAllOf
- Model.Shade
- Model.ShadeAllOf
- Model.ShadeConstruction
- Model.ShadeConstructionAllOf
- Model.ShadeEnergyPropertiesAbridged
- Model.ShadeEnergyPropertiesAbridgedAllOf
- Model.ShadeLocation
- Model.ShadeModifierSet
- Model.ShadeModifierSetAbridged
- Model.ShadeModifierSetAbridgedAllOf
- Model.ShadeModifierSetAllOf
- Model.ShadePropertiesAbridged
- Model.ShadePropertiesAbridgedAllOf
- Model.ShadeRadiancePropertiesAbridged
- Model.ShadeRadiancePropertiesAbridgedAllOf
- Model.SimpleWindowArea
- Model.SimpleWindowAreaAllOf
- Model.SimpleWindowRatio
- Model.SimpleWindowRatioAllOf
- Model.SingleWindow
- Model.SingleWindowAllOf
- Model.SlatOrientation
- Model.StateGeometryAbridged
- Model.StateGeometryAbridgedAllOf
- Model.Story
- Model.StoryAllOf
- Model.StoryEnergyPropertiesAbridged
- Model.StoryEnergyPropertiesAbridgedAllOf
- Model.StoryPropertiesAbridged
- Model.StoryPropertiesAbridgedAllOf
- Model.StoryRadiancePropertiesAbridged
- Model.StoryRadiancePropertiesAbridgedAllOf
- Model.Surface
- Model.SurfaceAllOf
- Model.TemplateSystem
- Model.TemplateSystemAllOf
- Model.Trans
- Model.TransAllOf
- Model.Units
- Model.VAV
- Model.VAVAllOf
- Model.VAVEquipmentType
- Model.VRF
- Model.VRFAllOf
- Model.VRFEquipmentType
- Model.VRFwithDOASAbridged
- Model.VRFwithDOASAbridgedAllOf
- Model.VRFwithDOASEquipmentType
- Model.Ventilation
- Model.VentilationAbridged
- Model.VentilationAbridgedAllOf
- Model.VentilationAllOf
- Model.VentilationControlAbridged
- Model.VentilationControlAbridgedAllOf
- Model.VentilationFan
- Model.VentilationFanAllOf
- Model.VentilationOpening
- Model.VentilationOpeningAllOf
- Model.VentilationType
- Model.Vintages
- Model.Void
- Model.VoidAllOf
- Model.WSHP
- Model.WSHPAllOf
- Model.WSHPEquipmentType
- Model.WSHPwithDOASAbridged
- Model.WSHPwithDOASAbridgedAllOf
- Model.WSHPwithDOASEquipmentType
- Model.WallConstructionSet
- Model.WallConstructionSetAbridged
- Model.WallConstructionSetAbridgedAllOf
- Model.WallConstructionSetAllOf
- Model.WallModifierSet
- Model.WallModifierSetAbridged
- Model.WallModifierSetAbridgedAllOf
- Model.WallModifierSetAllOf
- Model.WindowAC
- Model.WindowACAllOf
- Model.WindowACEquipmentType
- Model.WindowConstruction
- Model.WindowConstructionAbridged
- Model.WindowConstructionAbridgedAllOf
- Model.WindowConstructionAllOf
- Model.WindowConstructionDynamic
- Model.WindowConstructionDynamicAllOf
- Model.WindowConstructionShade
- Model.WindowConstructionShadeAbridged
- Model.WindowConstructionShadeAbridgedAllOf
- Model.WindowConstructionShadeAllOf
- Model.WindowParameterBase
- Model.WindowParameterBaseAllOf
All endpoints do not require authorization.