Api session event editor overlay set rasterization: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
API | API Endpoint to Set the type of rasterization a specified AVG or Distance [[Overlay]] should do. | ||
{|class=wikitable | {|class=wikitable | ||
!Name | !Name | ||
| Line 39: | Line 39: | ||
Curl Example POST: | Curl Example POST: | ||
<syntaxhighlight lang="text" copy>curl 'https:// | <syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editoroverlay/set_rasterization/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "FIRST", "" ]' | ||
</syntaxhighlight> | </syntaxhighlight> | ||
JavaScript Example POST: | JavaScript Example POST: | ||
| Line 48: | Line 48: | ||
body: '[ 1, "FIRST", "" ]' | body: '[ 1, "FIRST", "" ]' | ||
}; | }; | ||
fetch("https:// | fetch("https://engine.tygron.com/api/session/event/editoroverlay/set_rasterization/", options) | ||
.then(response => response.text()) | .then(response => response.text()) | ||
.then(result => console.log(result)) | .then(result => console.log(result)) | ||
Revision as of 09:09, 10 April 2026
API Endpoint to Set the type of rasterization a specified AVG or Distance Overlay should do.
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (OVERLAY Integer ID) | Overlay ID (must relate to an AVG or Distance Overlay) | |
| 1 | REQUIRED | (Enumeration) | Rasterization type: FIRST, MIN, MAX, SINGLE_LAYER, GRID | FIRST, MAX, MIN, SINGLE_LAYER or GRID |
| 2 | OPTIONAL | (Enumeration) | MapLink (will only affect the SINGLE_LAYER rasterization type): BUILDINGS, TERRAINS, AREAS, NEIGHBORHOODS |
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/editoroverlay/set_rasterization/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "FIRST", "" ]'JavaScript Example POST:
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ 1, "FIRST", "" ]'
};
fetch("https://engine.tygron.com/api/session/event/editoroverlay/set_rasterization/", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));