View the API Schema
There are two ways to view documentation on the classes and their properties that you need to use the API:
Use the API class references
Go to SolarFarmerApi.Client to see the classes. Click on different classes to see their properties.
This includes descriptions for the classes and properties, but does not include validation rules and whether each property is required or not.
View the schema interactively
The schema (the classes, their properties and validation rules) that you need to use the API is available for reference on the SolarFarmer web API website.
Go to https://solarfarmer.dnv.com/docs and scroll down to the Schemas section (after the endpoints).
Within the Schemas section there is an entry for each class used with the API.
- Click on the class you are interested in knowing more about:
- It should expand to show you the properties.
- Some properties will show you the description, any validation criteria (e.g. minimum or maximum allowed values) and its type.
- Some of the properties may themselves be classes. Click on the
>icon to expand the class.
EnergyCalculationInputs is a good place to start looking, as this is the top-level class required for running
Download schema configuration files
From the links at the top of the https://solarfarmer.dnv.com/docs web page you can download the full schema as files in two formats:
CSharpClient.csas a C# (