Api session items netfunctions: 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
Tag: Manual revert
 
(35 intermediate revisions by the same user not shown)
Line 1: Line 1:
Api session items [[Net Function]]s Endpoints.
API Endpoint: /api/session/items/netfunctions/


Manipulate items with event: [[Api session event editor netfunction|editornetfunction]].
Edit items with events described at [[Api session event editor netfunction]].


Default Query:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netfunctions/?f=JSON&token=API_TOKEN</syntaxhighlight>
Example Response:
<syntaxhighlight lang="text" copy>[ {
  "attributes" : {
    "COLOR" : [ -6711040.0 ],
    "DIAMETER_M" : [ 0.1 ],
    "PRICE_M" : [ 10.0 ],
    "VISUALIZATION_DIAMETER_M" : [ 1.0 ]
  },
  "diameterM" : null,
  "groupName" : "",
  "id" : 0,
  "maquetteOverride" : null,
  "name" : "Electricity Line",
  "netType" : "ELECTRICITY",
  "priceM" : null,
  "sourceIDs" : [ ],
  "version" : 1
}, {
  "attributes" : {
    "COLOR" : [ -1.1704628E7 ],
    "DIAMETER_M" : [ 0.1 ],
    "PRICE_M" : [ 10.0 ],
    "VISUALIZATION_DIAMETER_M" : [ 1.0 ]
  },
  "diameterM" : null,
  "groupName" : "",
  "id" : 1,
  "maquetteOverride" : null,
  "name" : "Gas Line",
  "netType" : "GAS",
  "priceM" : null,
  "sourceIDs" : [ ],
  "version" : 4
} ]</syntaxhighlight>
==Limit Queries==
==Limit Queries==
version=100:  
version=100:  
<pre>https://engine.tygron.com/api/session/items/netfunctions/?version=100&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netfunctions/?version=100&token=API_TOKEN</syntaxhighlight>
==Show Queries==
==Get Queries==
attributes:
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netfunctions/attributes/?token=API_TOKEN</syntaxhighlight>
max version:  
max version:  
<pre>https://engine.tygron.com/api/session/items/netfunctions/version/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netfunctions/version/?token=API_TOKEN</syntaxhighlight>
size:  
count:  
<pre>https://engine.tygron.com/api/session/items/netfunctions/size/?token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netfunctions/count/?token=API_TOKEN</syntaxhighlight>
==Formats==
==Formats==
HTML:  
HTML:  
<pre>https://engine.tygron.com/api/session/items/netfunctions/?f=HTML&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netfunctions/?f=HTML&token=API_TOKEN</syntaxhighlight>
JSON:  
JSON:  
<pre>https://engine.tygron.com/api/session/items/netfunctions/?f=JSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netfunctions/?f=JSON&token=API_TOKEN</syntaxhighlight>
CSV:  
CSV:  
<pre>https://engine.tygron.com/api/session/items/netfunctions/?f=CSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netfunctions/?f=CSV&token=API_TOKEN</syntaxhighlight>
SSV:  
SSV:  
<pre>https://engine.tygron.com/api/session/items/netfunctions/?f=SSV&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netfunctions/?f=SSV&token=API_TOKEN</syntaxhighlight>
SMILE:  
SMILE:  
<pre>https://engine.tygron.com/api/session/items/netfunctions/?f=SMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netfunctions/?f=SMILE&token=API_TOKEN</syntaxhighlight>
ZIPJSON:  
ZIPJSON:  
<pre>https://engine.tygron.com/api/session/items/netfunctions/?f=ZIPJSON&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netfunctions/?f=ZIPJSON&token=API_TOKEN</syntaxhighlight>
ZIPSMILE:  
ZIPSMILE:  
<pre>https://engine.tygron.com/api/session/items/netfunctions/?f=ZIPSMILE&token=API_TOKEN</pre>
<syntaxhighlight lang="text" copy>https://engine.tygron.com/api/session/items/netfunctions/?f=ZIPSMILE&token=API_TOKEN</syntaxhighlight>
==Api Model NetFunction==
API Model description of NetFunction
 
