Api session event logic measurement line add: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older editNewer edit →
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
43,025 edits
No edit summary
No edit summary
Line 10: Line 10:
!Values
!Values
|-
|-
|0
| 0
|REQUIRED
| REQUIRED
|(OVERLAY Integer ID or multiple values in array [1, 2, 3])
| (OVERLAY Integer ID or multiple values in array [1, 2, 3])
|[[Overlay]] IDs
| [[Overlay]] IDs
|
|  
|-
|-
|1
| 1
|REQUIRED
| REQUIRED
|(Point with crs: EPSG:3857)
| (Point with crs: EPSG:3857)
|[[#Api Model Point|Point]] start
| [[#Api Model Point|Point]] start
|
|  
|-
|-
|2
| 2
|REQUIRED
| REQUIRED
|(Point with crs: EPSG:3857)
| (Point with crs: EPSG:3857)
|[[#Api Model Point|Point]] end
| [[#Api Model Point|Point]] end
|
|  
|-
|-
|3
| 3
|REQUIRED
| REQUIRED
|(String)
| (String)
|Name
| Name
|
|  
|-
|-
|4
| 4
|REQUIRED
| REQUIRED
|(Integer number)
| (Integer number)
|[[Timeframe]] (-1 for automatic last)
| [[Timeframe]] (-1 for automatic last)
|
|  
|-
|-
|5
| 5
|REQUIRED
| REQUIRED
|(true, false)
| (true, false)
|Save [[Measurement]]
| Save [[Measurement]]
|true  or  false
| true  or  false
|-
|-
|6
| 6
|REQUIRED
| REQUIRED
|(true, false)
| (true, false)
|Sum
| Sum
|true  or  false
| true  or  false
|}
|}
===Response Codes===
===Response Codes===
Line 57: Line 57:
!Description
!Description
|-
|-
|200
| 200
|Integer (Measurement ID)
| Integer (Measurement ID)
|-
|-
|300-600
| 300-600
|Codes Overview
| Codes Overview
|}
|}
===Example POST===
===Example POST===
Line 69: Line 69:
[ 1, {
[ 1, {
  "type" : "Point",
  "type" : "Point",
  "coordinates" : [ 658719.2630926905, 6799322.782274678 ]
  "coordinates" : [ 658789.9698575361, 6799365.821255894 ]
}, {
}, {
  "type" : "Point",
  "type" : "Point",
  "coordinates" : [ 658798.7954130701, 6799315.42181975 ]
  "coordinates" : [ 658748.8792143618, 6799371.304276127 ]
}, "Name", -1, true, true ]
}, "Name", -1, true, true ]
'
'
Line 81: Line 81:
[ [ 1, 2, 3 ], {
[ [ 1, 2, 3 ], {
  "type" : "Point",
  "type" : "Point",
  "coordinates" : [ 658689.8581087114, 6799445.903604035 ]
  "coordinates" : [ 658779.6809553816, 6799385.828775687 ]
}, {
}, {
  "type" : "Point",
  "type" : "Point",
  "coordinates" : [ 658707.0918168032, 6799332.859872217 ]
  "coordinates" : [ 658668.3285606514, 6799326.071094415 ]
}, "Name", -1, true, true ]
}, "Name", -1, true, true ]
'
'
Line 93: Line 93:
 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" : [ 658719.2630926905, 6799322.782274678 ]}, { "type" : "Point", "coordinates" : [ 658798.7954130701, 6799315.42181975 ]}, "Name", -1, true, true ]'
 body: '[ 1, { "type" : "Point", "coordinates" : [ 658789.9698575361, 6799365.821255894 ]}, { "type" : "Point", "coordinates" : [ 658748.8792143618, 6799371.304276127 ]}, "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)

Revision as of 11:43, 8 June 2026

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

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

Name Importance Type Description Values
0 REQUIRED (OVERLAY Integer ID or multiple 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" : [ 658789.9698575361, 6799365.821255894 ]
}, {
 "type" : "Point",
 "coordinates" : [ 658748.8792143618, 6799371.304276127 ]
}, "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" : [ 658779.6809553816, 6799385.828775687 ]
}, {
 "type" : "Point",
 "coordinates" : [ 658668.3285606514, 6799326.071094415 ]
}, "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" : [ 658789.9698575361, 6799365.821255894 ]}, { "type" : "Point", "coordinates" : [ 658748.8792143618, 6799371.304276127 ]}, "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=84305"