Api session event participant attribute action plan: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
Created page with "API Endpoint: api/session/event/participant/attribute_action_plan/ Description: Apply an Attribute Action. {|class=wikitable !Name !Importance !Type !Description !Values |- |0 |REQUIRED |(STAKEHOLDER Integer ID) |Stakeholder ID | |- |1 |REQUIRED |(ATTRIBUTE_ACTION Integer ID) |Attribute Action ID | |- |2 |REQUIRED |(MultiPolygon with crs: EPSG:3857) |MultiPolygon | |- |3 |REQUIRED |(String or multiple values in array ["a", "b", "..."
 
No edit summary
 
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 names
|[[Attribute]] names
|
|
|-
|-
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]])
|Attribute value arrays
|[[Attribute]] value arrays
|
|
|}
|}

Latest revision as of 14:49, 2 June 2026

API Endpoint: api/session/event/participant/attribute_action_plan/

Description: Apply an Attribute Action.

Name Importance Type Description Values
0 REQUIRED (STAKEHOLDER Integer ID) Stakeholder ID
1 REQUIRED (ATTRIBUTE_ACTION Integer ID) Attribute Action ID
2 REQUIRED (MultiPolygon with crs: EPSG:3857) MultiPolygon
3 REQUIRED (String or multiple values in array ["a", "b", "c"]) Attribute names
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]]) Attribute 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 name 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 name 1", "Attribute name 2", "Attribute name 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 name 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));