...
Inhalt | ||||||
---|---|---|---|---|---|---|
|
...
cable.user_
...
state.read
Beschreibung
Gibt alle Nutzer-Status zurück.
...
Lesen eines speziellen Nutzer-Status:
Codeblock | ||||
---|---|---|---|---|
| ||||
{ "method":"cable.user_statusstate.read", "params":{ "apikey":"24174j3tqj", "id": 4 }, "version":"2.0", "id": 1 } |
Filtern von Nutzer-Status:
Codeblock | ||||
---|---|---|---|---|
| ||||
{ "method":"cable.user_statusstate.read", "params":{ "apikey":"24174j3tqj", "filter": { "name": "Status %" } }, "version":"2.0", "id": 1 } |
Parameter
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 |
...
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
Codeblock | ||||
---|---|---|---|---|
| ||||
{ "method":"cable.user_statusstate.create", "params":{ "apikey":"24174j3tqj", "data": { "name":"Status 1" } }, "version":"2.0", "id": 1 } |
Parameter
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 |
...
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
Codeblock | ||||
---|---|---|---|---|
| ||||
{ "method":"cable.user_statusstate.update", "params":{ "apikey":"24174j3tqj", "id":4, "data": { "description":"neuer Status" } }, "version":"2.0", "id": 1 } |
Parameter
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 |
...
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
Codeblock | ||||
---|---|---|---|---|
| ||||
{ "method":"cable.user_statusstate.delete", "params":{ "apikey":"24174j3tqj", "id":4 }, "version":"2.0", "id": 1 } |
Parameter
Parameter | Typ | Beschreibung | Version |
---|---|---|---|
id | int | ID des zu löschenden Nutzer-Status | ab Version 1.0 |
...