Get Shading Scene Viewer
curl --request GET \
--url https://api.example.com/shadingscenes/{scene_id}/viewerimport requests
url = "https://api.example.com/shadingscenes/{scene_id}/viewer"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/shadingscenes/{scene_id}/viewer', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/shadingscenes/{scene_id}/viewer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/shadingscenes/{scene_id}/viewer"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/shadingscenes/{scene_id}/viewer")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/shadingscenes/{scene_id}/viewer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyShading Scenes
Get Shading Scene Viewer
Get a read-optimized 3D viewer payload for a shading scene
GET
/
shadingscenes
/
{scene_id}
/
viewer
Get Shading Scene Viewer
curl --request GET \
--url https://api.example.com/shadingscenes/{scene_id}/viewerimport requests
url = "https://api.example.com/shadingscenes/{scene_id}/viewer"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/shadingscenes/{scene_id}/viewer', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/shadingscenes/{scene_id}/viewer",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/shadingscenes/{scene_id}/viewer"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/shadingscenes/{scene_id}/viewer")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/shadingscenes/{scene_id}/viewer")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyGET /shadingscenes//viewer
Retrieve a read-optimized payload designed for rendering a shading scene in a 3D viewer. This endpoint returns pre-processed geometry, obstruction, and shading data structured for direct consumption by visualization clients.Notes
- This is a read-optimized endpoint tailored for 3D rendering, not a general-purpose scene retrieval. Use GET /shadingscenes/ for the full scene record.
- Query parameters control which data layers are included:
include_geometry(defaulttrue) — table and module geometry.include_obstructions(defaulttrue) — obstruction mesh data.include_shading(defaulttrue) — shading simulation overlay data.
aggregatecontrols the shading aggregation level:"table"(default) for per-table factors or"scene"for whole-scene averages.azimuth_binandelevation_binoptionally filter shading data to a specific sun position bin.- Returns
404if the scene does not exist. - The response payload is sanitized for safe client consumption and may be large depending on scene complexity.
