Typ

Verwaltung von Kabeltypen.

Seitenverzeichnis:

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

cable.type.read

Beschreibung

Gibt alle Kabeltypen zurück.

Beispielaufruf

Lesen eines speziellen Kabeltyps:

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

Filtern von Kabeltypen:

{
	"method":"cable.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 Kabeltyps

ab Version 1.0

filter

array

Optional: Filter für Kabeltypen

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

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

ab Version 1.0

Rückgabewert

Liste aller Kabeltypen.

Wert	Typ	Beschreibung	Version

Wert	Typ	Beschreibung	Version
id	int	ID des Kabeltyps	ab Version 1.0
description	string	Beschreibung des Kabeltyps	ab Version 1.0
wire_count	int	Anzahl der Adern	ab Version 1.0
technology_id	int	Information zur verwendeten Technologie Siehe: Technologie	ab Version 1.0

cable.type.create

Beschreibung

Legt einen neuen Kabeltyp an.

Beispielaufruf

{
	"method":"cable.type.create",
	"params":{
		"apikey":"24174j3tqj",
		"data": {
			"description":"40-adriges Kabel",
			"wire_count":40,
			"technology_id": 4
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version

Parameter

Typ

Beschreibung

Version

description

string

Beschreibung des Kabeltyps

ab Version 1.0

wire_count

int

Anzahl der Adern

ab Version 1.0

technology_id

int

Information zur verwendeten Technologie

Siehe: Technologie

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.type.update

Beschreibung

Aktualisiert eine bestehenden Kabeltyp.

Beispielaufruf

{
	"method":"cable.type.update",
	"params":{
		"apikey":"24174j3tqj",
		"id":4,
		"data": {
			"description":"40-adriges Kabel",
			"wire_count":40
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version

Parameter	Typ	Beschreibung	Version
id	int	ID des Kabeltyps	ab Version 1.0
description	string	Beschreibung des Kabeltyps	ab Version 1.0
wire_count	int	Anzahl der Adern	ab Version 1.0
technology_id	int	Information zur verwendeten Technologie Siehe: Technologie	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.type.delete

Beschreibung

Löscht einen Kabeltyp.

Beispielaufruf

{
	"method":"cable.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 Kabeltyps	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