Facilities

Create new facility.

SecurityBearerAuth
Request
Request Body schema: application/json
name
required
string <= 80 characters
i_am_owner
required
integer
Enum: 0 1
i_have_solar_production_meter
required
integer
Enum: 0 1
facility_type
required
string

Possible values are:

  • RES (Residential)
  • COM (Commercial)
  • MUNI (Municipal)
  • CMTY (Community Solar)
Enum: "RES" "COM" "MUNI" "CMTY"
facility_size
required
number decimal places <= 6 >= 0.000001
is_battery_backup
integer
Default: 0
Enum: 0 1
usable_energy
number decimal places <= 6 >= 0.000001
street
required
string <= 80 characters
apartment_suite
string <= 80 characters
city
required
string <= 80 characters
county
required
string <= 80 characters
zip
required
string
state
required
string
installer_company
required
string <= 100 characters
installer_first_name
string <= 80 characters
installer_last_name
string <= 80 characters
installer_email
string <= 100 characters
installer_phone
string
installer_address
string <= 120 characters
referrer_company
required
string <= 100 characters
system_leased
integer
Enum: 0 1
owner_first_name
required
string
owner_last_name
required
string
owner_company_name
string
owner_email
string <= 100 characters
owner_street
required
string <= 80 characters
owner_apartment_suite
string <= 80 characters
owner_city
required
string <= 80 characters
owner_state
required
string
owner_zip
required
string
owner_phone
required
string
owner_county
required
string <= 80 characters
registry_id_number
string [ 4 .. 10 ] characters
system_cost
required
integer >= 1
meter_manufacturer
required
string
meter_model_type
required
string
meter_accuracy
string
  • 'revenue' if the meter is a Revenue Grade Meter
  • 'standard' if the meter is not a Revenue Grade Meter
Enum: "revenue" "standard"
meter_serial_number
string <= 50 characters
meter_last_date_certification
string
meter_remote_data_collector
string
online_monitoring_api_id
string
operation_start_date
string
utility_interconnection_date
required
string
reading_at_interconnection
number <= 11 characters >= 0
current_production_reading
number >= 0
date_of_production_reading
string
comment_box
string
utility_name
required
string

Should be a valid utility for the county

utility_account_number
required
string <= 50 characters
Array of objects (postPanelCreate)
Array of objects (postInverterCreate)
Responses
200

Facility created successfully

400

Bad request - authorization or validation errors

500

Internal error

post/facilities
Request samples
application/json
{
  • "name": "Facility name",
  • "i_am_owner": 1,
  • "i_have_solar_production_meter": 1,
  • "facility_type": "RES",
  • "facility_size": 5.657,
  • "is_battery_backup": 1,
  • "usable_energy": 2.36,
  • "street": "7312 Random Street",
  • "apartment_suite": "string",
  • "city": "Yorktown",
  • "county": "York County",
  • "zip": 24567,
  • "state": "VA",
  • "installer_company": "Installer company name",
  • "installer_first_name": "John",
  • "installer_last_name": "Doe",
  • "installer_email": "contact@email.com",
  • "installer_phone": "123-123-1234",
  • "installer_address": "123-123-1234",
  • "referrer_company": "Referrer company name",
  • "system_leased": 0,
  • "owner_first_name": "John",
  • "owner_last_name": "Doe",
  • "owner_company_name": "Owner company name",
  • "owner_email": "owner@email.com",
  • "owner_street": "7312 Random Street",
  • "owner_apartment_suite": "string",
  • "owner_city": "Yorktown",
  • "owner_state": "VA",
  • "owner_zip": 23693,
  • "owner_phone": "122-223-3321",
  • "owner_county": "York County",
  • "registry_id_number": "122-2234",
  • "system_cost": 12345,
  • "meter_manufacturer": "AstroPower",
  • "meter_model_type": "GTY-7676",
  • "meter_accuracy": "revenue",
  • "meter_serial_number": 12345,
  • "meter_last_date_certification": "2016-08-02T00:00:00.000Z",
  • "meter_remote_data_collector": "Enphase",
  • "online_monitoring_api_id": 123456,
  • "operation_start_date": "2018-10-17T00:00:00.000Z",
  • "utility_interconnection_date": "2018-10-17T00:00:00.000Z",
  • "reading_at_interconnection": 39.95,
  • "current_production_reading": 39.95,
  • "date_of_production_reading": "2018-10-17T00:00:00.000Z",
  • "comment_box": "string",
  • "utility_name": "string",
  • "utility_account_number": "string",
  • "panels": [
    ],
  • "inverters": [
    ]
}
Response samples
application/json
{
  • "url": "/app/api/v1/facilities",
  • "date": "2024-04-30 10:02:28 EDT",
  • "code": 200,
  • "elements": 0,
  • "page": "1 of 1",
  • "data": {
    }
}