{|class=wikitable
!Name
!Type
!Description
|-
| attributes
| Map&lt;String,double[]&gt;
|
|-
| diameterM
| double
|
|-
| groupName
| String
|
|-
| id
| int
|
|-
| maquetteOverride
| Map&lt;String,double[]&gt;
|
|-
| name
| String
|
|-
| netType
| NetType
| [[Net Type]]
|-
| priceM
| double
|
|-
| sourceIDs
| int<nowiki>[]</nowiki>
| [[Source]]s ID
|-
| version
| int
|
|}
 
==Api Model NetType==
API Enumeration description of NetType
 
{|class=wikitable
!Name
!Description
|-
| ELECTRICITY
|
|-
| GAS
|
|-
| HEAT
|
|-
| INTERNET
|
|-
| SEWER
|
|}
 
{{article end|seealso=*[[Api Content Items]]
{{article end|seealso=*[[Api Content Items]]
*[[Api session event editor netfunction]]
*[[Api session event editor netfunction]]
Line 31: Line 141:


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

Latest revision as of 07:06, 14 July 2026

API Endpoint: /api/session/items/netfunctions/

Edit items with events described at Api session event editor netfunction.

Default Query: 

https://engine.tygron.com/api/session/items/netfunctions/?f=JSON&token=API_TOKEN

Example Response: 

[ {
  "attributes" : {
    "COLOR" : [ -6711040.0 ],
    "DIAMETER_M" : [ 0.1 ],
    "PRICE_M" : [ 10.0 ],
    "VISUALIZATION_DIAMETER_M" : [ 1.0 ]
  },
  "diameterM" : null,
  "groupName" : "",
  "id" : 0,
  "maquetteOverride" : null,
  "name" : "Electricity Line",
  "netType" : "ELECTRICITY",
  "priceM" : null,
  "sourceIDs" : [ ],
  "version" : 1
}, {
  "attributes" : {
    "COLOR" : [ -1.1704628E7 ],
    "DIAMETER_M" : [ 0.1 ],
    "PRICE_M" : [ 10.0 ],
    "VISUALIZATION_DIAMETER_M" : [ 1.0 ]
  },
  "diameterM" : null,
  "groupName" : "",
  "id" : 1,
  "maquetteOverride" : null,
  "name" : "Gas Line",
  "netType" : "GAS",
  "priceM" : null,
  "sourceIDs" : [ ],
  "version" : 4
} ]

Limit Queries

version=100: 

https://engine.tygron.com/api/session/items/netfunctions/?version=100&token=API_TOKEN

Get Queries

attributes: 

https://engine.tygron.com/api/session/items/netfunctions/attributes/?token=API_TOKEN

max version: 

https://engine.tygron.com/api/session/items/netfunctions/version/?token=API_TOKEN

count: 

https://engine.tygron.com/api/session/items/netfunctions/count/?token=API_TOKEN

Formats

HTML: 

https://engine.tygron.com/api/session/items/netfunctions/?f=HTML&token=API_TOKEN

JSON: 

https://engine.tygron.com/api/session/items/netfunctions/?f=JSON&token=API_TOKEN

CSV: 

https://engine.tygron.com/api/session/items/netfunctions/?f=CSV&token=API_TOKEN

SSV: 

https://engine.tygron.com/api/session/items/netfunctions/?f=SSV&token=API_TOKEN

SMILE: 

https://engine.tygron.com/api/session/items/netfunctions/?f=SMILE&token=API_TOKEN

ZIPJSON: 

https://engine.tygron.com/api/session/items/netfunctions/?f=ZIPJSON&token=API_TOKEN

ZIPSMILE: 

https://engine.tygron.com/api/session/items/netfunctions/?f=ZIPSMILE&token=API_TOKEN

Api Model NetFunction

API Model description of NetFunction

Name Type Description
attributes Map<String,double[]>
diameterM double
groupName String
id int
maquetteOverride Map<String,double[]>
name String
netType NetType Net Type
priceM double
sourceIDs int[] Sources ID
version int

Api Model NetType

API Enumeration description of NetType

Name Description
ELECTRICITY
GAS
HEAT
INTERNET
SEWER

See also

Retrieved from "https://support.tygron.com/w/index.php?title=Api_session_items_netfunctions&oldid=91284"