Api session items terrains: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(18 intermediate revisions by the same user not shown)
Line 1: Line 1:
Api session items [[Terrain]] Endpoints.
Api session items [[Terrain]] Endpoint: /api/session/items/terrains/
 
Manipulate items with event: [[Api session event editor |Api session event editor ]].


Default Query:
Default Query:
<pre>https://engine.tygron.com/api/session/items/terrains/?f=JSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/terrains/?f=JSON&token=API_TOKEN</syntaxhighlight>
Example Response:
Example Response:
<pre>[ {
<syntaxhighlight lang="text" copy>[ {
   "current" : {
   "current" : {
     "type" : "MultiPolygon",
     "type" : "MultiPolygon",
Line 19: Line 17:
   "sourceIDs" : [ ],
   "sourceIDs" : [ ],
   "typeID" : 9,
   "typeID" : 9,
   "version" : 2
   "version" : 4
}, {
}, {
   "current" : {
   "current" : {
Line 33: Line 31:
   "sourceIDs" : [ ],
   "sourceIDs" : [ ],
   "typeID" : 9,
   "typeID" : 9,
   "version" : 1
   "version" : 7
} ]</pre>
} ]</syntaxhighlight>
==Limit Queries==
==Limit Queries==
version=100:  
version=100:  
<pre>https://engine.tygron.com/api/session/items/terrains/?version=100&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/terrains/?version=100&token=API_TOKEN</syntaxhighlight>
Pseudo-Mercator:  
Pseudo-Mercator:  
<pre>https://engine.tygron.com/api/session/items/terrains/?crs=3857&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/terrains/?crs=3857&token=API_TOKEN</syntaxhighlight>
Degrees:  
Degrees:  
<pre>https://engine.tygron.com/api/session/items/terrains/?crs=4326&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/terrains/?crs=4326&token=API_TOKEN</syntaxhighlight>
Amersfoort / RD New:  
Amersfoort / RD New:  
<pre>https://engine.tygron.com/api/session/items/terrains/?crs=28992&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/terrains/?crs=28992&token=API_TOKEN</syntaxhighlight>
Local Coordinates:  
Local Coordinates:  
<pre>https://engine.tygron.com/api/session/items/terrains/?crs=LOCAL&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/terrains/?crs=LOCAL&token=API_TOKEN</syntaxhighlight>
bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785:  
bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785:  
<pre>https://engine.tygron.com/api/session/items/terrains/?crs=3857&bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/terrains/?crs=3857&bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785&token=API_TOKEN</syntaxhighlight>
FOO:  
FOO:  
<pre>https://engine.tygron.com/api/session/items/terrains-foo/?crs=3857&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/terrains-foo/?crs=3857&token=API_TOKEN</syntaxhighlight>
==Show Queries==
==Show Queries==
max version:  
max version:  
<pre>https://engine.tygron.com/api/session/items/terrains/version/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/terrains/version/?token=API_TOKEN</syntaxhighlight>
size:  
size:  
<pre>https://engine.tygron.com/api/session/items/terrains/size/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/terrains/size/?token=API_TOKEN</syntaxhighlight>
==Formats==
==Formats==
HTML:  
HTML:  
<pre>https://engine.tygron.com/api/session/items/terrains/?f=HTML&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/terrains/?f=HTML&token=API_TOKEN</syntaxhighlight>
JSON:  
JSON:  
<pre>https://engine.tygron.com/api/session/items/terrains/?f=JSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/terrains/?f=JSON&token=API_TOKEN</syntaxhighlight>
GEOJSON:  
GEOJSON:  
<pre>https://engine.tygron.com/api/session/items/terrains/?f=GEOJSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/terrains/?f=GEOJSON&token=API_TOKEN</syntaxhighlight>
GPKG:  
GPKG:  
<pre>https://engine.tygron.com/api/session/items/terrains/?f=GPKG&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/terrains/?f=GPKG&token=API_TOKEN</syntaxhighlight>
DXF:  
DXF:  
<pre>https://engine.tygron.com/api/session/items/terrains/?f=DXF&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/terrains/?f=DXF&token=API_TOKEN</syntaxhighlight>
CSV:  
CSV:  
<pre>https://engine.tygron.com/api/session/items/terrains/?f=CSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/terrains/?f=CSV&token=API_TOKEN</syntaxhighlight>
SSV:  
SSV:  
<pre>https://engine.tygron.com/api/session/items/terrains/?f=SSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/terrains/?f=SSV&token=API_TOKEN</syntaxhighlight>
SMILE:  
SMILE:  
<pre>https://engine.tygron.com/api/session/items/terrains/?f=SMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/terrains/?f=SMILE&token=API_TOKEN</syntaxhighlight>
ZIPJSON:  
ZIPJSON:  
<pre>https://engine.tygron.com/api/session/items/terrains/?f=ZIPJSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/terrains/?f=ZIPJSON&token=API_TOKEN</syntaxhighlight>
ZIPSMILE:  
ZIPSMILE:  
<pre>https://engine.tygron.com/api/session/items/terrains/?f=ZIPSMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/terrains/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
==Api Model GeometryCollection==
API Model description of GeometryCollection
 
{|class=wikitable
!Name
!Type
!Description
|}
 
==Api Model MultiPolygon==
API Model description of MultiPolygon
 
{|class=wikitable
!Name
!Type
!Description
|-
|type
|String
|[[#Api Model MultiPolygon|MultiPolygon]]
|-
|coordinates
|double[][][][]
|array of polygons; polygon is array of outer and optional inner rings; rings is array of coordinates; coordinates is array of [x,y,(optional) z]
|}
 
==Api Model Terrain==
API Model description of Terrain
 
{|class=wikitable
!Name
!Type
!Description
|-
|current
|MultiPolygon
|
|-
|heightValuesCurrent
|double[]
|
|-
|heightValuesMaquette
|double[]
|
|-
|id
|int
|
|-
|maquette
|MultiPolygon
|
|-
|name
|String
|
|-
|showSatellite
|boolean
|
|-
|sourceIDs
|int<nowiki>[]</nowiki>
|[[Source]] ID
|-
|typeID
|int
|[[Terrain Type]] ID
|-
|version
|int
|
|}
 
{{article end|seealso=*[[Api Content Items]]
{{article end|seealso=*[[Api Content Items]]
*[[Api session event editor ]]
*[[Api session event editor]]
}}
}}


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

Latest revision as of 12:08, 29 May 2026

Api session items Terrain Endpoint: /api/session/items/terrains/

Default Query:

https://engine.tygron.com/api/session/items/terrains/?f=JSON&token=API_TOKEN

Example Response:

[ {
  "current" : {
    "type" : "MultiPolygon",
    "coordinates" : [ [ [ [ 657093.832562376, 6800274.005242179 ], [ 657093.832562376, 6799664.916014099 ], [ 658068.3142186847, 6799664.916014099 ], [ 658068.3142186847, 6800274.005242179 ], [ 657093.832562376, 6800274.005242179 ] ] ] ]
  },
  "heightValuesCurrent" : null,
  "heightValuesMaquette" : null,
  "id" : 0,
  "maquette" : null,
  "name" : "1",
  "showSatellite" : true,
  "sourceIDs" : [ ],
  "typeID" : 9,
  "version" : 4
}, {
  "current" : {
    "type" : "MultiPolygon",
    "coordinates" : [ [ [ [ 658068.3142186847, 6800274.005242179 ], [ 658068.3142186847, 6799664.916014099 ], [ 659042.7958749932, 6799664.916014099 ], [ 659042.7958749932, 6800274.005242179 ], [ 658068.3142186847, 6800274.005242179 ] ] ] ]
  },
  "heightValuesCurrent" : null,
  "heightValuesMaquette" : null,
  "id" : 2,
  "maquette" : null,
  "name" : "3",
  "showSatellite" : true,
  "sourceIDs" : [ ],
  "typeID" : 9,
  "version" : 7
} ]

Limit Queries

version=100:

https://engine.tygron.com/api/session/items/terrains/?version=100&token=API_TOKEN

Pseudo-Mercator:

https://engine.tygron.com/api/session/items/terrains/?crs=3857&token=API_TOKEN

Degrees:

https://engine.tygron.com/api/session/items/terrains/?crs=4326&token=API_TOKEN

Amersfoort / RD New:

https://engine.tygron.com/api/session/items/terrains/?crs=28992&token=API_TOKEN

Local Coordinates:

https://engine.tygron.com/api/session/items/terrains/?crs=LOCAL&token=API_TOKEN

bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785:

https://engine.tygron.com/api/session/items/terrains/?crs=3857&bbox=658636.7618515313,6798649.869141218,659042.7958749933,6799055.882798785&token=API_TOKEN

FOO:

https://engine.tygron.com/api/session/items/terrains-foo/?crs=3857&token=API_TOKEN

Show Queries

max version:

https://engine.tygron.com/api/session/items/terrains/version/?token=API_TOKEN

size:

https://engine.tygron.com/api/session/items/terrains/size/?token=API_TOKEN

Formats

HTML:

https://engine.tygron.com/api/session/items/terrains/?f=HTML&token=API_TOKEN

JSON:

https://engine.tygron.com/api/session/items/terrains/?f=JSON&token=API_TOKEN

GEOJSON:

https://engine.tygron.com/api/session/items/terrains/?f=GEOJSON&token=API_TOKEN

GPKG:

https://engine.tygron.com/api/session/items/terrains/?f=GPKG&token=API_TOKEN

DXF:

https://engine.tygron.com/api/session/items/terrains/?f=DXF&token=API_TOKEN

CSV:

https://engine.tygron.com/api/session/items/terrains/?f=CSV&token=API_TOKEN

SSV:

https://engine.tygron.com/api/session/items/terrains/?f=SSV&token=API_TOKEN

SMILE:

https://engine.tygron.com/api/session/items/terrains/?f=SMILE&token=API_TOKEN

ZIPJSON:

https://engine.tygron.com/api/session/items/terrains/?f=ZIPJSON&token=API_TOKEN

ZIPSMILE:

https://engine.tygron.com/api/session/items/terrains/?f=ZIPSMILE&token=API_TOKEN

Api Model GeometryCollection

API Model description of GeometryCollection

Name Type Description

Api Model MultiPolygon

API Model description of MultiPolygon

Name Type Description
type String MultiPolygon
coordinates double[][][][] array of polygons; polygon is array of outer and optional inner rings; rings is array of coordinates; coordinates is array of [x,y,(optional) z]

Api Model Terrain

API Model description of Terrain

Name Type Description
current MultiPolygon
heightValuesCurrent double[]
heightValuesMaquette double[]
id int
maquette MultiPolygon
name String
showSatellite boolean
sourceIDs int[] Source ID
typeID int Terrain Type ID
version int