Netzweg-Element

Verwaltung von Netzweg-Elementen.

Seitenverzeichnis:

cable.route_element.read

Beschreibung

Gibt alle Netzweg-Elemente zurück.

Beispielaufruf

Lesen eines speziellen Netzweg-Elements:

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

Filtern von Netzweg-Elementen:

{
	"method":"cable.route_element.read",
	"params":{
		"apikey":"24174j3tqj",
		"filter": {
			"description": "Typ %"
		}
	},
	"version":"2.0"
}

Parameter

Typ

Beschreibung

Version

id

int

Optional: ID des Netzweg-Elementes

ab Version 1.0

filter

array

Optional: Filter für Netzweg-Elemente

Der Filter unterstützt alle Eigenschaften des Netzweg-Elementes (siehe Rückgabewerte).

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

ab Version 1.0

Rückgabewert

Liste aller Netzweg-Elemente.

Wert	Typ	Beschreibung	Version
id	int	ID des Netzweg-Elementes	ab Version 1.0
route_id	int	ID des referenzierten Netzweges	ab Version 1.0
wire_id	int	ID der referenzierten Ader	ab Version 1.0
section_id	int	ID der referenzierten Strecke	ab Version 1.0
index	int	Index innerhalb der Reihenfolge der Elemente eines Netzweges	ab Version 1.0
description	string	Beschreibung des Netzweg-Elementes	ab Version 1.0

cable.route_element.create

Beschreibung

Legt ein neues Netzweg-Element an.

Beispielaufruf

{
	"method":"cable.route_element.create",
	"params":{
		"apikey":"24174j3tqj",
		"data": {
			"route_id":1,
			"wire_id":2,
			"index":1,
			"description":"Netzweg-Element 1"
		}
	},
	"version":"2.0"
}

Parameter

Parameter	Typ	Beschreibung	Version
route_id	int	ID des referenzierten Netzweges	ab Version 1.0
index	int	Index innerhalb der Reihenfolge der Elemente eines Netzweges	ab Version 1.0
description	string	Optional: Beschreibung des Netzweg-Elementes	ab Version 1.0
wire_id	int	Optional: ID der referenzierten Ader (Hinweis: wire_id oder section_id muss gesetzt werden!)	ab Version 1.0
section_id	int	Optional: ID der referenzierten Strecke (Hinweis: wire_id oder section_id muss gesetzt werden!)	ab Version 1.0

Rückgabewert

Wert	Typ	Version
current_date	string	ab Version 1.0
id	int	ab Version 1.0
message	string	ab Version 1.0

cable.route_element.update

Beschreibung

Aktualisiert ein bestehendes Netzweg-Element.

Beispielaufruf

{
	"method":"cable.route_element.update",
	"params":{
		"apikey":"24174j3tqj",
		"id":4,
		"data": {
			"description":"Netzweg-Element 1"
		}
	},
	"version":"2.0"
}

Parameter

Parameter	Typ	Beschreibung	Version
id	int	ID des Netzweg-Elementes	ab Version 1.0
description	string	Beschreibung des Netzweg-Elementes	ab Version 1.0

Rückgabewert

Wert	Typ	Version
current_date	string	ab Version 1.0
id	int	ab Version 1.0
message	string	ab Version 1.0

cable.route_element.delete

Beschreibung

Löscht ein Netzweg-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

{
	"method":"cable.route_element.delete",
	"params":{
		"apikey":"24174j3tqj",
		"id":4
	},
	"version":"2.0"
}

Parameter

Parameter	Typ	Beschreibung	Version
id	int	ID des zu löschenden Netzweg-Elementes	ab Version 1.0

Rückgabewert

Wert	Typ	Version
current_date	string	ab Version 1.0
id	int	ab Version 1.0
message	string	ab Version 1.0