Api session event editor measure import terrains: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
37,736 edits
No edit summary
No edit summary
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Event to Import Measure Terrain Collection
API Endpoint: api/session/event/editormeasure/import_terrains/
 
Description: Import [[Measure]] [[Terrain]] Collection
 
{|class=wikitable
{|class=wikitable
!Name
!Name
Line 10: Line 13:
|REQUIRED
|REQUIRED
|(GeometryCollection with crs: EPSG:3857)
|(GeometryCollection with crs: EPSG:3857)
|Collection of Terrain Geometries
|Collection of [[Terrain]] Geometries
|
|
|-
|-
Line 16: Line 19:
|REQUIRED
|REQUIRED
|(Enumeration)
|(Enumeration)
|Measure Edit Type
|[[Measure]] Edit Type
|BUILDING, FLATTEN, GEOTIFF, GRID, LEVEE, RAISE, UPGRADE  or  WATER
|BUILDING, FLATTEN, GEOTIFF, GRID, LEVEE, RAISE, UPGRADE  or  WATER
|-
|-
Line 28: Line 31:
|REQUIRED
|REQUIRED
|(TERRAIN_TYPE Integer ID or multiple values in array [1, 2, 3])
|(TERRAIN_TYPE Integer ID or multiple values in array [1, 2, 3])
|Terrain Type IDs
|[[Terrain Type]] IDs
|
|
|-
|-
Line 34: Line 37:
|REQUIRED
|REQUIRED
|(Floating point number or multiple values in array [1.0, 2.0, 3.0])
|(Floating point number or multiple values in array [1.0, 2.0, 3.0])
|Override Inner Heights
|Override Inner [[Height sector]]
|
|
|-
|-
Line 46: Line 49:
|OPTIONAL
|OPTIONAL
|(MEASURE Integer ID)
|(MEASURE Integer ID)
|Set for existing Measure ID (optional)
|Set for existing [[Measure]] ID (optional)
|
|
|-
|-
Line 52: Line 55:
|OPTIONAL
|OPTIONAL
|(Floating point number)
|(Floating point number)
|Buffer for Points and Lines to make Polygons (optional)
|Buffer for [[#Api Model Point|Point]]s and Lines to make [[#Api Model Polygon|Polygon]]s (optional)
|
|
|-
|-
Line 58: Line 61:
|OPTIONAL
|OPTIONAL
|(SOURCE Integer ID)
|(SOURCE Integer ID)
|Source (optional)
|[[Source]] (optional)
|
|
|}
|}
Line 73: Line 76:
|}
|}
===Example POST===
===Example POST===
Example POST: https://engine.tygron.com/api/session/event/editormeasure/import_terrains/?crs=3857&f=HTML&token=API_TOKEN
Curl example POST:
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editormeasure/import_terrains/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ {
"type" : "GeometryCollection",
"geometries" : [ {
"type" : "MultiPolygon",
"coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]
} ]
}, "BUILDING", true, 1, 1.0, true ]
'
</syntaxhighlight>
Curl example multi item POST:


with content:  
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editormeasure/import_terrains/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
<pre>[ {
[ {
  "type" : "GeometryCollection",
  "type" : "GeometryCollection",
  "geometries" : [ {
  "geometries" : [ {
  "type" : "MultiPolygon",
  "type" : "MultiPolygon",
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799447.0437454 ], [ 658699.4535047539, 6799447.0437454 ], [ 658699.4535047539, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
  "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]
  }, {
  }, {
  "type" : "MultiPolygon",
  "type" : "MultiPolygon",
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799307.707316583 ], [ 658710.5496025471, 6799307.707316583 ], [ 658710.5496025471, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
  "coordinates" : [ [ [ [ 658646.762, 6799451.896 ], [ 658646.762, 6799461.896 ], [ 658656.762, 6799461.896 ], [ 658656.762, 6799451.896 ], [ 658646.762, 6799451.896 ] ] ] ]
  }, {
  }, {
  "type" : "MultiPolygon",
  "type" : "MultiPolygon",
  "coordinates" : [ [ [ [ 658636.7618515313, 6799461.8964563515 ], [ 658636.7618515313, 6799394.152399226 ], [ 658687.030487772, 6799394.152399226 ], [ 658687.030487772, 6799461.8964563515 ], [ 658636.7618515313, 6799461.8964563515 ] ] ] ]
  "coordinates" : [ [ [ [ 658656.762, 6799451.896 ], [ 658656.762, 6799461.896 ], [ 658666.762, 6799461.896 ], [ 658666.762, 6799451.896 ], [ 658656.762, 6799451.896 ] ] ] ]
  } ]
  } ]
}, "WATER", [ true, false, true ], [ 1, 2, 3 ], [ 1.0, 2.0, 3.0 ], [ true, false, true ], "", "", "" ]
}, "BUILDING", [ true, false, true ], [ 1, 2, 3 ], [ 1.0, 2.0, 3.0 ], [ true, false, true ] ]
</pre>
'
{{article end|seealso=*[[api session event editor measure]]}}
</syntaxhighlight>
JavaScript example POST:
 
