Api session event editor building set function value
API Event to Set Function Value
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (BUILDING Integer ID) | Buildings | |
| 1 | REQUIRED | (Enumeration) | FunctionValue | ALIGN_ELEVATION, BASEMENT_COLOR, BASEMENT_HEIGHT_M, BOWEN_RATIO, CRITICAL_INFRASTRUCTURE, DEFAULT_FLOORS, DISTANCE_ZONE_M, DISTURBANCE_DISTANCE_M, DRAINAGE, EXTRA_COLOR, FLOOR_HEIGHT_M, FOLIAGE_CROWN_FACTOR, GROUND_COLOR, GROUND_INFILTRATION_MD, HEAT_EFFECT, HEIGHT_OFFSET_M, JAM_FACTOR_BUSES, JAM_FACTOR_CARS, JAM_FACTOR_TRUCKS, JAM_FACTOR_VANS, LIVABILITY_EFFECT, MAX_FLOORS, MIN_FLOORS, MONUMENTAL, NUM_AIRPLANES, NUM_BICYCLES, NUM_BUSES, NUM_CARS, NUM_PEDESTRIANS, NUM_SHIPS, NUM_TRAINS, NUM_TRAMS, NUM_TRUCKS, NUM_VANS, PIPES_PERMITTED, ROOF_COLOR, ROOT_DEPTH_M, SAFETY_DISTANCE_M, SEWERED, SLANTING_ROOF_HEIGHT, SOLAR_PANELS, SOLID, TERRAIN_MIX, TOP_COLOR, TRAFFIC_LANES, TRAFFIC_NOISE_SIGMA, TRAFFIC_NOISE_TAU, TRAFFIC_SPEED, VEGETATION_FRACTION, WATER_MANNING, WATER_MICRORELIEF_M, WATER_STORAGE_M2, WATER_TRANSPIRATION_FACTOR or ZONING_PERMIT_REQUIRED |
| 2 | REQUIRED | (Floating point number or multiple values in array [1.0, 2.0, 3.0]) | double[] |
Response Codes
| Response Code: | Description |
|---|---|
| 204 | No Content |
| 300-600 | Codes Overview |
Example POST
Example POST: https://engine.tygron.com/api/session/event/editorbuilding/set_function_value/?f=HTML&token=API_TOKEN
with content:
[ 56, "JAM_FACTOR_VANS", [ 1.0, 2.0, 3.0 ] ]