|
|
| Line 1: |
Line 1: |
| API Endpoint: api/session/overlay | | API Endpoint: api/session/overlay |
|
| |
| ===GET geotiff===
| |
| API Endpoint: api/session/overlay.geotiff
| |
|
| |
| Content-Type: application/json
| |
|
| |
| '''Parameters:'''
| |
| {|class=wikitable
| |
| !Name
| |
| !Location
| |
| !Type
| |
| !Default value
| |
| |-
| |
| | format
| |
| | Path
| |
| | String
| |
| |
| |
| |-
| |
| | crs
| |
| | Query
| |
| | String
| |
| | EPSG:3857
| |
| |-
| |
| | id
| |
| | Query
| |
| | Integer
| |
| | -1
| |
| |-
| |
| | maptype
| |
| | Query
| |
| | [[Map Type]]
| |
| | MAQUETTE
| |
| |-
| |
| | difference
| |
| | Query
| |
| | boolean
| |
| | false
| |
| |-
| |
| | timeframe
| |
| | Query
| |
| | int
| |
| | 0
| |
| |-
| |
| | scale
| |
| | Query
| |
| | double
| |
| | 1
| |
| |-
| |
| | value
| |
| | Query
| |
| | [[HeightOperator]]
| |
| |
| |
| |-
| |
| | bbox
| |
| | Query
| |
| | String
| |
| |
| |
| |}
| |
|
| |
| ===='''Examples====
| |
| '''Complete Grid Overlay (upper-left is 0,0 and lower-right is 250,250)''':
| |
| <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.geotiff?id=ID&token=API_TOKEN</syntaxhighlight>
| |
|
| |
| '''Query with local gridcell BBOX (upper-left is 0,125 and lower-right is 125,250)''':
| |
| <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.geotiff?id=ID&bbox=0,125,125,250&token=API_TOKEN</syntaxhighlight>
| |
|
| |
| '''Query with Scale: 50% (scale=0.5)''':
| |
| <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.geotiff?id=ID&scale=0.5&token=API_TOKEN</syntaxhighlight>
| |
|
| |
| '''Query for Timeframe: 0 (timeframe=0''':
| |
| <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.geotiff?id=ID&timeframe=0&token=API_TOKEN</syntaxhighlight>
| |
|
| |
| '''Query for MapType: CURRENT (maptype=CURRENT)''':
| |
| <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.geotiff?id=ID&maptype=CURRENT&token=API_TOKEN</syntaxhighlight>
| |
|
| |
| '''Query for export CRS: EPSG:3857''':
| |
| <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.geotiff?id=ID&crs=3857&token=API_TOKEN</syntaxhighlight>
| |
|
| |
| ===GET asciidxdy===
| |
| API Endpoint: api/session/overlay.asciidxdy
| |
|
| |
| Content-Type: application/json
| |
|
| |
| '''Parameters:'''
| |
| {|class=wikitable
| |
| !Name
| |
| !Location
| |
| !Type
| |
| !Default value
| |
| |-
| |
| | format
| |
| | Path
| |
| | String
| |
| |
| |
| |-
| |
| | crs
| |
| | Query
| |
| | String
| |
| | EPSG:3857
| |
| |-
| |
| | id
| |
| | Query
| |
| | Integer
| |
| | -1
| |
| |-
| |
| | maptype
| |
| | Query
| |
| | [[Map Type]]
| |
| | MAQUETTE
| |
| |-
| |
| | difference
| |
| | Query
| |
| | boolean
| |
| | false
| |
| |-
| |
| | timeframe
| |
| | Query
| |
| | int
| |
| | 0
| |
| |-
| |
| | scale
| |
| | Query
| |
| | double
| |
| | 1
| |
| |-
| |
| | value
| |
| | Query
| |
| | [[HeightOperator]]
| |
| |
| |
| |-
| |
| | bbox
| |
| | Query
| |
| | String
| |
| |
| |
| |}
| |
|
| |
| ===='''Examples====
| |
| '''Complete Grid Overlay (upper-left is 0,0 and lower-right is 250,250)''':
| |
| <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciidxdy?id=ID&token=API_TOKEN</syntaxhighlight>
| |
|
| |
| '''Query with local gridcell BBOX (upper-left is 0,125 and lower-right is 125,250)''':
| |
| <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciidxdy?id=ID&bbox=0,125,125,250&token=API_TOKEN</syntaxhighlight>
| |
|
| |
| '''Query with Scale: 50% (scale=0.5)''':
| |
| <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciidxdy?id=ID&scale=0.5&token=API_TOKEN</syntaxhighlight>
| |
|
| |
| '''Query for Timeframe: 0 (timeframe=0''':
| |
| <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciidxdy?id=ID&timeframe=0&token=API_TOKEN</syntaxhighlight>
| |
|
| |
| '''Query for MapType: CURRENT (maptype=CURRENT)''':
| |
| <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciidxdy?id=ID&maptype=CURRENT&token=API_TOKEN</syntaxhighlight>
| |
|
| |
| '''Query for export CRS: EPSG:3857''':
| |
| <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciidxdy?id=ID&crs=3857&token=API_TOKEN</syntaxhighlight>
| |
|
| |
| ===GET asciisquarem===
| |
| API Endpoint: api/session/overlay.asciisquarem
| |
|
| |
| Content-Type: application/json
| |
|
| |
| '''Parameters:'''
| |
| {|class=wikitable
| |
| !Name
| |
| !Location
| |
| !Type
| |
| !Default value
| |
| |-
| |
| | format
| |
| | Path
| |
| | String
| |
| |
| |
| |-
| |
| | crs
| |
| | Query
| |
| | String
| |
| | EPSG:3857
| |
| |-
| |
| | id
| |
| | Query
| |
| | Integer
| |
| | -1
| |
| |-
| |
| | maptype
| |
| | Query
| |
| | [[Map Type]]
| |
| | MAQUETTE
| |
| |-
| |
| | difference
| |
| | Query
| |
| | boolean
| |
| | false
| |
| |-
| |
| | timeframe
| |
| | Query
| |
| | int
| |
| | 0
| |
| |-
| |
| | scale
| |
| | Query
| |
| | double
| |
| | 1
| |
| |-
| |
| | value
| |
| | Query
| |
| | [[HeightOperator]]
| |
| |
| |
| |-
| |
| | bbox
| |
| | Query
| |
| | String
| |
| |
| |
| |}
| |
|
| |
| ===='''Examples====
| |
| '''Complete Grid Overlay (upper-left is 0,0 and lower-right is 250,250)''':
| |
| <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarem?id=ID&token=API_TOKEN</syntaxhighlight>
| |
|
| |
| '''Query with local gridcell BBOX (upper-left is 0,125 and lower-right is 125,250)''':
| |
| <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarem?id=ID&bbox=0,125,125,250&token=API_TOKEN</syntaxhighlight>
| |
|
| |
| '''Query with Scale: 50% (scale=0.5)''':
| |
| <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarem?id=ID&scale=0.5&token=API_TOKEN</syntaxhighlight>
| |
|
| |
| '''Query for Timeframe: 0 (timeframe=0''':
| |
| <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarem?id=ID&timeframe=0&token=API_TOKEN</syntaxhighlight>
| |
|
| |
| '''Query for MapType: CURRENT (maptype=CURRENT)''':
| |
| <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarem?id=ID&maptype=CURRENT&token=API_TOKEN</syntaxhighlight>
| |
|
| |
| '''Query for export CRS: EPSG:3857''':
| |
| <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarem?id=ID&crs=3857&token=API_TOKEN</syntaxhighlight>
| |
|
| |
| ===GET asciisquarecrs===
| |
| API Endpoint: api/session/overlay.asciisquarecrs
| |
|
| |
| Content-Type: application/json
| |
|
| |
| '''Parameters:'''
| |
| {|class=wikitable
| |
| !Name
| |
| !Location
| |
| !Type
| |
| !Default value
| |
| |-
| |
| | format
| |
| | Path
| |
| | String
| |
| |
| |
| |-
| |
| | crs
| |
| | Query
| |
| | String
| |
| | EPSG:3857
| |
| |-
| |
| | id
| |
| | Query
| |
| | Integer
| |
| | -1
| |
| |-
| |
| | maptype
| |
| | Query
| |
| | [[Map Type]]
| |
| | MAQUETTE
| |
| |-
| |
| | difference
| |
| | Query
| |
| | boolean
| |
| | false
| |
| |-
| |
| | timeframe
| |
| | Query
| |
| | int
| |
| | 0
| |
| |-
| |
| | scale
| |
| | Query
| |
| | double
| |
| | 1
| |
| |-
| |
| | value
| |
| | Query
| |
| | [[HeightOperator]]
| |
| |
| |
| |-
| |
| | bbox
| |
| | Query
| |
| | String
| |
| |
| |
| |}
| |
|
| |
| ===='''Examples====
| |
| '''Complete Grid Overlay (upper-left is 0,0 and lower-right is 250,250)''':
| |
| <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarecrs?id=ID&token=API_TOKEN</syntaxhighlight>
| |
|
| |
| '''Query with local gridcell BBOX (upper-left is 0,125 and lower-right is 125,250)''':
| |
| <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarecrs?id=ID&bbox=0,125,125,250&token=API_TOKEN</syntaxhighlight>
| |
|
| |
| '''Query with Scale: 50% (scale=0.5)''':
| |
| <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarecrs?id=ID&scale=0.5&token=API_TOKEN</syntaxhighlight>
| |
|
| |
| '''Query for Timeframe: 0 (timeframe=0''':
| |
| <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarecrs?id=ID&timeframe=0&token=API_TOKEN</syntaxhighlight>
| |
|
| |
| '''Query for MapType: CURRENT (maptype=CURRENT)''':
| |
| <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarecrs?id=ID&maptype=CURRENT&token=API_TOKEN</syntaxhighlight>
| |
|
| |
| '''Query for export CRS: EPSG:3857''':
| |
| <syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/overlay.asciisquarecrs?id=ID&crs=3857&token=API_TOKEN</syntaxhighlight>
| |
|
| |
|
| ===GET points=== | | ===GET points=== |
API Endpoint: api/session/overlay
GET points
API Endpoint: api/session/overlay.points
Content-Type: application/json
Parameters:
| Name
|
Location
|
Type
|
Default value
|
| format
|
Path
|
String
|
|
| crs
|
Query
|
String
|
EPSG:3857
|
| id
|
Query
|
Integer
|
-1
|
| maptype
|
Query
|
Map Type
|
MAQUETTE
|
| difference
|
Query
|
boolean
|
false
|
| timeframe
|
Query
|
int
|
0
|
| scale
|
Query
|
double
|
1
|
| value
|
Query
|
HeightOperator
|
|
| bbox
|
Query
|
String
|
|
Examples
GeoJSON: Legend Points (center):
https://engine.tygron.com/api/session/overlay.points?id=ID&token=API_TOKEN
GET polygons
API Endpoint: api/session/overlay.polygons
Content-Type: application/json
Parameters:
| Name
|
Location
|
Type
|
Default value
|
| format
|
Path
|
String
|
|
| crs
|
Query
|
String
|
EPSG:3857
|
| id
|
Query
|
Integer
|
-1
|
| maptype
|
Query
|
Map Type
|
MAQUETTE
|
| difference
|
Query
|
boolean
|
false
|
| timeframe
|
Query
|
int
|
0
|
| scale
|
Query
|
double
|
1
|
| value
|
Query
|
HeightOperator
|
|
| bbox
|
Query
|
String
|
|
Examples
GeoJSON: Legend Polygons:
https://engine.tygron.com/api/session/overlay.polygons?id=ID&token=API_TOKEN
GET multipolygons
API Endpoint: api/session/overlay.multipolygons
Content-Type: application/json
Parameters:
| Name
|
Location
|
Type
|
Default value
|
| format
|
Path
|
String
|
|
| crs
|
Query
|
String
|
EPSG:3857
|
| id
|
Query
|
Integer
|
-1
|
| maptype
|
Query
|
Map Type
|
MAQUETTE
|
| difference
|
Query
|
boolean
|
false
|
| timeframe
|
Query
|
int
|
0
|
| scale
|
Query
|
double
|
1
|
| value
|
Query
|
HeightOperator
|
|
| bbox
|
Query
|
String
|
|
Examples
GeoJSON: Legend MultiPolygons:
https://engine.tygron.com/api/session/overlay.multipolygons?id=ID&token=API_TOKEN
GET gpkgpoints
API Endpoint: api/session/overlay.gpkgpoints
Content-Type: application/json
Parameters:
| Name
|
Location
|
Type
|
Default value
|
| format
|
Path
|
String
|
|
| crs
|
Query
|
String
|
EPSG:3857
|
| id
|
Query
|
Integer
|
-1
|
| maptype
|
Query
|
Map Type
|
MAQUETTE
|
| difference
|
Query
|
boolean
|
false
|
| timeframe
|
Query
|
int
|
0
|
| scale
|
Query
|
double
|
1
|
| value
|
Query
|
HeightOperator
|
|
| bbox
|
Query
|
String
|
|
Examples
GeoPackage: Legend Points (center):
https://engine.tygron.com/api/session/overlay.gpkgpoints?id=ID&token=API_TOKEN
GET gpkgpolygons
API Endpoint: api/session/overlay.gpkgpolygons
Content-Type: application/json
Parameters:
| Name
|
Location
|
Type
|
Default value
|
| format
|
Path
|
String
|
|
| crs
|
Query
|
String
|
EPSG:3857
|
| id
|
Query
|
Integer
|
-1
|
| maptype
|
Query
|
Map Type
|
MAQUETTE
|
| difference
|
Query
|
boolean
|
false
|
| timeframe
|
Query
|
int
|
0
|
| scale
|
Query
|
double
|
1
|
| value
|
Query
|
HeightOperator
|
|
| bbox
|
Query
|
String
|
|
Examples
GeoPackage: Legend Polygons:
https://engine.tygron.com/api/session/overlay.gpkgpolygons?id=ID&token=API_TOKEN
GET gpkgmultipolygons
API Endpoint: api/session/overlay.gpkgmultipolygons
Content-Type: application/json
Parameters:
| Name
|
Location
|
Type
|
Default value
|
| format
|
Path
|
String
|
|
| crs
|
Query
|
String
|
EPSG:3857
|
| id
|
Query
|
Integer
|
-1
|
| maptype
|
Query
|
Map Type
|
MAQUETTE
|
| difference
|
Query
|
boolean
|
false
|
| timeframe
|
Query
|
int
|
0
|
| scale
|
Query
|
double
|
1
|
| value
|
Query
|
HeightOperator
|
|
| bbox
|
Query
|
String
|
|
Examples
GeoPackage: Legend MultiPolygons:
https://engine.tygron.com/api/session/overlay.gpkgmultipolygons?id=ID&token=API_TOKEN