Api session event participant stakeholder set location: Difference between revisions
Jump to navigation
Jump to search
Created page with "API Endpoint: api/session/event/participant/stakeholder_set_location/ Description: Set the location of a Stakeholder in the 3D world. {|class=wikitable !Name !Importance !Type !Description !Values |- |0 |REQUIRED |(STAKEHOLDER Integer ID) |Stakeholder ID | |- |1 |REQUIRED |(Point with crs: EPSG:3857) |Location of the Stakeholder on the map as Point | |- |2 |REQUIRED |(true, false) |Ping others (show them my location) |true or false |}..." |
No edit summary |
||
| Line 10: | Line 10: | ||
!Values | !Values | ||
|- | |- | ||
|0 | | 0 | ||
|REQUIRED | | REQUIRED | ||
|(STAKEHOLDER Integer ID) | | (STAKEHOLDER Integer ID) | ||
|[[Stakeholder]] ID | | [[Stakeholder]] ID | ||
| | | | ||
|- | |- | ||
|1 | | 1 | ||
|REQUIRED | | REQUIRED | ||
|(Point with crs: EPSG:3857) | | (Point with crs: EPSG:3857) | ||
|Location of the [[Stakeholder]] on the map as [[#Api Model Point|Point]] | | Location of the [[Stakeholder]] on the map as [[#Api Model Point|Point]] | ||
| | | | ||
|- | |- | ||
|2 | | 2 | ||
|REQUIRED | | REQUIRED | ||
|(true, false) | | (true, false) | ||
|Ping others (show them my location) | | Ping others (show them my location) | ||
|true or false | | true or false | ||
|} | |} | ||
===Response Codes=== | ===Response Codes=== | ||
| Line 33: | Line 33: | ||
!Description | !Description | ||
|- | |- | ||
|204 | | 204 | ||
|No Content | | No Content | ||
|- | |- | ||
|300-600 | | 300-600 | ||
|Codes Overview | | Codes Overview | ||
|} | |} | ||
===Example POST=== | ===Example POST=== | ||
| Line 45: | Line 45: | ||
[ 1, { | [ 1, { | ||
"type" : "Point", | "type" : "Point", | ||
"coordinates" : [ | "coordinates" : [ 658664.097686127, 6799353.934353643 ] | ||
}, true ] | }, true ] | ||
' | ' | ||
| Line 54: | Line 54: | ||
[ 1, { | [ 1, { | ||
"type" : "Point", | "type" : "Point", | ||
"coordinates" : [ | "coordinates" : [ 658675.8142039079, 6799312.457825559 ] | ||
}, true ] | }, true ] | ||
' | ' | ||
| Line 63: | Line 63: | ||
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" : [ 658664.097686127, 6799353.934353643 ]}, true ]' | ||
}; | }; | ||
fetch("https://engine.tygron.com/api/session/event/participant/stakeholder_set_location/?crs=3857", options) | fetch("https://engine.tygron.com/api/session/event/participant/stakeholder_set_location/?crs=3857", options) | ||
Revision as of 11:44, 8 June 2026
API Endpoint: api/session/event/participant/stakeholder_set_location/
Description: Set the location of a Stakeholder in the 3D world.
| Name | Importance | Type | Description | Values |
|---|---|---|---|---|
| 0 | REQUIRED | (STAKEHOLDER Integer ID) | Stakeholder ID | |
| 1 | REQUIRED | (Point with crs: EPSG:3857) | Location of the Stakeholder on the map as Point | |
| 2 | REQUIRED | (true, false) | Ping others (show them my location) | true or false |
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/stakeholder_set_location/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ 1, {
"type" : "Point",
"coordinates" : [ 658664.097686127, 6799353.934353643 ]
}, true ]
'Curl example multi item POST:
curl 'https://engine.tygron.com/api/session/event/participant/stakeholder_set_location/?crs=3857' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '
[ 1, {
"type" : "Point",
"coordinates" : [ 658675.8142039079, 6799312.457825559 ]
}, true ]
'JavaScript example POST:
var options = {
method: "POST",
headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
body: '[ 1, { "type" : "Point", "coordinates" : [ 658664.097686127, 6799353.934353643 ]}, true ]'
};
fetch("https://engine.tygron.com/api/session/event/participant/stakeholder_set_location/?crs=3857", options)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));