HoneybeeSchema - the C# library for the Honeybee Project Information Schema

Documentation for Honeybee project-information schema

This C# SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.58.1
• SDK version: 1.58.1
• Build package: org.openapitools.codegen.languages.CSharpClientCodegen For more information, please visit https://github.com/ladybug-tools/honeybee-schema

Frameworks supported

• .NET Core >=1.0
• .NET Framework >=4.5

Dependencies

• 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

Installation

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 HoneybeeSchema.Api;
using HoneybeeSchema.Client;
using HoneybeeSchema.Model;

Packaging

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 HoneybeeSchema.csproj

Then, publish to a local feed or other host and consume the new package via Nuget as usual.

Getting Started

using System.Collections.Generic;
using System.Diagnostics;
using HoneybeeSchema.Api;
using HoneybeeSchema.Client;
using HoneybeeSchema.Model;

namespace Example
{
    public class Example
    {
        public static void Main()
        {

        }
    }
}

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description

Documentation for Models

• Model.Autocalculate
• Model.AutocalculateAllOf
• Model.BuildingTypes
• Model.ClimateZones
• Model.EfficiencyStandards
• Model.Location
• Model.LocationAllOf
• Model.OpenAPIGenBaseModel
• Model.ProjectInfo
• Model.ProjectInfoAllOf

Documentation for Authorization

All endpoints do not require authorization.