Api session event logic neighborhood set attribute: Difference between revisions

From Tygron Support wiki
Jump to navigation Jump to search
Created page with "API Endpoint: api/session/event/logic/neighborhood_set_attribute/ Description: Set an attribute for a Neighborhood. {|class=wikitable !Name !Importance !Type !Description !Values |- |0 |REQUIRED |(NEIGHBORHOOD Integer ID or multiple values in array [1, 2, 3]) |Neighborhood ID | |- |1 |REQUIRED |(String) |Valid attribute name | |- |2 |REQUIRED |(Floating point number or multiple values in array [1.0, 2.0, 3.0]) |Attribute value | |- |3 |OPTIONAL |(true, false) |..."
 
No edit summary
 
Line 1: Line 1:
API Endpoint: api/session/event/logic/neighborhood_set_attribute/
API Endpoint: api/session/event/logic/neighborhood_set_attribute/


Description: Set an attribute for a [[Neighborhood]].
Description: Set an [[Attribute]] for a [[Neighborhood]].


{|class=wikitable
{|class=wikitable
Line 19: Line 19:
|REQUIRED
|REQUIRED
|(String)
|(String)
|Valid attribute name
|Valid [[Attribute]] name
|
|
|-
|-
Line 25: Line 25:
|REQUIRED
|REQUIRED
|(Floating point number or multiple values in array [1.0, 2.0, 3.0])
|(Floating point number or multiple values in array [1.0, 2.0, 3.0])
|Attribute value
|[[Attribute]] value
|
|
|-
|-
Line 31: Line 31:
|OPTIONAL
|OPTIONAL
|(true, false)
|(true, false)
|Update [[Indicator]] (optional)
|Update [[Indicator]]s (optional)
|
|
|}
|}

Latest revision as of 14:49, 2 June 2026

API Endpoint: api/session/event/logic/neighborhood_set_attribute/

Description: Set an Attribute for a Neighborhood.

Name Importance Type Description Values
0 REQUIRED (NEIGHBORHOOD Integer ID or multiple values in array [1, 2, 3]) Neighborhood ID
1 REQUIRED (String) Valid Attribute name
2 REQUIRED (Floating point number or multiple values in array [1.0, 2.0, 3.0]) Attribute value
3 OPTIONAL (true, false) Update Indicators (optional)

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/logic/neighborhood_set_attribute/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ 1, "Valid attribute name", 1.0 ]'

Curl example multi item POST:

curl 'https://engine.tygron.com/api/session/event/logic/neighborhood_set_attribute/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ [ 1, 2, 3 ], "Valid attribute name", [ 1.0, 2.0, 3.0 ] ]'

JavaScript example POST:

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