System & Site Survey API
This API provides access to a range of data from:
Systems (quote data related to the system design)
System Quotes via Quote Number
Endpoint: /api/system?quote_number=<quote_number>
Example: https://go.solarplus.co/api/system?quote_number=5012
Request Method: GET
Result:
{
"success": true,
"message": "Successfully retrieved quotes.",
"data": {
"id": "119",
"name": "LKSSS-110920-07:37",
"quote_number": 5012,
"pv_kw_size": 0,
"total_panels": 0,
"module": [],
"inverter": [],
"battery_inverter": [],
"battery": [],
"site_assessment": {
"id": "1",
"site_id": "119",
"system_id": "119",
"contact_id": "65932",
"bldg_type": "0",
"bldg_stories": "1",
"bldg_height": "2.4",
"roof_material": "6",
"roof_extrusion": "123",
"roof_condition": "good",
"grid_underground": "1",
"grid_pillar_no": "123",
"array_length": "123",
"household_size": "2",
"load_type": "123",
"load_daily_kWh": "123",
"load_night_perc": "123",
"daily_kWh": "123",
"bldg_ess_habitable": "1",
"bldg_exterior_clad": "2",
"bldg_eave_height": "123.0",
"bldg_ess_shed": "1",
"bldg_ess_location_ok": "1",
"bldg_ess_habit_behind": "1",
"bldg_ess_habit_above": "1",
"bldg_ess_notes": "sample notes",
"created_user_id": "2288",
"created_at": "2021-06-22 20:04:39",
"updated_user_id": "2288",
"updated_at": "2021-06-22 22:27:34",
"cable_inverter_to_battery_length": null,
"bldg_status": "0",
"main_supply_switch_rating": "123",
"average_bill_cost_per_month": "123",
"aim_battery_storage": "2",
"timeframe_for_install": "2",
"is_energy_monitoring_priority": "0",
"finance": "1",
"any_rebates_applicable": "sample"
}
}
} |
Create System from Customer ID
Endpoint: /api/system?contact_id=<contact_id>
Example: https://go.solarplus.co/api/system?contact_id=65932
Request Method: POST
JSON Payload
{
"structure_id": 25640, // load tariff based on id
"profile_id": 11981, // consumption profile id
"avg_daily_kwh": 123, // Average daily kwh under consumption profile
"package_id": 2 // system package id,
"customer_rep": "John Doe" // Name of the Customer Representative
}Result:
{
"id": "70",
"name": "JT-310521-21:15",
"site_id": "76"
} |
Update System
Endpoint: /api/system/<system_id>
Example: https://go.solarplus.co/api/system/70
Request Method: PUT
JSON Payload
{
"system": {
"name": "LK-110920-07:37",
"status": "",
"supplier_id": null,
"is_template": 0,
"f_climate": 1.000,
"f_mismatch": 1,
"f_dirt": 0.95,
"f_grid": 0.999,
"price": null,
"quote_use_price": 1,
"quote_price": 0.00,
"quote_deposit": 0.00,
"quote_status": 1,
"quote_show_discount": 1,
"stc_eligible": 1,
"stc_payment_option": 1,
"quote_signator": "",
"quote_signature": "",
"quote_sig_hash": "",
"quote_sig_ip": "",
"quote_sig_created": "2020-09-10 20:41:16",
"quote_payment_years": 11,
"quote_intro": "<p>Hi [[customer_name]],</p>\r\n\r\n<p>Thank you for choosing [[business_name]] for your solar power system quote.</p>\r\n\r\n<p>1. <strong>Review the proposal PDF attached </strong>as this contains details of the system we're recommending and the possible benefits to you.</p>\r\n\r\n<p>2. Visit the link below to review and accept our terms if you are ready to proceed.</p>\r\n\r\n<p>[[quote_acceptance_link]]</p>\r\n\r\n<p>Thanks and don't hesitate to call us to discuss this further.</p>\r\n\r\n<p>Kind regards,</p>\r\n\r\n<p>[[user_full_name]]<br />\r\n[[business_name]]<br />\r\n[[business_email]]<br />\r\n[[primary_phone]]</p>\r\n\r\n<p> </p>\r\n",
"stc_value": 35.00,
"business_category_id": null,
"apply_gst": 0,
"bill_of_materials_notes": "",
"com_man_show_serials": 1,
"customer_rep_id": null,
"site_assessor_id": null,
"installer_id": null,
"designer_id": null,
"com_data": null,
"connection_diagram": "",
"array_restricted_access": 0,
"setting_use_cec": 1,
"setting_use_tax": 1,
"setting_tax_label": "GST",
"setting_tax_percent": 10.00,
"setting_quote_number": 4931,
"quote_show_customer": 0,
"quote_order": "a:16:{i:0;s:9:\"remainder\";i:1;s:7:\"package\";i:2;s:4:\"item\";i:3;s:8:\"inverter\";i:4;s:6:\"module\";i:5;s:8:\"mounting\";i:6;s:4:\"fuse\";i:7;s:4:\"mppt\";i:8;s:10:\"isolatorac\";i:9;s:10:\"isolatordc\";i:10;s:5:\"meter\";i:11;s:7:\"monitor\";i:12;s:6:\"manage\";i:13;s:17:\"batteryController\";i:14;s:7:\"battery\";i:15;s:9:\"optimiser\";}",
"quote_remainder": null,
"quote_conditions": null,
"email_performance": 1,
"quote_email_subject": "Quote for your solar power installation",
"tariff_escalation_rate": 5.0,
"fit_escalation_rate": null,
"degrad_rate": 0.5,
"degrad_rate_y2": 2.0,
"reinvest1_year": 10,
"lifecycle": 25,
"reinvest1": null,
"reinvest2_year": 15,
"reinvest2": null,
"mainten": null,
"discount_rate": 3.0,
"quote_sent": 1,
"hide_item_pricing": 1, // boolean 1 = true 0 = false
"structure_id": 70407,
"contact_id": 65917,
"yearly_profile_id": null,
"backup_type": 1,
"energy_control_profile_id": null,
"lgc_eligible": 0,
"tax_credit": 0,
"tax_credit_rate": 0.00,
"is_invoice": null,
"quote_valid_date": "2020-09-18",
"install_date": "0000-00-00 00:00:00",
"quote_approved_at": null,
"quote_features": null,
"quote_price_location": 0,
"show_hidden_component": 0,
"new_tariff_id": null,
"commissioning_notes": null,
"report_simple": 0,
"deprec_yr1_value": null,
"deprec_yr1_perc": null,
"deprec_subsequent_perc": null,
"nominal_tax_rate": null,
"use_design_page": 1, // boolean 1 = true 0 = false
"lgc_regression_rate": 0.0000
}
} |
Result:
{
"success": false,
"message": "Successfully updated system."
} |
Site survey
Fetching system via quote number includes site assessment data
Endpoint: /api/system?quote_number=<quote_number>
Example: https://go.solarplus.co/api/system?quote_number=5012
Request Method: GET
Result:
{
"success": true,
"message": "Successfully retrieved quotes.",
"data": {
"id": "119",
"name": "LKSSS-110920-07:37",
"quote_number": 5012,
"pv_kw_size": 0,
"total_panels": 0,
"module": [],
"inverter": [],
"battery_inverter": [],
"battery": [],
"site_assessment": {
"id": "1",
"site_id": "119",
"system_id": "119",
"contact_id": "65932",
"bldg_type": "0",
"bldg_stories": "1",
"bldg_height": "2.4",
"roof_material": "6",
"roof_extrusion": "123",
"roof_condition": "good",
"grid_underground": "1",
"grid_pillar_no": "123",
"array_length": "123",
"household_size": "2",
"load_type": "123",
"load_daily_kWh": "123",
"load_night_perc": "123",
"daily_kWh": "123",
"bldg_ess_habitable": "1",
"bldg_exterior_clad": "2",
"bldg_eave_height": "123.0",
"bldg_ess_shed": "1",
"bldg_ess_location_ok": "1",
"bldg_ess_habit_behind": "1",
"bldg_ess_habit_above": "1",
"bldg_ess_notes": "sample notes",
"created_user_id": "2288",
"created_at": "2021-06-22 20:04:39",
"updated_user_id": "2288",
"updated_at": "2021-06-22 22:27:34",
"cable_inverter_to_battery_length": null,
"bldg_status": "0",
"main_supply_switch_rating": "123",
"average_bill_cost_per_month": "123",
"aim_battery_storage": "2",
"timeframe_for_install": "2",
"is_energy_monitoring_priority": "0",
"finance": "1",
"any_rebates_applicable": "sample"
}
}
}Update Site Survey
Endpoint: /api/system/<system_id>
Example: http://go.solarplus.co/api/system/70
Request Method: PUT
JSON Payload
{
"siteAssessment" : {
"bldg_type": "0",
"bldg_stories": "1",
"bldg_height": "2.4",
"roof_material": "6",
"roof_extrusion": "123",
"roof_condition": "good",
"grid_underground": "1",
"grid_pillar_no": "123",
"array_length": "123",
"household_size": "2",
"load_type": "123",
"load_daily_kWh": "123",
"load_night_perc": "123",
"daily_kWh": "123",
"bldg_ess_habitable": "1",
"bldg_exterior_clad": "2",
"bldg_eave_height": "123.0",
"bldg_ess_shed": "1",
"bldg_ess_location_ok": "1",
"bldg_ess_habit_behind": "1",
"bldg_ess_habit_above": "1",
"bldg_ess_notes": "sample notes",
"created_user_id": "2288",
"created_at": "2021-06-22 20:04:39",
"updated_user_id": "2288",
"updated_at": "2021-06-22 22:27:34",
"cable_inverter_to_battery_length": null,
"bldg_status": "0",
"main_supply_switch_rating": "123",
"average_bill_cost_per_month": "123",
"aim_battery_storage": "2",
"timeframe_for_install": "2",
"is_energy_monitoring_priority": "0",
"finance": "1",
"any_rebates_applicable": "sample"
}
}Result:
{
"success": true,
"message": "Successfully updated site survey."
}, multiple selections available, Use left or right arrow keys to navigate selected items