Api session event editor overlay set rasterization: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 10: | Line 10: | ||
!Values | !Values | ||
|- | |- | ||
|0 | | 0 | ||
|REQUIRED | | REQUIRED | ||
|(OVERLAY Integer ID) | | (OVERLAY Integer ID) | ||
|[[Overlay]] ID (must relate to an Average, Combo or Distance [[Overlay]]) | | [[Overlay]] ID (must relate to an Average, Combo or Distance [[Overlay]]) | ||
| | | | ||
|- | |- | ||
|1 | | 1 | ||
|REQUIRED | | REQUIRED | ||
|(Enumeration) | | (Enumeration) | ||
|Rasterization type: FIRST, MIN, MAX, SINGLE_[[Layer]], [[Grid]] | | Rasterization type: FIRST, MIN, MAX, SINGLE_[[Layer]], [[Grid]] | ||
|FIRST, MAX, MIN, SINGLE_LAYER or GRID | | FIRST, MAX, MIN, SINGLE_LAYER or GRID | ||
|- | |- | ||
|2 | | 2 | ||
|OPTIONAL | | OPTIONAL | ||
|(Enumeration) | | (Enumeration) | ||
|[[Maplink]] (will only affect the SINGLE_[[Layer]] rasterization type): [[Building]]s, [[Terrain]]s, [[Area]]s, [[Neighborhood]]s | | [[Maplink]] (will only affect the SINGLE_[[Layer]] rasterization type): [[Building]]s, [[Terrain]]s, [[Area]]s, [[Neighborhood]]s | ||
| | | | ||
|} | |} | ||
===Response Codes=== | ===Response Codes=== | ||
| Line 33: | Line 33: | ||
!Description | !Description | ||
|- | |- | ||
|204 | | 204 | ||
|No Content | | No Content | ||
|- | |- | ||
|300-600 | | 300-600 | ||
|Codes Overview | | Codes Overview | ||
|} | |} | ||
===Example POST=== | ===Example POST=== | ||
Revision as of 11:41, 8 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));