Mikrorohr
- Steve Gröber
- Florian Weber
Verwaltung von Mikrorohren.
Seitenverzeichnis:
- 1 cable.micro_pipe.get_micro_pipe_groups
- 2 cable.micro_pipe.get_micro_pipe_group
- 3 cable.micro_pipe.get_branching_points
- 4 cable.micro_pipe.get_cables
- 5 cable.micro_pipe.get_connectors
- 6 cable.micro_pipe.get_parent_station_or_tunnel
- 7 cable.micro_pipe.get_micro_pipe_section_title
- 8 cable.micro_pipe.assign_cable_to_micro_pipe_section
- 9 cable.micro_pipe.reject_cable_from_micro_pipe_section
- 10 cable.micro_pipe.save_connector
cable.micro_pipe.get_micro_pipe_groups
Beschreibung
Gibt alle Mikrorohr-Verbände zurück.
Beispielaufruf
{
"method":"cable.micro_pipe.get_micro_pipe_groups",
"params":{
"apikey":"24174j3tqj"
},
"version":"2.0",
"id": 1
}Parameter
keine
Rückgabewert
Gibt alle Mikrorohr-Verbände mit deren Mikrorohren aus.
Wert | Typ | Beschreibung | Version |
|---|---|---|---|
id | int | ID des Mikrorohr-Verbundes | ab Version 2024.3.0 |
title | string | Titel des Mikrorohr-Verbundes | ab Version 2024.3.0 |
micro_pipes | array | Auflistung der zugewiesenen Mikrorohre mit folgenden Eigenschaften:
| ab Version 2024.3.0 |
cable.micro_pipe.get_micro_pipe_group
Beschreibung
Gibt einen Mikrorohr-Verbund zurück.
Beispielaufruf
{
"method":"cable.micro_pipe.get_micro_pipe_group",
"params":{
"apikey":"24174j3tqj",
"micro_pipe_group_id": 4
},
"version":"2.0",
"id": 1
}Parameter
Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
micro_pipe_group_id | int | ID des Mikrorohr-Verbundes | ab Version 2025.1.0 |
micro_pipe_id | int | Optional: ID des Mikrorohres, dessen Verbund zurück gegeben wird | ab Version 2025.1.0 |
Rückgabewert
Gibt den Mikrorohr-Verband mit dessen Mikrorohren aus.
Wert | Typ | Beschreibung | Version |
|---|---|---|---|
id | int | ID des Mikrorohr-Verbundes | ab Version 2025.1.0 |
title | string | Titel des Mikrorohr-Verbundes | ab Version 2025.1.0 |
micro_pipes | array | Auflistung der zugewiesenen Mikrorohre mit folgenden Eigenschaften:
| ab Version 2025.1.0 |
cable.micro_pipe.get_branching_points
Beschreibung
Gibt alle Abzweigstellen zurück.
Beispielaufruf
{
"method":"cable.micro_pipe.get_branching_points",
"params":{
"apikey":"24174j3tqj"
},
"version":"2.0",
"id": 1
}Parameter
Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
micro_pipe_group_id | int | Optional: Filter anhand der ID eines Mikrorohr-Verbundes | ab Version 2025.1.0 |
Rückgabewert
Gibt die Abzweigstellen aus.
Wert | Typ | Beschreibung | Version |
|---|---|---|---|
id | int | ID der Abzweigstelle | ab Version 2025.1.0 |
title | string | Titel der Abzweigstelle | ab Version 2025.1.0 |
depth | int | Bautiefe der Abzweigstelle | ab Version 2025.1.0 |
location_id | int | ID des Standortes der Abzweigstelle | ab Version 2025.1.0 |
location | string | Name des Standortes der Abzweigstelle | ab Version 2025.1.0 |
cable.micro_pipe.get_cables
Beschreibung
Gibt alle eingeblasenen Kabel zurück.
Beispielaufruf
{
"method":"cable.micro_pipe.get_cables",
"params":{
"apikey":"24174j3tqj"
},
"version":"2.0",
"id": 1
}Parameter
Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
section_id | int | Optional: Filter anhand der ID einer Mikrorohr-Strecke | ab Version 2025.1.0 |
Rückgabewert
Gibt die eingeblasenen Kabel aus.
Wert | Typ | Beschreibung | Version |
|---|---|---|---|
id | int | ID des Kabels | ab Version 2025.1.0 |
title | string | Titel des Kabels | ab Version 2025.1.0 |
section_id | int | ID der Mikrorohr-Strecke | ab Version 2025.1.0 |
cable.micro_pipe.get_connectors
Beschreibung
Gibt alle Mikrorohr-Verbinder zurück.
Beispielaufruf
{
"method":"cable.micro_pipe.get_connectors",
"params":{
"apikey":"24174j3tqj",
"connector_ids":[4,18],
"branching_point_ids":[231]
},
"version":"2.0",
"id": 1
}Parameter
Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
connector_ids | array | Liste von IDs der Mikrorohr-Verbinder | ab Version 2024.3.0 |
branching_point_ids | array | Liste von IDs der Abzweigstellen | ab Version 2024.3.0 |
Rückgabewert
Wert | Typ | Beschreibung | Version |
|---|---|---|---|
id | int | ID des Mikrorohr-Verbinders | ab Version 2024.3.0 |
title | string | Titel des Mikrorohr-Verbinders | ab Version 2024.3.0 |
left_segment_id | int | ID des verbundenen Mikrorohr-Segmentes links | ab Version 2024.3.0 |
right_segment_id | int | ID des verbundenen Mikrorohr-Segmentes rechts | ab Version 2024.3.0 |
branching_point_id | int | ID der verbundenen Abzweigstelle | ab Version 2024.3.0 |
branching_point_title | string | Titel der verbundenen Abzweigstelle | ab Version 2024.3.0 |
location_id | int | ID des Standortes der Abzweigstelle | ab Version 2024.3.0 |
location_title | string | Titel des Standortes der Abzweigstelle | ab Version 2024.3.0 |
cable.micro_pipe.get_parent_station_or_tunnel
Beschreibung
Gibt den Namen des darüber liegenden Bahnhofes oder Gleisabschnittes zurück.
Beispielaufruf
{
"method":"cable.micro_pipe.get_parent_station_or_tunnel",
"params":{
"apikey":"24174j3tqj",
"object_id": 4
},
"version":"2.0",
"id": 1
}Parameter
Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
object_id | int | ID des Objektes, dessen Standort ermittelt werden soll | ab Version 2025.1.0 |
Rückgabewert
Gibt den Namen des darüber liegenden Bahnhofes oder Gleisabschnittes aus.
Wert | Typ | Beschreibung | Version |
|---|---|---|---|
id | int | ID des Standortes | ab Version 2025.1.0 |
title | string | Titel des Standortes | ab Version 2025.1.0 |
cable.micro_pipe.get_micro_pipe_section_title
Beschreibung
Gibt den nächsten Namen einer Mikrorohr-Strecke zurück.
Beispielaufruf
{
"method":"cable.micro_pipe.get_micro_pipe_section_title",
"params":{
"apikey":"24174j3tqj",
"first_segment_id": 4,
"first_connector_id": 6,
"last_connector_id": 8
},
"version":"2.0",
"id": 1
}Parameter
Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
first_segment_id | int | Optional: ID des ersten Mikrorohr-Segments der Strecke | ab Version 2025.1.1 |
first_connector_id | int | Optional: ID des ersten Mikrorohr-Verbinders der Strecke | ab Version 2025.1.1 |
last_segment_id | int | Optional: ID des letzten Mikrorohr-Segments der Strecke | ab Version 2025.1.1 |
last_connector_id | int | Optional: ID des letzten Mikrorohr-Verbinders der Strecke | ab Version 2025.1.1 |
flip_in_out | boolean | Optional: Falls eine Mikrorohr-Strecke nur aus einem Mikrorohr-Segment besteht, kann mit diesem Parameter angegeben werden, ob die ermittelten Standorte getauscht werden. Gültige Werte:
| ab Version 2025.2.0 |
Rückgabewert
Gibt den neuen Namen der Mikrorohr-Strecke aus.
Wert | Typ | Beschreibung | Version |
|---|---|---|---|
title | string | Titel der neue Mikrorohr-Strecke | ab Version 2025.1.0 |
cable.micro_pipe.assign_cable_to_micro_pipe_section
Beschreibung
Weist ein Kabel einer Mikrorohr-Strecke zu.
Beispielaufruf
{
"method":"cable.micro_pipe.assign_cable_to_micro_pipe_section",
"params":{
"apikey":"24174j3tqj",
"cable_id":4,
"segment_id":8
},
"version":"2.0",
"id": 1
}Parameter
Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
cable_id | int | ID des Kabels | ab Version 2024.3.0 |
segment_id | int | ID des Mikrorohr-Segmentes | ab Version 2024.3.0 |
Rückgabewert
kein Rückgabewert
cable.micro_pipe.reject_cable_from_micro_pipe_section
Beschreibung
Löscht die Kabelzuweisung zu einer Mikrorohr-Strecke.
Beispielaufruf
{
"method":"cable.micro_pipe.reject_cable_from_micro_pipe_section",
"params":{
"apikey":"24174j3tqj",
"cable_id":4
},
"version":"2.0",
"id": 1
}Parameter
Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
cable_id | int | ID des Kabels | ab Version 2024.3.0 |
Rückgabewert
kein Rückgabewert
cable.micro_pipe.save_connector
Beschreibung
Speichert einen Mikrorohr-Verbinder.
Beispielaufruf
{
"method":"cable.micro_pipe.save_connector",
"params":{
"apikey":"24174j3tqj",
"connector_id": 11,
"segment_id": 22,
"connected_segment_id": 33,
"segment_side": "left",
"branching_point_id": 44,
},
"version":"2.0",
"id": 1
}Parameter
Parameter | Typ | Beschreibung | Version |
|---|---|---|---|
connector_id | int | ID des Mikrorohr-Verbinders | ab Version 2025.2.0 |
segment_id | int | ID des Mikrorohr-Segments | ab Version 2025.2.0 |
connected_segment_id | int | Optional: ID des verbundenen Mikrorohr-Segments | ab Version 2025.2.0 |
segment_side | string | Optional: zu verbindende Seite am Mikrorohr-Segment Mögliche Werte:
| ab Version 2025.2.0 |
branching_point_id | int | Optional: ID der Abzweigstelle | ab Version 2025.2.0 |
Rückgabewert
kein Rückgabewert
Related content
(c) 2024 SHD System-Haus-Dresden GmbH | Impressum https://www.shd-online.de/impressum/