Api session event participant stakeholder set location: Difference between revisions

From Tygron Support wiki
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
 
(2 intermediate revisions by the same user not shown)
Line 4: Line 4:


{|class=wikitable
{|class=wikitable
!Name
!Index
!Importance
!Importance
!Type
!Type
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 [[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===
Curl example POST:
Curl example POST
 
<syntaxhighlight lang="text" copy>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 '
<syntaxhighlight lang="text" copy>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, {
[ 1, {
  "type" : "Point",
  "type" : "Point",
  "coordinates" : [ 658781.5438394813, 6799425.6409475235 ]
  "coordinates" : [ 658724.013690765, 6799435.715424859 ]
}, true ]
}, true ]
'
'
</syntaxhighlight>
</syntaxhighlight>
Curl example multi item POST:
Curl example multi item POST
 
<syntaxhighlight lang="text" copy>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 '
<syntaxhighlight lang="text" copy>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, {
[ 1, {
  "type" : "Point",
  "type" : "Point",
  "coordinates" : [ 658725.3990788531, 6799457.691569096 ]
  "coordinates" : [ 658790.0072126663, 6799349.669430271 ]
}, true ]
}, true ]
'
'
</syntaxhighlight>
</syntaxhighlight>
JavaScript example POST:
JavaScript example POST
 
<syntaxhighlight lang="text" copy>var options = {
<syntaxhighlight lang="text" copy>var options = {
 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" : [ 658781.5438394813, 6799425.6409475235 ]}, true ]'
 body: '[ 1, { "type" : "Point", "coordinates" : [ 658724.013690765, 6799435.715424859 ]}, 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)

Latest revision as of 13:03, 19 June 2026

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

Description: Set the location of a Stakeholder in the 3D world.

Index 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" : [ 658724.013690765, 6799435.715424859 ]
}, 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" : [ 658790.0072126663, 6799349.669430271 ]
}, true ]
'

JavaScript example POST

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, { "type" : "Point", "coordinates" : [ 658724.013690765, 6799435.715424859 ]}, 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));