Netzweg-Verwendung

Verwaltung von Verwendungsarten eines Netzweges.

Seitenverzeichnis:

1 cable.route_usage.read
2 cable.route_usage.create
3 cable.route_usage.update
4 cable.route_usage.delete

cable.route_usage.read

Beschreibung

Gibt alle Verwendungsarten eines Netzweges zurück.

Beispielaufruf

Lesen einer speziellen Verwendungsart eines Netzweges:

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

Filtern nach Verwendungsarten eines Netzweges:

{
	"method":"cable.route_usage.read",
	"params": {
		"apikey":"24174j3tqj",
		"filter": {
			"description": "Verwendung %"
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version

Parameter

Typ

Beschreibung

Version

id

int

Optional: ID des Datenbankeintrages

ab Version 1.0

filter

array

Optional: Filter für Verwendungsarten eines Netzweges

Der Filter unterstützt alle Eigenschaften der Verwendungsart eines Netzweges (siehe Rückgabewerte).

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

ab Version 1.0

Rückgabewert

Liste aller Eigenschaften der Verwendungsart eines Netzweges.

Wert	Typ	Beschreibung	Version

Wert	Typ	Beschreibung	Version
id	int	ID des Datenbankeintrages	ab Version 1.0
name	string	Name der Verwendungsart	ab Version 1.0
description	string	Beschreibung der Verwendungsart	ab Version 1.0

cable.route_usage.create

Beschreibung

Legt eine neue Verwendungsart eines Netzweges an.

Beispielaufruf

{
	"method":"cable.route_usage.create",
	"params":{
		"apikey":"24174j3tqj",
		"data": {
			"name": "verwendet",
			"description":"in Verwendnung"
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version

Parameter	Typ	Beschreibung	Version
name	string	Name der Verwendungsart	ab Version 1.0
description	string	Optional: Beschreibung der Verwendungsart	ab Version 1.0

Rückgabewert

Wert	Typ	Version

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

cable.route_usage.update

Beschreibung

Aktualisiert eine bestehende Verwendungsart eines Netzweges.

Beispielaufruf

{
	"method":"cable.route_usage.update",
	"params":{
		"apikey":"24174j3tqj",
		"id": 8,
		"data": {
			"description":"für Verwendung vorgesehen"
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version

Parameter	Typ	Beschreibung	Version
id	int	ID des Datenbankeintrages	ab Version 1.0
name	string	Name der Verwendungsart	ab Version 1.0
description	string	Beschreibung der Verwendungsart	ab Version 1.0

Rückgabewert

Wert	Typ	Version

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

cable.route_usage.delete

Beschreibung

Löscht eine Verwendungsart eines Netzweges.

Beispielaufruf

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

Parameter

Parameter	Typ	Beschreibung	Version

Parameter	Typ	Beschreibung	Version
id	int	ID der zu löschenden Verwendungsart eines Netzweges	ab Version 1.0

Rückgabewert

Wert	Typ	Version

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