Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

Verwaltung von StreckenNetzweg-Elementen.

Seitenverzeichnis:

Inhalt
maxLevel2
indent10px
stylesquare

...

cable.

...

route_element.read

Beschreibung

Gibt alle StreckenNetzweg-Elemente zurück.

Beispielaufruf

Lesen eines speziellen Netzweg-Elements:

Codeblock
languagebash
themeRDark
{
	"method":"cable.

...

route_element.read",
	"params":{
		"apikey":"24174j3tqj",
		"id": 4
	},
	"version":"2.0",
    "id": 1
}

Filtern von Netzweg-Elementen:

Codeblock
languagebash
themeRDark
{
	"method":"

...

cable.route_element.read",
	"params":{
		"apikey":"

...

24174j3tqj"

...

,

...


		"filter": {
			"index": 1
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

ParameterTypBeschreibungVersion
idintOptional: ID des Netzweg-Elementesab Version 1.0
filterarray

Optional: Filter für

Strecken

Netzweg-Elemente

Der Filter unterstützt alle Eigenschaften des

Strecken

Netzweg-Elementes (siehe Rückgabewerte).

Als Suchkriterium kann das Prozent-Zeichen "%" als Wildcard verwendet werden.

ab Version 1.0

Rückgabewert

Liste aller StreckenNetzweg-Elemente.

WertTypBeschreibungVersion
idintID des
Strecken
Netzweg-Elementesab Version 1.0
section
route_idintID des referenzierten
Strecke
Netzwegesab Version 1.0
connection
wire_idintID der referenzierten
Verbindung
Aderab Version 1.0
index
section_idint
Index innerhalb der Reihenfolge der Elemente einer
ID der referenzierten Streckeab Version 1.0
descriptionBeschreibung des Strecken-Elementes
index
string
intIndex innerhalb der Reihenfolge der Elemente eines Netzwegesab Version 1.0


...

cable.

...

route_element.create

Beschreibung

Legt ein neues StreckenNetzweg-Element an.

Beispielaufruf


Codeblock
languagebash
themeRDark
{
	"method":"cable.

...

route_element.create",
	"params":{
		"apikey":"24174j3tqj",
		"

...

data":

...

 {
			"route_id":1,
			"wire_id":2,
			"index":1
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

ParameterTypBeschreibungVersion
obj
route_idintID des referenzierten
Strecken-Objektes
Netzwegesab Version 1.0
descriptionBeschreibung der Strecke
index
string
intIndex innerhalb der Reihenfolge der Elemente eines Netzwegesab Version 1.0
connection
wire_
count
idint
Anzahl Verbindungen

Optional: ID der referenzierten Ader

(Hinweis: wire_id oder section_id muss gesetzt werden!)

ab Version 1.0
current
section_
connection_count
idint
Aktuelle Anzahl der Verbindungen

Optional: ID der referenzierten Strecke

(Hinweis: wire_id oder section_id muss gesetzt werden!)

ab Version 1.0

Rückgabewert

WertTypVersion
current_datestringab Version 1.0
idintab Version 1.0
messagestringab Version 1.0


...

cable.

...

route_element.update

Beschreibung

Aktualisiert ein bestehendes StreckenNetzweg-Element.

Beispielaufruf


Codeblock
languagebash
themeRDark
{
	"method":"cable.

...

route_element.update",
	"params":{
		"apikey":"24174j3tqj",

...


		"id":4,
		"

...

data":

...

 {
			"wire_id": 8
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

ParameterTypBeschreibungVersion
section_element_
idintID des
Strecken
Netzweg-Elementesab Version 1.0
descriptionBeschreibung der Strecke
index
string
intIndex innerhalb der Reihenfolge der Elemente eines Netzwegesab Version 1.0
connection
wire_
count
idint
Anzahl Verbindungen
ID der referenzierten Aderab Version 1.0
current
section_
connection_count
idint
Aktuelle Anzahl
ID der
Verbindungen
referenzierten Streckeab Version 1.0

Rückgabewert

WertTypVersion
current_datestringab Version 1.0
idintab Version 1.0
messagestringab Version 1.0


...

cable.

...

route_element.delete

Beschreibung

Löscht ein StreckenNetzweg-Element.

Wichtig: Es kann immer nur das jeweils letzte Netzweg-Element gelöscht werden. Ein Löschen von Elementen innerhalb eines Netzweges ist nicht möglich.

Beispielaufruf


Codeblock
languagebash
themeRDark
{
	"method":"cable.

...

route_element.delete",
	"params":{
		"apikey":"24174j3tqj",

...


		"id":4
	},

...


	"version":"2.0",
    "id": 1
}


Parameter

ParameterTypBeschreibungVersion
section_element_
idintID des zu löschenden
Strecken
Netzweg-Elementesab Version 1.0

Rückgabewert

WertTypVersion
current_datestringab Version 1.0
idintab Version 1.0
messagestringab Version 1.0

...