Get GCR Properties
curl --request GET \
--url https://api.example.com/shadingscenes/{scene_id}/gcrimport requests
url = "https://api.example.com/shadingscenes/{scene_id}/gcr"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/shadingscenes/{scene_id}/gcr', 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}/gcr",
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}/gcr"
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}/gcr")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/shadingscenes/{scene_id}/gcr")
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 GCR Properties
Get computed Ground Coverage Ratio properties for a shading scene
GET
/
shadingscenes
/
{scene_id}
/
gcr
Get GCR Properties
curl --request GET \
--url https://api.example.com/shadingscenes/{scene_id}/gcrimport requests
url = "https://api.example.com/shadingscenes/{scene_id}/gcr"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/shadingscenes/{scene_id}/gcr', 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}/gcr",
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}/gcr"
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}/gcr")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/shadingscenes/{scene_id}/gcr")
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//gcr
Retrieve the computed Ground Coverage Ratio (GCR) properties for a shading scene. GCR describes the ratio of module area to total ground area and is a key input for tracker backtracking and inter-row shading calculations.Notes
- GCR properties are derived from the scene geometry and stored within the scene JSON as
gcrProperties. - Returns
404if the scene does not exist or if no GCR properties have been computed for the scene. - GCR data is typically available after scene creation or import once the geometry has been processed.
- This endpoint is useful for validating tracker configuration inputs and understanding the physical layout density of a scene.
- Related: POST /shadingscenes//trackinginputs uses GCR as a required parameter for tracker angle configuration.
