Api session event editor netload import: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 10: | Line 10: | ||
!Values | !Values | ||
|- | |- | ||
|0 | | 0 | ||
|REQUIRED | | REQUIRED | ||
|(GeometryCollection with crs: EPSG:3857) | | (GeometryCollection with crs: EPSG:3857) | ||
|GeometryCollection | | GeometryCollection | ||
| | | | ||
|- | |- | ||
|1 | | 1 | ||
|REQUIRED | | REQUIRED | ||
|(String or multiple values in array ["a", "b", "c"]) | | (String or multiple values in array ["a", "b", "c"]) | ||
|String[] | | String[] | ||
| | | | ||
|- | |- | ||
|2 | | 2 | ||
|REQUIRED | | REQUIRED | ||
|(NetType or multiple values in array [a, b, c]) | | (NetType or multiple values in array [a, b, c]) | ||
|[[Net Type]][] | | [[Net Type]][] | ||
| | | | ||
|- | |- | ||
|3 | | 3 | ||
|REQUIRED | | REQUIRED | ||
|(TimeState or multiple values in array [a, b, c]) | | (TimeState or multiple values in array [a, b, c]) | ||
|[[Timestate]][] | | [[Timestate]][] | ||
| | | | ||
|- | |- | ||
|4 | | 4 | ||
|REQUIRED | | REQUIRED | ||
|(String or multiple values in array ["a", "b", "c"]) | | (String or multiple values in array ["a", "b", "c"]) | ||
|String[] | | String[] | ||
| | | | ||
|- | |- | ||
|5 | | 5 | ||
|REQUIRED | | REQUIRED | ||
|(String or multiple values in array ["a", "b", "c"]) | | (String or multiple values in array ["a", "b", "c"]) | ||
|String[] | | String[] | ||
| | | | ||
|- | |- | ||
|6 | | 6 | ||
|REQUIRED | | REQUIRED | ||
|(Floating point number or multiple values in array [1.0, 2.0, 3.0] or matrix [[1.0, 2.0], [3.0, 4.0], [5.0, 6.0]]) | | (Floating point number or multiple values in array [1.0, 2.0, 3.0] or matrix [[1.0, 2.0], [3.0, 4.0], [5.0, 6.0]]) | ||
|double[][] | | double[][] | ||
| | | | ||
|- | |- | ||
|7 | | 7 | ||
|REQUIRED | | REQUIRED | ||
|(Integer number) | | (Integer number) | ||
|Integer | | Integer | ||
| | | | ||
|- | |- | ||
|8 | | 8 | ||
|REQUIRED | | REQUIRED | ||
|(Floating point number) | | (Floating point number) | ||
|Double | | Double | ||
| | | | ||
|- | |- | ||
|9 | | 9 | ||
|REQUIRED | | REQUIRED | ||
|(Floating point number) | | (Floating point number) | ||
|Double | | Double | ||
| | | | ||
|- | |- | ||
|10 | | 10 | ||
|REQUIRED | | REQUIRED | ||
|(SOURCE Integer ID) | | (SOURCE Integer ID) | ||
|[[Source]]s | | [[Source]]s | ||
| | | | ||
|} | |} | ||
===Response Codes=== | ===Response Codes=== | ||
| Line 81: | Line 81: | ||
!Description | !Description | ||
|- | |- | ||
|204 | | 204 | ||
|No Content | | No Content | ||
|- | |- | ||
|300-600 | | 300-600 | ||
|Codes Overview | | Codes Overview | ||
|} | |} | ||
===Example POST=== | ===Example POST=== | ||
| Line 97: | Line 97: | ||
"coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ] | "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ] | ||
} ] | } ] | ||
}, "Text 1", "ELECTRICITY", "NOTHING", "Text 1", "Text 1", [ 1.0, 2.0 ], 1, | }, "Text 1", "ELECTRICITY", "NOTHING", "Text 1", "Text 1", [ 1.0, 2.0 ], 1, 23, 17, 1 ] | ||
' | ' | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 115: | Line 115: | ||
"coordinates" : [ [ [ [ 658656.762, 6799451.896 ], [ 658656.762, 6799461.896 ], [ 658666.762, 6799461.896 ], [ 658666.762, 6799451.896 ], [ 658656.762, 6799451.896 ] ] ] ] | "coordinates" : [ [ [ [ 658656.762, 6799451.896 ], [ 658656.762, 6799461.896 ], [ 658666.762, 6799461.896 ], [ 658666.762, 6799451.896 ], [ 658656.762, 6799451.896 ] ] ] ] | ||
} ] | } ] | ||
}, [ "Text 1", "Text 2", "Text 3" ], [ "ELECTRICITY", "GAS", "HEAT" ], [ "NOTHING", "WAITING_FOR_DATE", "REQUEST_PLOT_OWNER_APPROVAL" ], [ "Text 1", "Text 2", "Text 3" ], [ "Text 1", "Text 2", "Text 3" ], [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ], 1, | }, [ "Text 1", "Text 2", "Text 3" ], [ "ELECTRICITY", "GAS", "HEAT" ], [ "NOTHING", "WAITING_FOR_DATE", "REQUEST_PLOT_OWNER_APPROVAL" ], [ "Text 1", "Text 2", "Text 3" ], [ "Text 1", "Text 2", "Text 3" ], [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ], 1, 69, 51, 1 ] | ||
' | ' | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 123: | Line 123: | ||
method: "POST", | method: "POST", | ||
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | ||
body: '[ { "type" : "GeometryCollection", "geometries" : [ { "type" : "MultiPolygon", "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ] } ]}, "Text 1", "ELECTRICITY", "NOTHING", "Text 1", "Text 1", [ 1.0, 2.0 ], 1, | body: '[ { "type" : "GeometryCollection", "geometries" : [ { "type" : "MultiPolygon", "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ] } ]}, "Text 1", "ELECTRICITY", "NOTHING", "Text 1", "Text 1", [ 1.0, 2.0 ], 1, 23, 17, 1 ]' | ||
}; | }; | ||
fetch("https://engine.tygron.com/api/session/event/editornetload/import/?crs=3857", options) | fetch("https://engine.tygron.com/api/session/event/editornetload/import/?crs=3857", options) | ||
Revision as of 11:40, 8 June 2026
API Endpoint: api/session/event/editornetload/import/
Description: Import multiple Net Loads
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (GeometryCollection with crs: EPSG:3857) | GeometryCollection | |
| 1 | REQUIRED | (String or multiple values in array ["a", "b", "c"]) | String[] | |
| 2 | REQUIRED | (NetType or multiple values in array [a, b, c]) | Net Type[] | |
| 3 | REQUIRED | (TimeState or multiple values in array [a, b, c]) | Timestate[] | |
| 4 | REQUIRED | (String or multiple values in array ["a", "b", "c"]) | String[] | |
| 5 | REQUIRED | (String or multiple values in array ["a", "b", "c"]) | String[] | |
| 6 | REQUIRED | (Floating point number or multiple values in array [1.0, 2.0, 3.0] or matrix [[1.0, 2.0], [3.0, 4.0], [5.0, 6.0]]) | double[][] | |
| 7 | REQUIRED | (Integer number) | Integer | |
| 8 | REQUIRED | (Floating point number) | Double | |
| 9 | REQUIRED | (Floating point number) | Double | |
| 10 | REQUIRED | (SOURCE Integer ID) | Sources |
Response Codes
| Response Code: | Description |
|---|---|
| 204 | No Content |
| 300-600 | Codes Overview |
Example POST
Curl example POST:
curl 'https://engine.tygron.com/api/session/event/editornetload/import/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ {
"type" : "GeometryCollection",
"geometries" : [ {
"type" : "MultiPolygon",
"coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]
} ]
}, "Text 1", "ELECTRICITY", "NOTHING", "Text 1", "Text 1", [ 1.0, 2.0 ], 1, 23, 17, 1 ]
'Curl example multi item POST:
curl 'https://engine.tygron.com/api/session/event/editornetload/import/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ {
"type" : "GeometryCollection",
"geometries" : [ {
"type" : "MultiPolygon",
"coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]
}, {
"type" : "MultiPolygon",
"coordinates" : [ [ [ [ 658646.762, 6799451.896 ], [ 658646.762, 6799461.896 ], [ 658656.762, 6799461.896 ], [ 658656.762, 6799451.896 ], [ 658646.762, 6799451.896 ] ] ] ]
}, {
"type" : "MultiPolygon",
"coordinates" : [ [ [ [ 658656.762, 6799451.896 ], [ 658656.762, 6799461.896 ], [ 658666.762, 6799461.896 ], [ 658666.762, 6799451.896 ], [ 658656.762, 6799451.896 ] ] ] ]
} ]
}, [ "Text 1", "Text 2", "Text 3" ], [ "ELECTRICITY", "GAS", "HEAT" ], [ "NOTHING", "WAITING_FOR_DATE", "REQUEST_PLOT_OWNER_APPROVAL" ], [ "Text 1", "Text 2", "Text 3" ], [ "Text 1", "Text 2", "Text 3" ], [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ], 1, 69, 51, 1 ]
'JavaScript example POST:
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ { "type" : "GeometryCollection", "geometries" : [ { "type" : "MultiPolygon", "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ] } ]}, "Text 1", "ELECTRICITY", "NOTHING", "Text 1", "Text 1", [ 1.0, 2.0 ], 1, 23, 17, 1 ]'
};
fetch("https://engine.tygron.com/api/session/event/editornetload/import/?crs=3857", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));