Nutzer-Status

Verwaltung von Nutzer-Status.

Seitenverzeichnis:

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

cable.user_state.read

Beschreibung

Gibt alle Nutzer-Status zurück.

Beispielaufruf

Lesen eines speziellen Nutzer-Status:

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

Filtern von Nutzer-Status:

{
	"method":"cable.user_state.read",
	"params":{
		"apikey":"24174j3tqj",
		"filter": {
			"name": "Status %"
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version

Parameter

Typ

Beschreibung

Version

id

int

Optional: ID des Nutzer-Status

ab Version 1.0

filter

array

Optional: Filter für Nutzer-Status

Der Filter unterstützt alle Eigenschaften des Nutzer-Status (siehe Rückgabewerte).

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

ab Version 1.0

Rückgabewert

Liste aller Nutzer-Status.

Wert	Typ	Beschreibung	Version

Wert	Typ	Beschreibung	Version
id	int	ID des Nutzer-Status	ab Version 1.0
name	string	Name des Nutzer-Status	ab Version 1.0
description	string	Beschreibung des Nutzer-Status	ab Version 1.0

cable.user_state.create

Beschreibung

Legt einen neuen Nutzer-Status an.

Beispielaufruf

{
	"method":"cable.user_state.create",
	"params":{
		"apikey":"24174j3tqj",
		"data": {
			"name":"Status 1"
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version

Parameter	Typ	Beschreibung	Version
name	string	Name des Nutzer-Status	ab Version 1.0
description	string	Optional: Beschreibung des Nutzer-Status	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.user_state.update

Beschreibung

Aktualisiert einen bestehenden Nutzer-Status.

Beispielaufruf

{
	"method":"cable.user_state.update",
	"params":{
		"apikey":"24174j3tqj",
		"id":4,
		"data": {
			"description":"neuer Status"
		}
	},
	"version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version

Parameter	Typ	Beschreibung	Version
id	int	ID des Nutzer-Status	ab Version 1.0
name	string	Name des Nutzer-Status	ab Version 1.0
description	string	Beschreibung des Nutzer-Status	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.user_state.delete

Beschreibung

Löscht einen Nutzer-Status.

Beispielaufruf

{
	"method":"cable.user_state.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 Nutzer-Status	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