Api session event logic measurement line add: 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
43,025 edits
No edit summary
No edit summary
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Endpoint: api/session/event/logic/measurement_line_add/
API Endpoint: api/session/event/logic/measurement_line_add/


Description: Add a Line[[Measurement]] for an [[Overlay]] for a specific [[Timeframe]].
Description: Add a LineMeasurement for an [[Overlay]] for a specific [[Timeframe]].


{|class=wikitable
{|class=wikitable
!Name
!Index
!Importance
!Importance
!Type
!Type
Line 12: Line 12:
| 0
| 0
| REQUIRED
| REQUIRED
| (OVERLAY Integer ID or multiple values in array [1, 2, 3])
| (OVERLAY Integer ID or multiple integer values in array [1, 2, 3])
| [[Overlay]] IDs
| [[Overlay]] IDs
|  
|  
Line 19: Line 19:
| REQUIRED
| REQUIRED
| (Point with crs: EPSG:3857)
| (Point with crs: EPSG:3857)
| [[#Api Model Point|Point]] start
| [[Point]] start
|  
|  
|-
|-
Line 25: Line 25:
| REQUIRED
| REQUIRED
| (Point with crs: EPSG:3857)
| (Point with crs: EPSG:3857)
| [[#Api Model Point|Point]] end
| [[Point]] end
|  
|  
|-
|-
Line 64: Line 64:
|}
|}
===Example POST===
===Example POST===
Curl example POST:
Curl example POST
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/logic/measurement_line_add/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/logic/measurement_line_add/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ 1, {
[ 1, {
  "type" : "Point",
  "type" : "Point",
  "coordinates" : [ 658789.9698575361, 6799365.821255894 ]
  "coordinates" : [ 658797.650397124, 6799437.237235598 ]
}, {
}, {
  "type" : "Point",
  "type" : "Point",
  "coordinates" : [ 658748.8792143618, 6799371.304276127 ]
  "coordinates" : [ 658728.9234541768, 6799301.930376602 ]
}, "Name", -1, true, true ]
}, "Name", -1, true, true ]
'
'
</syntaxhighlight>
</syntaxhighlight>
Curl example multi item POST:
Curl example multi item POST
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/logic/measurement_line_add/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/logic/measurement_line_add/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ [ 1, 2, 3 ], {
[ [ 1, 2, 3 ], {
  "type" : "Point",
  "type" : "Point",
  "coordinates" : [ 658779.6809553816, 6799385.828775687 ]
  "coordinates" : [ 658699.9212559488, 6799332.816021241 ]
}, {
}, {
  "type" : "Point",
  "type" : "Point",
  "coordinates" : [ 658668.3285606514, 6799326.071094415 ]
  "coordinates" : [ 658669.0756632545, 6799449.0804085815 ]
}, "Name", -1, true, true ]
}, "Name", -1, true, true ]
'
'
</syntaxhighlight>
</syntaxhighlight>
JavaScript example POST:
JavaScript example POST
 
<syntaxhighlight lang="text" copy>var options = {
<syntaxhighlight lang="text" copy>var options = {
 method: "POST",
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, { "type" : "Point", "coordinates" : [ 658789.9698575361, 6799365.821255894 ]}, { "type" : "Point", "coordinates" : [ 658748.8792143618, 6799371.304276127 ]}, "Name", -1, true, true ]'
 body: '[ 1, { "type" : "Point", "coordinates" : [ 658797.650397124, 6799437.237235598 ]}, { "type" : "Point", "coordinates" : [ 658728.9234541768, 6799301.930376602 ]}, "Name", -1, true, true ]'
};
};
fetch("https://engine.tygron.com/api/session/event/logic/measurement_line_add/?crs=3857", options)
fetch("https://engine.tygron.com/api/session/event/logic/measurement_line_add/?crs=3857", options)

Latest revision as of 13:03, 19 June 2026

API Endpoint: api/session/event/logic/measurement_line_add/

Description: Add a LineMeasurement for an Overlay for a specific Timeframe.

Index Importance Type Description Values
0 REQUIRED (OVERLAY Integer ID or multiple integer values in array [1, 2, 3]) Overlay IDs
1 REQUIRED (Point with crs: EPSG:3857) Point start
2 REQUIRED (Point with crs: EPSG:3857) Point end
3 REQUIRED (String) Name
4 REQUIRED (Integer number) Timeframe (-1 for automatic last)
5 REQUIRED (true, false) Save Measurement true or false
6 REQUIRED (true, false) Sum true or false

Response Codes

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

Example POST

Curl example POST 

curl 'https://engine.tygron.com/api/session/event/logic/measurement_line_add/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ 1, {
 "type" : "Point",
 "coordinates" : [ 658797.650397124, 6799437.237235598 ]
}, {
 "type" : "Point",
 "coordinates" : [ 658728.9234541768, 6799301.930376602 ]
}, "Name", -1, true, true ]
'

Curl example multi item POST 

curl 'https://engine.tygron.com/api/session/event/logic/measurement_line_add/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ [ 1, 2, 3 ], {
 "type" : "Point",
 "coordinates" : [ 658699.9212559488, 6799332.816021241 ]
}, {
 "type" : "Point",
 "coordinates" : [ 658669.0756632545, 6799449.0804085815 ]
}, "Name", -1, true, true ]
'

JavaScript example POST 

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, { "type" : "Point", "coordinates" : [ 658797.650397124, 6799437.237235598 ]}, { "type" : "Point", "coordinates" : [ 658728.9234541768, 6799301.930376602 ]}, "Name", -1, true, true ]'
};
fetch("https://engine.tygron.com/api/session/event/logic/measurement_line_add/?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_logic_measurement_line_add&oldid=87371"