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
Line 10: Line 10:
!Values
!Values
|-
|-
|0
| 0
|REQUIRED
| REQUIRED
|(WEATHER Integer ID or multiple values in array [1, 2, 3])
| (WEATHER Integer ID or multiple 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"])
|[[Attribute]]s to remove
| [[Attribute]]s to remove
|
|  
|}
|}
===Response Codes===
===Response Codes===
Line 27: Line 27:
!Description
!Description
|-
|-
|204
| 204
|No Content
| No Content
|-
|-
|300-600
| 300-600
|Codes Overview
| Codes Overview
|}
|}
===Example POST===
===Example POST===

Revision as of 11:43, 8 June 2026

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

Description: Remove the specified Attributes of the specified Weather. The Attributes, including Attributes which are added to a Weather by default, are removed entirely.

Name Importance Type Description Values
0 REQUIRED (WEATHER Integer ID or multiple 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));