Verwaltung von Strecken-Elementen.
Seitenverzeichnis:
cable.section.read
Beschreibung
Gibt alle Strecken-Elemente zurück.
Beispielaufruf
{"method":"cable.section_element.read","params":{"apikey":"24174j3tqj", filter: {"description": "Typ %"}},"id":1,"version":"2.0"}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| filter | array | Optional: Filter für Strecken-Elemente Der Filter unterstützt alle Eigenschaften des Strecken-Elementes (siehe Rückgabewerte). Als Suchkriterium kann das Prozent-Zeichen "%" als Wildcard verwendet werden. | ab Version 1.0 |
Rückgabewert
Liste aller Strecken.
| Wert | Typ | Beschreibung | Version |
|---|---|---|---|
| id | int | ID des Strecken-Elementes | ab Version 1.0 |
| section_id | int | ID des referenzierten Strecke | ab Version 1.0 |
| connection_id | int | ID der referenzierten Verbindung | ab Version 1.0 |
| index | int | Index innerhalb der Reihenfolge der Elemente einer Strecke | ab Version 1.0 |
| description | string | Beschreibung des Strecken-Elementes | ab Version 1.0 |
cable.section.create
Beschreibung
Legt ein neues Strecken-Element an.
Beispielaufruf
{"method":"cable.section_element.create","params":{"apikey":"24174j3tqj","description":"Strecke A","connection_count":40},"id":1,"version":"2.0"}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| obj_id | int | ID des referenzierten Strecken-Objektes | ab Version 1.0 |
| description | string | Beschreibung der Strecke | ab Version 1.0 |
| connection_count | int | Anzahl Verbindungen | ab Version 1.0 |
| current_connection_count | int | Aktuelle Anzahl der Verbindungen | 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.section.update
Beschreibung
Aktualisiert ein bestehendes Strecken-Element.
Beispielaufruf
{"method":"cable.section_element.update","params":{"apikey":"24174j3tqj","section_element_id":4,"description":"Strecke A","connection_count":40},"id":1,"version":"2.0"}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| section_element_id | int | ID des Strecken-Elementes | ab Version 1.0 |
| description | string | Beschreibung der Strecke | ab Version 1.0 |
| connection_count | int | Anzahl Verbindungen | ab Version 1.0 |
| current_connection_count | int | Aktuelle Anzahl der Verbindungen | 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.section.delete
Beschreibung
Löscht ein Strecken-Element.
Beispielaufruf
{"method":"cable.section_element.delete","params":{"apikey":"24174j3tqj","section_element_id":4},"id":1,"version":"2.0"}
Parameter
| Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
| section_element_id | int | ID des zu löschenden Strecken-Elementes | 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 |