Api session event editor weather remove attribute: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
API Event to Remove the specified attributes of the specified [[Weather]]. The attributes, including attributes which are added to a [[Weather]] by default, are removed entirely.
API Endpoint: api/session/event/editorweather/remove_attribute/
 
Description: Remove specified [[Attribute]]s from the specified [[Weather]], including default [[Attribute]]s.
 
{|class=wikitable
{|class=wikitable
!Name
!Index
!Importance
!Importance
!Type
!Type
Line 7: Line 10:
!Values
!Values
|-
|-
|0
| 0
|REQUIRED
| REQUIRED
|(WEATHER Integer ID or multiple values in array [1, 2, 3])
| (WEATHER Integer ID or multiple integer values in array [1, 2, 3])
|[[Weather]] ID
| [[Weather]] ID
|
|  
|-
|-
|1
| 1
|REQUIRED
| REQUIRED
|(String or multiple values in array ["a", "b", "c"])
| (String or multiple values in array ["a", "b", "c"])
|Attributes to remove
| [[Attribute]]s to remove
|
|  
|}
|}
===Response Codes===
===Response Codes===
Line 24: Line 27:
!Description
!Description
|-
|-
|204
| 204
|No Content
| No Content
|-
|-
|300-600
| 300-600
|Codes Overview
| Codes Overview
|}
|}
===Example POST===
===Example POST===
Example POST: https://engine.tygron.com/api/session/event/editorweather/remove_attribute/?f=JSON&token=API_TOKEN
Curl example POST
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorweather/remove_attribute/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Attributes to remove 1" ]'
with content:
</syntaxhighlight>
<pre>[ [ 1, 2, 3 ], [ "Attributes to remove 1", "Attributes to remove 2", "Attributes to remove 3" ] ]
Curl example multi item POST
</pre>
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editorweather/remove_attribute/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ "Attributes to remove 1", "Attributes to remove 2", "Attributes to remove 3" ] ]'
{{article end|seealso=*[[api session event editor weather]]}}
</syntaxhighlight>
JavaScript example POST
<syntaxhighlight lang="text" copy>var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ 1, "Attributes to remove 1" ]'
};
fetch("https://engine.tygron.com/api/session/event/editorweather/remove_attribute/", options)
 .then(response => response.text())
 .then(result => console.log(result))
 .catch(error => console.log('error', error));
</syntaxhighlight>
{{article end|seealso=*[[Api session event editor weather]]
*[[Api session items weathers]]
}}


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

Latest revision as of 10:00, 13 July 2026

API Endpoint: api/session/event/editorweather/remove_attribute/

Description: Remove specified Attributes from the specified Weather, including default Attributes.

Index Importance Type Description Values
0 REQUIRED (WEATHER Integer ID or multiple integer values in array [1, 2, 3]) Weather ID
1 REQUIRED (String or multiple values in array ["a", "b", "c"]) Attributes to remove

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/editorweather/remove_attribute/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Attributes to remove 1" ]'

Curl example multi item POST

curl 'https://engine.tygron.com/api/session/event/editorweather/remove_attribute/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], [ "Attributes to remove 1", "Attributes to remove 2", "Attributes to remove 3" ] ]'

JavaScript example POST

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