This documentation describes the endpoints available in the AutoDNOExternal controller and provides details on the request models, including which fields are required and which are optional. The API supports operations for searching for ENA/EV charger/heat pump details, generating various documents (such as LOA and SLD), submitting ENA applications, and generating EV/HP documents.
API Key Authentication
All endpoints in the AutoDNOExternal API require authentication via an API key. This key must be included in every request using the HTTP header X-API-KEY.
- Header Name:
X-API-KEY - Value: Your assigned API key (for example,
YOUR_API_KEY).
In Postman, set up an environment or global variable (e.g. {{api-key}}) and include it in the request headers. For example:
X-API-KEY: {{api-key}}
This header must be sent with every API call to ensure proper authentication.
Endpoints Overview
1. Generate Documents
Endpoint: POST /api/AutoDNOExternal/GenerateDocuments
Description: Accepts a GenerateDocumentRequest that contains a solar form and a list of form types to generate (e.g., "G98", "A1-2", "LOA", "SLD"). The endpoint validates the data, generates the requested documents using PDF generation and document replacement logic, and returns the results as either a file URL or raw file data.
Request Model: GenerateDocumentRequest
| Field | Type | Required? | Description |
|---|---|---|---|
| SolarForm | SolarFormExternal |
Yes | Contains installation details (Company, Project, Inverters, Connection, AdvancedSettings). See the SolarFormExternal section for details. |
| FormOutput | List<string> |
No | Specifies which form types to generate. If omitted, the system chooses forms based on criteria (e.g., inverter capacity). Examples: "G98", "LOA", "SLD", etc. |
| ReturnFileOption | string |
Yes | Determines how the file(s) are returned. Options include "Server" (public URL), "S3" (stored on S3), or "raw" (Base64-encoded file data). |
| Password | string |
No | Optional password for encrypting generated PDF files (if applicable). |
2. Generate LOA Document
Endpoint: POST /api/AutoDNOExternal/GenerateLOA
Description: Generates a Letter of Authority (LOA) document. This endpoint expects a SolarFormExternal object that includes company and project details. The Inverters list may be empty, as inverter details are not used for LOA generation. The project’s Boundary field is used to insert any necessary diagram/image data.
3. Generate SLD Document
Endpoint: POST /api/AutoDNOExternal/GenerateSLD
Description: Generates a Single Line Diagram (SLD) document. This endpoint expects a complete SolarFormExternal object with detailed inverter data (including optional PV panel and battery details). It returns two outputs: a PNG image of the diagram and a DrawIO XML string.
4. Submit ENA Application
Endpoint: POST /api/AutoDNOExternal/SubmitENAApplication
Description: Submits an ENA application for a solar installation. The request is an ExpandedFormExternal object that extends SolarFormExternal with additional fields for inverters (using InverterENADetails), heat pumps, EV chargers, and an optional cutout file attachment.
5. Generate EV/HP Documents
Endpoint: POST /api/AutoDNOExternal/GenerateEVHPDocuments
Description: Generates documents related to EV chargers and heat pumps. The request accepts an object that includes a form (of type ExpandedFormExternal), a list of form outputs, and options for file return and password protection.
Model Field Details
GenerateDocumentRequest
| Field | Type | Required? | Description |
|---|---|---|---|
| SolarForm | SolarFormExternal | Yes | Contains installation details. See SolarFormExternal for a breakdown. |
| FormOutput | List<string> | No | Determines which document types to generate. If not provided, forms are chosen based on inverter capacity and other criteria. |
| ReturnFileOption | string | Yes | Options include "Server", "S3", or "raw". |
| Password | string | No | Optional password to encrypt generated PDF files. |
SolarFormExternal
| Field | Type | Required? | Description |
|---|---|---|---|
| Company | CompanyDetails | Yes | Contains installer/company details (name, contact, address). |
| Project | ProjectDetails | Yes | Contains project or customer installation details (address, contact, boundary – optional). |
| Inverters | List<InverterDetails> | Yes* | A list of inverter details. Required when generating SLD documents or submitting an ENA application. For LOA, this list may be empty. |
| Connection | ConnectionDetails | Yes | Must include Mpan and Phase (1 for single-phase; 3 for three-phase). |
| AdvancedSettings | AdvancedSettings | No | Optional. Contains settings such as SaveName for file storage. |
CompanyDetails
| Field | Type | Required? | Description |
|---|---|---|---|
| CompanyName | string | Yes | Name of the installer/company. |
| Address | SolarAddress | Yes | Address details. See below. |
| Contact | Contact | Yes | Contact details including first name, last name, email and phone. |
ProjectDetails
| Field | Type | Required? | Description |
|---|---|---|---|
| CompanyName | string | No* | Typically the customer company name; may be required based on business rules. |
| Address | SolarAddress | Yes | Project installation address details. |
| Contact | Contact | Yes | Project contact details. |
| Boundary | string | No | Optional field used by the LOA document generator (typically image data). |
SolarAddress
| Field | Type | Required? | Description |
|---|---|---|---|
| Street | string | Yes | The street address. |
| SecondLine | string | No | Additional address line (optional). |
| City | string | Yes | The city name. |
| Postcode | string | Yes | The postal code. |
| FormattedAddress | string (computed) | – | A concatenated address string in the format: Street, [SecondLine,] City, Postcode. |
Contact
| Field | Type | Required? | Description |
|---|---|---|---|
| FirstName | string | Yes | First name of the contact. |
| LastName | string | Yes | Last name of the contact. |
| Phone | string | Yes | Telephone number. |
| string | Yes | Email address. | |
| FullName | string (computed) | – | Automatically computed as FirstName LastName. |
| SignName | string (computed) | – | A shortened signature version (e.g. first letter of first name and full last name). |
ConnectionDetails
| Field | Type | Required? | Description |
|---|---|---|---|
| Mpan | string | Yes | The Meter Point Administration Number. |
| Phase | int | Yes | Electrical phase (typically 1 for single-phase or 3 for three-phase). |
InverterDetails
| Field | Type | Required? | Description |
|---|---|---|---|
| Manufacturer | string | Yes | Name of the inverter manufacturer. |
| Capacity | string | Yes | Inverter capacity (numeric value as a string). |
| Model | string | Yes | Model designation. |
| ENACode | string | Yes* | Reference code for ENA/compliance. If missing, it may be auto-populated via a lookup. |
| Remove | bool | No | If set to true, the inverter is to be removed on install. |
| Existing | bool | Yes | Indicates if this inverter is part of an existing installation. |
| Battery | BatteryDetails | No | Optional battery details associated with the inverter. |
| StandardFormFields | StandardFormFields | No | Additional numeric parameters for PDF generation (e.g., max output currents). Only required for systems over 50KW. |
| PVData | PVData[] | No | Optional panel string data used only for SLD generation. |
BatteryDetails
| Field | Type | Required? | Description |
|---|---|---|---|
| Manufacturer | string | No | Battery manufacturer name. |
| Model | string | No | Battery model designation. |
| Capacity | string | Yes | Battery capacity (e.g. in kWh). |
AdvancedSettings
| Field | Type | Required? | Description |
|---|---|---|---|
| SaveName | string | No | Optional file name suggestion used when saving generated documents. |
StandardFormFields
| Field | Type | Required? | Description |
|---|---|---|---|
| MaxApparentOutputPower | decimal | Yes | The maximum apparent output power of the inverter. |
| RatedOutputCurrent | decimal | Yes | The rated output current of the inverter. |
| MaxOutputCurrent | decimal | Yes | The maximum output current of the inverter. |
ExpandedFormExternal
This model extends SolarFormExternal for ENA submission by adding additional component lists and file attachments.
| Field | Type | Required? | Description |
|---|---|---|---|
| Inverters | List<InverterENADetails> | Yes | Inverter details for ENA submission. Similar to InverterDetails, but may include additional fields such as V2G. |
| Heatpumps | List<HeatpumpDetails> | No | Optional list of heat pump details (used if the installation includes heat pumps). |
| EVChargers | List<EVChargerDetails> | No | Optional list of EV charger details (used if the installation includes EV chargers). |
| CutoutFile | byte[] | No | Optional binary file (typically an image) to be attached with the ENA application. |
HeatpumpDetails
| Field | Type | Required? | Description |
|---|---|---|---|
| HeatPumpManufacturer | string | Yes | Manufacturer of the heat pump. |
| HeatPumpModel | string | Yes | Model designation of the heat pump. |
| HeatPumpCapacity | string | Yes | Capacity of the heat pump. |
| ENACode | string | Yes | Compliance reference code. |
| Remove | bool | No | If true, this heat pump is excluded from processing. |
| Existing | bool | Yes | Indicates whether this heat pump is part of an existing installation. |
EVChargerDetails
| Field | Type | Required? | Description |
|---|---|---|---|
| EVChargerManufacturer | string | Yes | Manufacturer of the EV charger. |
| EVChargerModel | string | Yes | Model of the EV charger. |
| EVChargerCapacity | string | Yes | Capacity of the EV charger. |
| ENACode | string | Yes | Compliance reference code. |
| Type | string | No | Specifies the type (e.g., AC/DC) if applicable. |
| Remove | bool | No | If true, this EV charger is excluded. |
| Existing | bool | Yes | Indicates if this charger is already installed. |
Usage Examples
Example 1: Generating a Set of Documents
Call GenerateDocuments with a JSON body that includes a valid SolarFormExternal (with company, project, inverter, and connection details) and a list of form outputs (e.g., ["G98", "LOA", "SLD"]). If a Password is provided, applicable PDF files will be password protected.
Example 2: Generating LOA Documents
Call GenerateLOA with a SolarFormExternal object that includes installer and project details. The Inverters list may be empty as LOA does not require inverter data.
Example 3: Generating SLD Documents
Call GenerateSLD with a full SolarFormExternal including inverter details (and optional PVData and Battery information) to produce a schematic. The output includes a PNG image and a DrawIO XML string.
Example 4: Submitting an ENA Application
Call SubmitENAApplication with an ExpandedFormExternal JSON body. This model extends SolarFormExternal by including lists for Inverters (using InverterENADetails), Heatpumps, and EVChargers (if applicable), as well as an optional CutoutFile for file attachments.
Example 5: Generating EV/HP Documents
Call GenerateEVHPDocuments with a JSON object containing the form (of type ExpandedFormExternal), the desired form outputs, and options for file return and password protection.
This documentation provides an overview of the AutoDNOExternal API endpoints along with the models required for each operation. The endpoints support searching for ENA, EV charger, and heat pump details, generating multiple document types (PDFs, LOA, SLD, etc.), submitting ENA applications, and generating EV/HP documents. Optional fields such as AdvancedSettings.SaveName, Project.Boundary, and additional component lists in ExpandedFormExternal allow customization based on the installation requirements.
For further integration, adjust sample JSON bodies and field values as needed to match your business rules and data.
Here’s a Postman collection examples of the endpoints, you will require an API key from support before being able to submit any endpoints.