Verwaltung von StreckenNetzweg-Elementen.
Seitenverzeichnis:
Inhalt |
---|
maxLevel | 2 |
---|
indent | 10px |
---|
style | square |
---|
|
...
cable.
...
route_element.read
Beschreibung
Gibt alle StreckenNetzweg-Elemente zurück.
Beispielaufruf
Lesen eines speziellen Netzweg-Elements:
Codeblock |
---|
|
{
"method":"cable. |
...
route_element.read",
"params":{
"apikey":"24174j3tqj",
"id": 4
},
"version":"2.0",
"id": 1
} |
Filtern von Netzweg-Elementen:
...
cable.route_element.read",
"params":{
"apikey":" |
...
...
...
"filter": {
"index": 1
}
},
"version":"2.0",
"id": 1
} |
Parameter
Parameter | Typ | Beschreibung | Version |
---|
id | int | Optional: ID des Netzweg-Elementes | ab Version 1.0 |
filter | array | Optional: Filter für |
StreckenNetzweg-Elemente Der Filter unterstützt alle Eigenschaften des |
StreckenNetzweg-Elementes (siehe Rückgabewerte). Als Suchkriterium kann das Prozent-Zeichen "%" als Wildcard verwendet werden. | ab Version 1.0 |
Rückgabewert
Liste aller StreckenNetzweg-Elemente.
Wert | Typ | Beschreibung | Version |
---|
id | int | ID des |
StreckenNetzweg-Elementes | ab Version 1.0 |
sectionroute_id | int | ID des referenzierten |
Streckeconnectionwire_id | int | ID der referenzierten |
VerbindungindexIndex innerhalb der Reihenfolge der Elemente einer ID der referenzierten Strecke | ab Version 1.0 |
descriptionBeschreibung des Strecken-Elementesstring | int | Index innerhalb der Reihenfolge der Elemente eines Netzweges | ab Version 1.0 |
...
cable.
...
route_element.create
Beschreibung
Legt ein neues StreckenNetzweg-Element an.
Beispielaufruf
Codeblock |
---|
|
{
"method":"cable. |
...
route_element.create",
"params":{
"apikey":"24174j3tqj",
" |
...
...
{
"route_id":1,
"wire_id":2,
"index":1
}
},
"version":"2.0",
"id": 1
} |
Parameter
Parameter | Typ | Beschreibung | Version |
---|
objroute_id | int | ID des referenzierten |
Strecken-ObjektesdescriptionBeschreibung der Streckestring | int | Index innerhalb der Reihenfolge der Elemente eines Netzweges | ab Version 1.0 |
connectioncountAnzahl VerbindungenOptional: ID der referenzierten Ader (Hinweis: wire_id oder section_id muss gesetzt werden!) | ab Version 1.0 |
currentconnection_countAktuelle Anzahl der VerbindungenOptional: ID der referenzierten Strecke (Hinweis: wire_id oder section_id muss gesetzt werden!) | 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.
...
route_element.update
Beschreibung
Aktualisiert ein bestehendes StreckenNetzweg-Element.
Beispielaufruf
Codeblock |
---|
|
{
"method":"cable. |
...
route_element.update",
"params":{
"apikey":"24174j3tqj", |
...
...
...
{
"wire_id": 8
}
},
"version":"2.0",
"id": 1
} |
Parameter
Parameter | Typ | Beschreibung | Version |
---|
section_element_ StreckenNetzweg-Elementes | ab Version 1.0 |
descriptionBeschreibung der Streckestring | int | Index innerhalb der Reihenfolge der Elemente eines Netzweges | ab Version 1.0 |
connectioncountAnzahl VerbindungenID der referenzierten Ader | ab Version 1.0 |
currentconnection_countAktuelle Anzahl Verbindungenreferenzierten Strecke | 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.
...
route_element.delete
Beschreibung
Löscht ein StreckenNetzweg-Element.
Wichtig: Es kann immer nur das jeweils letzte Netzweg-Element gelöscht werden. Ein Löschen von Elementen innerhalb eines Netzweges ist nicht möglich.
Beispielaufruf
Codeblock |
---|
|
{
"method":"cable. |
...
route_element.delete",
"params":{
"apikey":"24174j3tqj", |
...
...
"version":"2.0",
"id": 1
} |
Parameter
Parameter | Typ | Beschreibung | Version |
---|
section_element_id | int | ID des zu löschenden |
StreckenNetzweg-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 |
...