Api session event participant attribute action plan: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
API Endpoint: api/session/event/participant/attribute_action_plan/ | API Endpoint: api/session/event/participant/attribute_action_plan/ | ||
Description: | Description: [[Stakeholder]] applies an [[Attribute Action]] within a [[MultiPolygon]]. | ||
{|class=wikitable | {|class=wikitable | ||
| Line 13: | Line 13: | ||
| REQUIRED | | REQUIRED | ||
| (STAKEHOLDER Integer ID) | | (STAKEHOLDER Integer ID) | ||
| [[Stakeholder]] | | [[Stakeholder]] | ||
| | | | ||
|- | |- | ||
| Line 19: | Line 19: | ||
| REQUIRED | | REQUIRED | ||
| (ATTRIBUTE_ACTION Integer ID) | | (ATTRIBUTE_ACTION Integer ID) | ||
| [[Attribute Action]] | | [[Attribute Action]] | ||
| | | | ||
|- | |- | ||
| Line 31: | Line 31: | ||
| REQUIRED | | REQUIRED | ||
| (String or multiple values in array ["a", "b", "c"]) | | (String or multiple values in array ["a", "b", "c"]) | ||
| [[Attribute]] | | [[Attribute]]s | ||
| | | | ||
|- | |- | ||
| Line 37: | Line 37: | ||
| 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]]) | ||
| | | Array of value arrays | ||
| | | | ||
|} | |} | ||
| Line 57: | Line 57: | ||
"type" : "MultiPolygon", | "type" : "MultiPolygon", | ||
"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 ] ] ] ] | ||
}, "Attribute | }, "Attribute 1", [ 1.0, 2.0 ] ] | ||
' | ' | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 65: | Line 65: | ||
"type" : "MultiPolygon", | "type" : "MultiPolygon", | ||
"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 ] ] ] ] | ||
}, [ "Attribute | }, [ "Attribute 1", "Attribute 2", "Attribute 3" ], [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] ] | ||
' | ' | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 72: | Line 72: | ||
method: "POST", | method: "POST", | ||
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" }, | ||
body: '[ 1, 1, { "type" : "MultiPolygon", "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]}, "Attribute | body: '[ 1, 1, { "type" : "MultiPolygon", "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]}, "Attribute 1", [ 1.0, 2.0 ] ]' | ||
}; | }; | ||
fetch("https://engine.tygron.com/api/session/event/participant/attribute_action_plan/?crs=3857", options) | fetch("https://engine.tygron.com/api/session/event/participant/attribute_action_plan/?crs=3857", options) | ||
Revision as of 15:33, 10 November 2026
API Endpoint: api/session/event/participant/attribute_action_plan/
Description: Stakeholder applies an Attribute Action within a MultiPolygon.
| Index | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (STAKEHOLDER Integer ID) | Stakeholder | |
| 1 | REQUIRED | (ATTRIBUTE_ACTION Integer ID) | Attribute Action | |
| 2 | REQUIRED | (MultiPolygon with crs: EPSG:3857) | MultiPolygon | |
| 3 | REQUIRED | (String or multiple values in array ["a", "b", "c"]) | Attributes | |
| 4 | 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]]) | Array of value arrays |
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/participant/attribute_action_plan/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ 1, 1, {
"type" : "MultiPolygon",
"coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]
}, "Attribute 1", [ 1.0, 2.0 ] ]
'Curl example multi item POST
curl 'https://engine.tygron.com/api/session/event/participant/attribute_action_plan/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ 1, 1, {
"type" : "MultiPolygon",
"coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]
}, [ "Attribute 1", "Attribute 2", "Attribute 3" ], [ [ 1.0, 2.0 ], [ 3.0, 4.0 ], [ 5.0, 6.0 ] ] ]
'JavaScript example POST
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ 1, 1, { "type" : "MultiPolygon", "coordinates" : [ [ [ [ 658636.762, 6799451.896 ], [ 658636.762, 6799461.896 ], [ 658646.762, 6799461.896 ], [ 658646.762, 6799451.896 ], [ 658636.762, 6799451.896 ] ] ] ]}, "Attribute 1", [ 1.0, 2.0 ] ]'
};
fetch("https://engine.tygron.com/api/session/event/participant/attribute_action_plan/?crs=3857", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));