Api session event editor address add: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(19 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Event to [[Building]] [[Address]] belong to
API Endpoint: api/session/event/editoraddress/add/
 
Description: Assign [[Building]] [[Address]]
 
{|class=wikitable
{|class=wikitable
!Name
!Index
!Importance
!Importance
!Type
!Type
Line 7: Line 10:
!Values
!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])
|[[Building]]
| [[Building]]
|
|  
|-
|-
|1
| 1
|REQUIRED
| REQUIRED
|(String or multiple values in array ["a", "b", "c"])
| (String or multiple values in array ["a", "b", "c"])
|Street name
| Street name
|
|  
|}
|}
===Response Codes===
===Response Codes===
Line 24: Line 27:
!Description
!Description
|-
|-
|200
| 200
|Integer[] (Integer array)
| Integer[] (Integer array)
|-
|-
|300-600
| 300-600
|Codes Overview
| Codes Overview
|}
|}
===Example POST===
===Example POST===
Example POST: https://engine.tygron.com/api/session/event/editoraddress/add/?f=JSON&token=API_TOKEN
Curl example POST
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editoraddress/add/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Street name 1" ]'
with content:
</syntaxhighlight>
<pre>[ [ 1, 2, 3 ], [ "Street name 1", "Street name 2", "Street name 3" ] ]
Curl example multi item POST
</pre>
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editoraddress/add/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ "Street name 1", "Street name 2", "Street name 3" ] ]'
{{article end|seealso=*[[api session event editor address]]}}
</syntaxhighlight>
JavaScript example POST
<syntaxhighlight lang="text" copy>var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, "Street name 1" ]'
};
fetch("https://engine.tygron.com/api/session/event/editoraddress/add/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));
</syntaxhighlight>
{{article end|seealso=*[[Api session event editor address]]
*[[Api session items addresses]]
}}


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

Latest revision as of 09:57, 13 July 2026

API Endpoint: api/session/event/editoraddress/add/

Description: Assign Building Address

Index Importance Type Description Values
0 REQUIRED (BUILDING Integer ID or multiple integer values in array [1, 2, 3]) Building
1 REQUIRED (String or multiple values in array ["a", "b", "c"]) Street name

Response Codes

Response Code: Description
200 Integer[] (Integer array)
300-600 Codes Overview

Example POST

Curl example POST

curl 'https://engine.tygron.com/api/session/event/editoraddress/add/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Street name 1" ]'

Curl example multi item POST

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

JavaScript example POST

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