Api session event editor functionoverride set category value

From Tygron Support wiki
Jump to navigation Jump to search

API Endpoint: editorfunctionoverride/set_category_value.

Description: Set Category Value

Name Importance Type Description Values
0 REQUIRED (FUNCTION Integer ID) Function
1 REQUIRED (Enumeration) Category AGRICULTURE, BRIDGE, EDUCATION, GARDEN, HEALTHCARE, INDUSTRY, INTERSECTION, LEISURE, LUXE, NATURE, NORMAL, OFFICES, OTHER, PARK, PAVED_AREA, ROAD, SENIOR, SHOPPING, SOCIAL, STUDENT or UNDERGROUND
2 REQUIRED (Enumeration) Category Value BUYOUT_COST_M2, CATEGORY_WEIGHT, CONSTRUCTION_COST_M2, DEMOLISH_COST_M2, HEAT_FLOW_M2_CHANGE_PER_YEAR, HEAT_FLOW_M2_START_VALUE, HEAT_FLOW_M2_START_YEAR, HEAT_POWER_TO_FLOW_MULTIPLIER, PARKING_LOTS_DEMAND_PER_M2, PARKING_LOTS_PER_M2, SELL_PRICE_M2 or UNIT_SIZE_M2
3 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

Curl example POST:

curl 'https://engine.tygron.com/api/session/event/editorfunctionoverride/set_category_value/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "SOCIAL", "CATEGORY_WEIGHT", 1.0 ]'

Curl example multi item POST:

curl 'https://engine.tygron.com/api/session/event/editorfunctionoverride/set_category_value/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "SOCIAL", "CATEGORY_WEIGHT", [ 1.0, 2.0, 3.0 ] ]'

JavaScript example POST:

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, "SOCIAL", "CATEGORY_WEIGHT", 1.0 ]'
};
fetch("https://engine.tygron.com/api/session/event/editorfunctionoverride/set_category_value/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));