Api session event editor stakeholder select stakeholder: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
API Endpoint to Select [[Stakeholder]] with preferred ID, when not available fallback to next best.
API Endpoint: editorstakeholder/select_stakeholder.
 
API Endpoint name is Api session event editor stakeholder select stakeholder.
 
Use this endpoint to Select [[Stakeholder]] with preferred ID, when not available fallback to next best.
 
{|class=wikitable
{|class=wikitable
!Name
!Name
Line 31: Line 36:
|}
|}
===Example POST===
===Example POST===
Curl Example POST:
Curl example POST:


<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorstakeholder/select_stakeholder/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Client Token" ]'
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorstakeholder/select_stakeholder/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Client Token" ]'
</syntaxhighlight>
</syntaxhighlight>
JavaScript Example POST:
JavaScript example POST:


<syntaxhighlight lang="text" copy>var options = {
<syntaxhighlight lang="text" copy>var options = {
Line 48: Line 53:
</syntaxhighlight>
</syntaxhighlight>
{{article end|seealso=*[[Api session event editor stakeholder]]
{{article end|seealso=*[[Api session event editor stakeholder]]
*[[Api session items stakeholders]]
}}
}}


[[Category:API]]
[[Category:API]]

Revision as of 11:31, 10 April 2026

API Endpoint: editorstakeholder/select_stakeholder.

API Endpoint name is Api session event editor stakeholder select stakeholder.

Use this endpoint to Select Stakeholder with preferred ID, when not available fallback to next best.

Name Importance Type Description Values
0 REQUIRED (Integer number) Preferred Stakeholder ID or empty
1 REQUIRED (String) Client Token (from Join Session event)

Response Codes

Response Code: Description
200 Integer (Selected Stakeholder ID)
300-600 Codes Overview

Example POST

Curl example POST:

curl 'https://engine.tygron.com/api/session/event/editorstakeholder/select_stakeholder/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Client Token" ]'

JavaScript example POST:

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, "Client Token" ]'
};
fetch("https://engine.tygron.com/api/session/event/editorstakeholder/select_stakeholder/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));