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 Endpoint: api/session/event/editoroverlay/set_rasterization/ | API Endpoint: api/session/event/editoroverlay/set_rasterization/ | ||
Description: Set the type of rasterization a specified | Description: Set the type of rasterization a specified Average, Combo or Distance [[Overlay]] should do. | ||
{|class=wikitable | {|class=wikitable | ||
| Line 13: | Line 13: | ||
|REQUIRED | |REQUIRED | ||
|(OVERLAY Integer ID) | |(OVERLAY Integer ID) | ||
|[[Overlay]] ID (must relate to an | |[[Overlay]] ID (must relate to an Average, Combo or Distance [[Overlay]]) | ||
| | | | ||
|- | |- | ||
| Line 19: | Line 19: | ||
|REQUIRED | |REQUIRED | ||
|(Enumeration) | |(Enumeration) | ||
|Rasterization type: FIRST, MIN, MAX, | |Rasterization type: FIRST, MIN, MAX, SINGLE_[[Layer]], [[Grid]] | ||
|FIRST, MAX, MIN, SINGLE_LAYER or GRID | |FIRST, MAX, MIN, SINGLE_LAYER or GRID | ||
|- | |- | ||
| Line 25: | Line 25: | ||
|OPTIONAL | |OPTIONAL | ||
|(Enumeration) | |(Enumeration) | ||
|[[Maplink]] (will only affect the | |[[Maplink]] (will only affect the SINGLE_[[Layer]] rasterization type): [[Building]]s, [[Terrain]]s, [[Area]]s, [[Neighborhood]]s | ||
| | | | ||
|} | |} | ||
| Line 42: | Line 42: | ||
Curl example POST: | Curl example POST: | ||
<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 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 49: | Line 49: | ||
method: "POST", | method: "POST", | ||
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | ||
body: '[ 1, "FIRST | body: '[ 1, "FIRST" ]' | ||
}; | }; | ||
fetch("https://engine.tygron.com/api/session/event/editoroverlay/set_rasterization/", options) | fetch("https://engine.tygron.com/api/session/event/editoroverlay/set_rasterization/", options) | ||
Latest revision as of 14:47, 2 June 2026
API Endpoint: api/session/event/editoroverlay/set_rasterization/
Description: Set the type of rasterization a specified Average, Combo or Distance Overlay should do.
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (OVERLAY Integer ID) | Overlay ID (must relate to an Average, Combo 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));