Api session event editor netload add: 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 Event to Add new [[Net Load]]
API Endpoint: api/session/event/editornetload/add/
 
Description: Add new [[Net Load]]
 
{|class=wikitable
{|class=wikitable
!Name
!Index
!Importance
!Importance
!Type
!Type
Line 7: Line 10:
!Values
!Values
|-
|-
|0
| 0
|REQUIRED
| REQUIRED
|(Enumeration)
| (Enumeration)
|Net Type
| [[Net Type]]
|ELECTRICITY, GAS, HEAT, INTERNET  or  SEWER
| ELECTRICITY, GAS, HEAT, INTERNET  or  SEWER
|-
|-
|1
| 1
|REQUIRED
| REQUIRED
|(true, false)
| (true, false)
|Is root load
| Is root load
|true  or  false
| true  or  false
|}
|}
===Response Codes===
===Response Codes===
Line 24: Line 27:
!Description
!Description
|-
|-
|200
| 200
|Integer (Net Load ID)
| Integer (Net Load ID)
|-
|-
|300-600
| 300-600
|Codes Overview
| Codes Overview
|}
|}
===Example POST===
===Example POST===
Example POST: https://engine.tygron.com/api/session/event/editornetload/add/?f=JSON&token=API_TOKEN
Curl example POST
 
<syntaxhighlight lang="text" copy>curl 'https://engine.tygron.com/api/session/event/editornetload/add/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ "ELECTRICITY", true ]'
with content:  
</syntaxhighlight>
<pre>[ "HEAT", false ]
JavaScript example POST
</pre>
<syntaxhighlight lang="text" copy>var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ "ELECTRICITY", true ]'
};
fetch("https://engine.tygron.com/api/session/event/editornetload/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 netload]]
{{article end|seealso=*[[Api session event editor netload]]
*[[Api session items netloads]]
*[[Api session items netloads]]

Latest revision as of 12:04, 15 June 2026

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

Description: Add new Net Load

Index Importance Type Description Values
0 REQUIRED (Enumeration) Net Type ELECTRICITY, GAS, HEAT, INTERNET or SEWER
1 REQUIRED (true, false) Is root load true or false

Response Codes

Response Code: Description
200 Integer (Net Load ID)
300-600 Codes Overview

Example POST

Curl example POST 

curl 'https://engine.tygron.com/api/session/event/editornetload/add/' -H 'Content-Type: application/json' -H 'Authorization: Bearer API_TOKEN' -d '[ "ELECTRICITY", true ]'

JavaScript example POST 

var options = {
 method: "POST",
 headers: { "Content-Type": "application/json", "Authorization": "Bearer API_TOKEN" },
 body: '[ "ELECTRICITY", true ]'
};
fetch("https://engine.tygron.com/api/session/event/editornetload/add/", 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_netload_add&oldid=85867"