Strecke

Verwaltung von Strecken.

Seitenverzeichnis:

cable.section.read

Beschreibung

Gibt alle Strecken zurück.

Beispielaufruf

Lesen einer speziellen Strecke:

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

Filtern von Strecken:

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

Parameter

Typ

Beschreibung

Version

id

int

Optional: ID der Strecke

ab Version 1.0

filter

array

Optional: Filter für Strecken

Der Filter unterstützt alle Eigenschaften der Strecke (siehe Rückgabewerte).

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

ab Version 1.0

Rückgabewert

Liste aller Strecken.

Wert	Typ	Beschreibung	Version
id	int	ID der Strecke	ab Version 1.0
obj_id	int	ID des referenzierten Strecken-Objektes	ab Version 1.0
description	string	Beschreibung der Strecke	ab Version 1.0
channel_count	int	Anzahl logischer Kanäle	ab Version 1.0
current_channel_count	int	Aktuelle Anzahl logischer Kanäle	ab Version 1.0
start_obj_id	int	ID des ersten Streckenelementes	ab Version 1.0
end_obj_id	int	ID des letzten Streckenelementes	ab Version 1.0

cable.section.create

Beschreibung

Legt eine neue Strecke an.

Beispielaufruf

{
	"method":"cable.section.create",
	"params":{
		"apikey":"24174j3tqj",
		"data": {
			"obj_id": 14,
			"description":"Strecke A"
		}
	},
	"version":"2.0"
}

Parameter

Parameter	Typ	Beschreibung	Version
obj_id	int	ID des referenzierten Strecken-Objektes	ab Version 1.0
description	string	Optional: Beschreibung der Strecke	ab Version 1.0
channel_count	int	Optional: Anzahl logischer Kanäle	ab Version 1.0
current_channel_count	int	Optional: Aktuelle Anzahl logischer Kanäle	ab Version 1.0
start_obj_id	int	Optional: ID des ersten Streckenelementes	ab Version 1.0
end_obj_id	int	Optional: ID des letzten Streckenelementes	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.section.update

Beschreibung

Aktualisiert eine bestehende Strecke.

Beispielaufruf

{
	"method":"cable.section.update",
	"params":{
		"apikey":"24174j3tqj",
		"id":4,
		"data": {
			"description":"Strecke A"
		}
	},
	"version":"2.0"
}

Parameter

Parameter	Typ	Beschreibung	Version
id	int	ID der Strecke	ab Version 1.0
description	string	Beschreibung der Strecke	ab Version 1.0
channel_count	int	Anzahl logischer Kanäle	ab Version 1.0
current_channel_count	int	Aktuelle Anzahl logischer Kanäle	ab Version 1.0
start_obj_id	int	ID des ersten Streckenelementes	ab Version 1.0
end_obj_id	int	ID des letzten Streckenelementes	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.section.delete

Beschreibung

Löscht eine Strecke.

Beispielaufruf

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

Parameter

Parameter	Typ	Beschreibung	Version
id	int	ID der zu löschenden Strecke	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