cable.admin_unit.read

Beschreibung

Gibt alle Verwaltungseinheiten zurück.

Beispielaufruf

Lesen einer speziellen Verwaltungseinheit:

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

Filtern nach Verwaltungseinheiten:

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

Parameter

Parameter

Typ

Beschreibung

Version

id

int

Optional: ID des Datenbankeintrages

ab Version 1.0

filter

array

Optional: Filter für Verwaltungseinheiten

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

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

ab Version 1.0

Rückgabewert

Liste aller Eigenschaften der Verwaltungseinheiten.

Wert	Typ	Beschreibung	Version
id	int	ID des Datenbankeintrages	ab Version 1.0
description	string	Beschreibung der Verwaltungseinheit	ab Version 1.0
classification	string	Verwaltungsklasse	ab Version 1.0
parent_id	int	Optional: ID der Eltern-Verwaltungseinheit	ab Version 1.0

cable.admin_unit.create

Beschreibung

Legt eine neue Verwaltungseinheit an.

Beispielaufruf

{
	"method":"cable.admin_unit.create",
	"params":{
		"apikey":"24174j3tqj",
		"data": {
			"description":"LAN-Kabel",
			"classification":"Netzwerk"
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
description	string	Beschreibung der Verwaltungseinheit	ab Version 1.0
classification	string	Verwaltungsklasse	ab Version 1.0
parent_id	int	Optional: ID der Eltern-Verwaltungseinheit	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.admin_unit.update

Beschreibung

Aktualisiert eine bestehende Verwaltungseinheit.

Beispielaufruf

{
	"method":"cable.admin_unit.update",
	"params":{
		"apikey":"24174j3tqj",
		"id": 6,
		"data": {
			"description":"LAN-Kabel",
			"classification":"Netzwerk",
			"parent_id": 4
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
id	int	ID des Datenbankeintrages	ab Version 1.0
description	string	Beschreibung der Verwaltungseinheit	ab Version 1.0
classification	string	Verwaltungsklasse	ab Version 1.0
parent_id	int	ID der Eltern-Verwaltungseinheit	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.admin_unit.delete

Beschreibung

Löscht eine Verwaltungseinheit.

Beispielaufruf

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

Parameter

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