Api session event logic measurement point add: Difference between revisions
Jump to navigation
Jump to search
Created page with "API Endpoint: api/session/event/logic/measurement_point_add/ Description: Add a PointMeasurement for an Overlay. {|class=wikitable !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 | |- |2 |REQUIRED |(String) |Name | |- |3 |REQUIRED |(true, false) |Save Measurement |true or..." |
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]] | | [[#Api Model Point|Point]] | ||
| | | | ||
|- | |- | ||
|2 | | 2 | ||
|REQUIRED | | REQUIRED | ||
|(String) | | (String) | ||
|Name | | Name | ||
| | | | ||
|- | |- | ||
|3 | | 3 | ||
|REQUIRED | | REQUIRED | ||
|(true, false) | | (true, false) | ||
|Save [[Measurement]] | | Save [[Measurement]] | ||
|true or false | | true or false | ||
|- | |- | ||
|4 | | 4 | ||
|REQUIRED | | REQUIRED | ||
|(true, false) | | (true, false) | ||
|Sum | | Sum | ||
|true or false | | true or false | ||
|} | |} | ||
===Response Codes=== | ===Response Codes=== | ||
| Line 45: | Line 45: | ||
!Description | !Description | ||
|- | |- | ||
|200 | | 200 | ||
|Integer (Measurement ID) | | Integer (Measurement ID) | ||
|- | |- | ||
|300-600 | | 300-600 | ||
|Codes Overview | | Codes Overview | ||
|} | |} | ||
===Example POST=== | ===Example POST=== | ||
| Line 57: | Line 57: | ||
[ 1, { | [ 1, { | ||
"type" : "Point", | "type" : "Point", | ||
"coordinates" : [ | "coordinates" : [ 658660.9874655071, 6799365.541907811 ] | ||
}, "Name", true, true ] | }, "Name", true, true ] | ||
' | ' | ||
| Line 66: | Line 66: | ||
[ [ 1, 2, 3 ], { | [ [ 1, 2, 3 ], { | ||
"type" : "Point", | "type" : "Point", | ||
"coordinates" : [ | "coordinates" : [ 658654.1807111378, 6799338.977897664 ] | ||
}, "Name", true, true ] | }, "Name", true, true ] | ||
' | ' | ||
| Line 75: | Line 75: | ||
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" : [ | body: '[ 1, { "type" : "Point", "coordinates" : [ 658660.9874655071, 6799365.541907811 ]}, "Name", true, true ]' | ||
}; | }; | ||
fetch("https://engine.tygron.com/api/session/event/logic/measurement_point_add/?crs=3857", options) | fetch("https://engine.tygron.com/api/session/event/logic/measurement_point_add/?crs=3857", options) | ||
Revision as of 11:43, 8 June 2026
API Endpoint: api/session/event/logic/measurement_point_add/
Description: Add a PointMeasurement for an Overlay.
| 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 | |
| 2 | REQUIRED | (String) | Name | |
| 3 | REQUIRED | (true, false) | Save Measurement | true or false |
| 4 | 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_point_add/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ 1, {
"type" : "Point",
"coordinates" : [ 658660.9874655071, 6799365.541907811 ]
}, "Name", true, true ]
'Curl example multi item POST:
curl 'https://engine.tygron.com/api/session/event/logic/measurement_point_add/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ [ 1, 2, 3 ], {
"type" : "Point",
"coordinates" : [ 658654.1807111378, 6799338.977897664 ]
}, "Name", true, true ]
'JavaScript example POST:
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ 1, { "type" : "Point", "coordinates" : [ 658660.9874655071, 6799365.541907811 ]}, "Name", true, true ]'
};
fetch("https://engine.tygron.com/api/session/event/logic/measurement_point_add/?crs=3857", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));