Api session event editor stakeholder select stakeholder: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 10: | Line 10: | ||
!Values | !Values | ||
|- | |- | ||
|0 | | 0 | ||
|REQUIRED | | REQUIRED | ||
|(Integer number) | | (Integer number) | ||
|Preferred [[Stakeholder]] ID or empty | | Preferred [[Stakeholder]] ID or empty | ||
| | | | ||
|- | |- | ||
|1 | | 1 | ||
|REQUIRED | | REQUIRED | ||
|(String) | | (String) | ||
|Client Token (from Join [[Session]] event) | | Client Token (from Join [[Session]] event) | ||
| | | | ||
|} | |} | ||
===Response Codes=== | ===Response Codes=== | ||
| Line 27: | Line 27: | ||
!Description | !Description | ||
|- | |- | ||
|200 | | 200 | ||
|Integer (Selected Stakeholder ID) | | Integer (Selected Stakeholder ID) | ||
|- | |- | ||
|300-600 | | 300-600 | ||
|Codes Overview | | Codes Overview | ||
|} | |} | ||
===Example POST=== | ===Example POST=== | ||
Revision as of 11:42, 8 June 2026
API Endpoint: api/session/event/editorstakeholder/select_stakeholder/
Description: 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));