Verbindungstyp

Verwaltung von Verbindungstypen.

Seitenverzeichnis:

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

cable.connection_type.read

Beschreibung

Gibt alle Verbindungstypen zurück.

Beispielaufruf

Lesen eines speziellen Verbindungstyps:

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

Filtern von Verbindungstypen:

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

Parameter

Parameter	Typ	Beschreibung	Version

Parameter

Typ

Beschreibung

Version

id

int

Optional: ID des Verbindungstyps

ab Version 1.0

filter

array

Optional: Filter für Verbindungstypen

Der Filter unterstützt alle Eigenschaften des Verbindungstypes (siehe Rückgabewerte).

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

ab Version 1.0

Rückgabewert

Liste aller Verbindungstypen.

Wert	Typ	Beschreibung	Version

Wert	Typ	Beschreibung	Version
id	int	ID des Verbindungstyps	ab Version 1.0
name	string	Name des Verbindungstyps	ab Version 1.0
description	string	Beschreibung des Verbindungstyps	ab Version 1.0
count	int	Anzahl der Verbindungen	ab Version 1.0

cable.connection_type.create

Beschreibung

Legt einen neuen Verbindungstyp an.

Beispielaufruf

{
	"method":"cable.connection_type.create",
	"params":{
		"apikey":"24174j3tqj",
		"data": {
			"name":"LWL-Verbindung",
			"count":40
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version

Parameter	Typ	Beschreibung	Version
name	string	Name des Verbindungstyps	ab Version 1.0
description	string	Optional: Beschreibung des Verbindungstyps	ab Version 1.0
count	int	Optional: Anzahl der Verbindungen	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.connection_type.update

Beschreibung

Aktualisiert einen bestehenden Verbindungstyp.

Beispielaufruf

{
	"method":"cable.connection_type.update",
	"params":{
		"apikey":"24174j3tqj",
		"id":4,
		"data": {
			"description":"neue LWL-Verbindung",
			"count":40
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version

Parameter	Typ	Beschreibung	Version
id	int	ID des Verbindungstyps	ab Version 1.0
name	string	Name des Verbindungstyps	ab Version 1.0
description	string	Beschreibung des Verbindungstyps	ab Version 1.0
count	int	Anzahl der Verbindungen	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.connection_type.delete

Beschreibung

Löscht einen Verbindungstyp.

Beispielaufruf

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

Parameter

Parameter	Typ	Beschreibung	Version

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