<syntaxhighlight lang="text" copy>var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ { "type" : "GeometryCollection", "geometries" : [ { "type" : "MultiPolygon", "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ] } ]}, "BUILDING", true, 1, 1.0, true ]'
};
fetch("https://engine.tygron.com/api/session/event/editormeasure/import_terrains/?crs=3857", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));
</syntaxhighlight>
{{article end|seealso=*[[Api session event editor measure]]
*[[Api session items measures]]
}}


[[Category:API]]
[[Category:API]]

Latest revision as of 08:20, 29 May 2026

API Endpoint: api/session/event/editormeasure/import_terrains/

Description: Import Measure Terrain Collection

Name Importance Type Description Values
0 REQUIRED (GeometryCollection with crs: EPSG:3857) Collection of Terrain Geometries
1 REQUIRED (Enumeration) Measure Edit Type BUILDING, FLATTEN, GEOTIFF, GRID, LEVEE, RAISE, UPGRADE or WATER
2 REQUIRED (Boolean or multiple values in array [true, false, true]) Is Inner
3 REQUIRED (TERRAIN_TYPE Integer ID or multiple values in array [1, 2, 3]) Terrain Type IDs
4 REQUIRED (Floating point number or multiple values in array [1.0, 2.0, 3.0]) Override Inner Height sector
5 REQUIRED (Boolean or multiple values in array [true, false, true]) Height Relative
6 OPTIONAL (MEASURE Integer ID) Set for existing Measure ID (optional)
7 OPTIONAL (Floating point number) Buffer for Points and Lines to make Polygons (optional)
8 OPTIONAL (SOURCE Integer ID) Source (optional)

Response Codes

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

Example POST

Curl example POST: 

curl 'https://engine.tygron.com/api/session/event/editormeasure/import_terrains/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ {
 "type" : "GeometryCollection",
 "geometries" : [ {
 "type" : "MultiPolygon",
 "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]
 } ]
}, "BUILDING", true, 1, 1.0, true ]
'

Curl example multi item POST: 

curl 'https://engine.tygron.com/api/session/event/editormeasure/import_terrains/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ {
 "type" : "GeometryCollection",
 "geometries" : [ {
 "type" : "MultiPolygon",
 "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]
 }, {
 "type" : "MultiPolygon",
 "coordinates" : [ [ [ [ 658646.762, 6799451.896 ], [ 658646.762, 6799461.896 ], [ 658656.762, 6799461.896 ], [ 658656.762, 6799451.896 ], [ 658646.762, 6799451.896 ] ] ] ]
 }, {
 "type" : "MultiPolygon",
 "coordinates" : [ [ [ [ 658656.762, 6799451.896 ], [ 658656.762, 6799461.896 ], [ 658666.762, 6799461.896 ], [ 658666.762, 6799451.896 ], [ 658656.762, 6799451.896 ] ] ] ]
 } ]
}, "BUILDING", [ true, false, true ], [ 1, 2, 3 ], [ 1.0, 2.0, 3.0 ], [ true, false, true ] ]
'

JavaScript example POST: 

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ { "type" : "GeometryCollection", "geometries" : [ { "type" : "MultiPolygon", "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ] } ]}, "BUILDING", true, 1, 1.0, true ]'
};
fetch("https://engine.tygron.com/api/session/event/editormeasure/import_terrains/?crs=3857", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_event_editor_measure_import_terrains&oldid=81635"