Api session event editor building set owner: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
← Older edit
Frank@tygron.nl (talk | contribs)
Tygron, Tygron_admin, Bureaucrats, Interface administrators, Administrators
46,429 edits
No edit summary
No edit summary
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Endpoint: editorbuilding/set_owner.
API Endpoint: api/session/event/editorbuilding/set_owner/


API Endpoint name is Api session event editor building set owner.
Description: Set Owner
 
Use this endpoint to Set the Owner of a Building.
 
Owner id can be inspected using the endpoint https://engine.tygron.com/api/session/items/buildings/0/ownerID/?f=JSON&token=API_TOKEN


{|class=wikitable
{|class=wikitable
!Name
!Index
!Importance
!Importance
!Type
!Type
!Description
!Description
!Endpoint
!Values
|-
|-
|0
| 0
|REQUIRED
| REQUIRED
|(BUILDING Integer ID or multiple values in array [1, 2, 3])
| (BUILDING Integer ID or multiple integer values in array [1, 2, 3])
|[[Api session items buildings|Building ID]]
| [[Building]]s
|https://engine.tygron.com/api/session/items/buildings/?f=JSON&token=API_TOKEN
|  
|-
|-
|1
| 1
|REQUIRED
| REQUIRED
|(STAKEHOLDER Integer ID or multiple values in array [1, 2, 3])
| (STAKEHOLDER Integer ID or multiple integer values in array [1, 2, 3])
|[[Api session items stakeholders|Owner ID]]
| [[Stakeholder]]s
|https://engine.tygron.com/api/session/items/stakeholders/?f=JSON&token=API_TOKEN
|  
|}
|}
===Response Codes===
===Response Codes===
Line 31: Line 27:
!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/editorbuilding/set_owner/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 1 ]'
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorbuilding/set_owner/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 1 ]'
</syntaxhighlight>
</syntaxhighlight>
Curl example multi item POST:
Curl example multi item POST
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorbuilding/set_owner/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ 1, 2, 3 ] ]'
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorbuilding/set_owner/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ 1, 2, 3 ] ]'
</syntaxhighlight>
</syntaxhighlight>
JavaScript example POST:
JavaScript example POST
 
<syntaxhighlight lang="text" copy>var options = {
<syntaxhighlight lang="text" copy>var options = {
 method: "POST",
 method: "POST",
Line 60: Line 53:
{{article end|seealso=*[[Api session event editor building]]
{{article end|seealso=*[[Api session event editor building]]
*[[Api session items buildings]]
*[[Api session items buildings]]
*[[Api session items stakeholders]]
}}
}}


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

Latest revision as of 12:21, 17 June 2026

API Endpoint: api/session/event/editorbuilding/set_owner/

Description: Set Owner

Index Importance Type Description Values
0 REQUIRED (BUILDING Integer ID or multiple integer values in array [1, 2, 3]) Buildings
1 REQUIRED (STAKEHOLDER Integer ID or multiple integer values in array [1, 2, 3]) Stakeholders

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/editorbuilding/set_owner/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, 1 ]'

Curl example multi item POST 

curl 'https://engine.tygron.com/api/session/event/editorbuilding/set_owner/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ 1, 2, 3 ] ]'

JavaScript example POST 

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

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_event_editor_building_set_owner&oldid=86645"