Api session event editor overlay add

From Tygron Support wiki
Jump to navigation Jump to search

API Endpoint: editoroverlay/add.

Description: Add a new Overlay of the specified type.

Name Importance Type Description Values
0 REQUIRED (Enumeration) OverlayType INFERENCE, AREA, ATTRIBUTE, AVG, COMBO, DISTANCE, FLOODING, FUNCTION, GEO_TIFF, GROUNDWATER, HEAT_STRESS, HEIGHTMAP, IMAGE, ITERATION, LIVABILITY, MUNICIPALITIES, NEIGHBORHOODS, NETWORK_DISTANCE, NETWORK_OVERVIEW, NETWORK_OWNERSHIP, OWNERSHIP, OWNERSHIP_GRID, RAINFALL, RESULT_CHILD, SATELLITE, SCENARIO, SHADOW, SIGHT_DISTANCE, SOURCE, TEST, TRAFFIC_DENSITY, TRAFFIC_NO2, TRAFFIC_NOISE, TRAVEL_DISTANCE, UNDERGROUND, WATERSHED, WCS, WMS, ZIP_CODES or ZONING

Response Codes

Response Code: Description
200 Integer (Overlay ID)
300-600 Codes Overview

Example POST

Curl example POST:

curl 'https://engine.tygron.com/api/session/event/editoroverlay/add/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '"OWNERSHIP"'

JavaScript example POST:

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