Api session event editor building reset category values

From Tygron Support wiki
Jump to navigation Jump to search

API Endpoint: editorbuilding/reset_category_values.

Description: Reset Category Values

Name Importance Type Description Values
0 REQUIRED (BUILDING Integer ID) Building
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 (CategoryValue or multiple values in array [a, b, c]) Category Value[]

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/editorbuilding/reset_category_values/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "SOCIAL", "CATEGORY_WEIGHT" ]'

Curl example multi item POST:

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

JavaScript example POST:

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