Seitenvergleich

...

Wert	Typ	Beschreibung	Version
id	int	ID des virtuellen Netzweges	ab Version 1.0
obj_id	int	ID des referenzierten virtuellen Netzweg-Objektes	ab Version 1.0
description	string	Beschreibung des virtuellen Netzweges	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
permission	string	Berechtigung	ab Version 1.0
location	string	Standort	ab Version 1.0
room	string	Raum	ab Version 1.0
device_type	string	Endgerätetyp	ab Version 1.0
device_number	string	Geräte Nummer	ab Version 1.0
phone_number	string	Rufnummer	ab Version 1.0
phone_subscriber	string	Teilnehmer	ab Version 1.0
route_usage_id	int	ID der zugewiesenen virtuellen Netzweg-Verwendung Siehe: https://smdocu.atlassian.net/l/c/ikSExjur	ab Version 1.0
hint	string	Hinweis	ab Version 1.0
start_obj_id	int	ID des ersten virtuellen Netzwegelementes	ab Version 1.0
end_obj_id	int	ID des letzten virtuellen Netzwegelementes	ab Version 1.0
length	int	Länge des virtuellen Netzweges in Meter	ab Version 1.0
measured_length	int	Gemessene Länge des virtuellen Netzweges in Meter	ab Version 1.0
measure_date	string	Messdatum des virtuellen Netzweges	ab Version 1.0
tka_participant	string	Name des TKA-Teilnehmers	ab Version 1.0
is_external	int	Gibt an, ob ein virtueller Netzweg vermietet ist	ab Version 1.0
associated_route	int	ID des zugehörigen virtuellen Netzweges	ab Version 1.0
damping_damping_left1	string	Dämpfung des virtuellen Netzweges (A → E 1310nm)	ab Version 1.0
damping_left2	string	Dämpfung des virtuellen Netzweges (A → E 1550nm)	ab Version 1.0
damping_right1	string	Dämpfung des virtuellen Netzweges (E → A 1310nm)	ab Version 1.0
damping_right2	string	Dämpfung des virtuellen Netzweges (E → A 1550nm)	ab Version 1.0

...

Parameter	Typ	Beschreibung	Version
obj_id	int	ID des referenzierten virtuellen Netzweg-Objektes	ab Version 1.0
description	string	Beschreibung des virtuellen Netzweges	ab Version 1.0
connection_count	int	Optional: Anzahl Verbindungen	ab Version 1.0
current_connection_count	int	Optional: Aktuelle Anzahl der Verbindungen	ab Version 1.0
permission	string	Optional: Berechtigung	ab Version 1.0
location	string	Optional: Standort	ab Version 1.0
room	string	Optional: Raum	ab Version 1.0
device_type	string	Optional: Endgerätetyp	ab Version 1.0
device_number	string	Optional: Geräte Nummer	ab Version 1.0
phone_number	string	Optional: Rufnummer	ab Version 1.0
phone_subscriber	string	Optional: Teilnehmer	ab Version 1.0
route_usage_id	int	ID der zugewiesenen virtuellen Netzweg-Verwendung Siehe: https://smdocu.atlassian.net/l/c/ikSExjur	ab Version 1.0
hint	string	Optional: Hinweis	ab Version 1.0
start_obj_id	int	Optional: ID des ersten virtuellen Netzwegelementes	ab Version 1.0
end_obj_id	int	Optional: ID des letzten virtuellen Netzwegelementes	ab Version 1.0
tka_participantlength	stringint	Optional: Name des TKA-TeilnehmersLänge des virtuellen Netzweges in Meter	ab Version 1.0
ismeasured_externallength	int	Optional: Gibt an, ob ein virtueller Netzweg vermietet ist. Zulässige Werte: 1 (virtuellen Netzweg ist vermietet) 0 (virtuellen Netzweg ist nicht vermietet)	ab	Gemessene Länge des virtuellen Netzweges in Meter	ab Version 1.0
associatedmeasure_routedate	intstring	Optional: ID Messdatum des zugehörigen virtuellen Netzweges	ab Version 1.0
dampingtka_left1participant	string	Optional: Dämpfung des virtuellen Netzweges (A → E 1310nm)Name des TKA-Teilnehmers	ab Version 1.0
dampingis_left2external	stringint	Optional : Dämpfung des virtuellen Netzweges (A → E 1550nm : Gibt an, ob ein virtueller Netzweg vermietet ist. Zulässige Werte: 1 (virtuellen Netzweg ist vermietet) 0 (virtuellen Netzweg ist nicht vermietet)	ab Version 1.0
damping_right1left1	string	Optional: Dämpfung des virtuellen Netzweges (A → E → A 1310nm)	ab Version 1.0
damping_right2left2	string	Optional: Dämpfung des virtuellen Netzweges (A → E → A 1550nm)	ab Version 1.0
redundantdamping_routesright1	string	Optional: Kommaseparierte Liste von redundanten virtuellen Netzweg-IDsDämpfung des virtuellen Netzweges (E → A 1310nm)	ab Version 1.0
damping_right2	string	Optional: Dämpfung des virtuellen Netzweges (E → A 1550nm)	ab Version 1.0

Rückgabewert

...

Parameter	Typ	Beschreibung	Version
id	int	ID des virtuellen Netzweges	ab Version 1.0
description	string	Beschreibung des virtuellen Netzweges	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
permission	string	Berechtigung	ab Version 1.0
location	string	Standort	ab Version 1.0
room	string	Raum	ab Version 1.0
device_type	string	Endgerätetyp	ab Version 1.0
device_number	string	Geräte Nummer	ab Version 1.0
phone_number	string	Rufnummer	ab Version 1.0
phone_subscriber	string	Teilnehmer	ab Version 1.0
route_usage_id	int	ID der zugewiesenen virtuellen Netzweg-Verwendung Siehe: https://smdocu.atlassian.net/l/c/ikSExjur	ab Version 1.0
hint	string	Hinweis	ab Version 1.0
start_obj_id	int	ID des ersten virtuellen Netzwegelementes	ab Version 1.0
end_obj_id	int	ID des letzten virtuellen Netzwegelementes	ab Version 1.0
tka_participantlength	stringint	Name des TKA-TeilnehmersLänge des virtuellen Netzweges in Meter	ab Version 1.0
measured_length	int	Gemessene Länge des virtuellen Netzweges in Meter	ab Version 1.0
measure_date	string	Messdatum des virtuellen Netzweges	ab Version 1.0
tka_participant	string	Name des TKA-Teilnehmers	ab Version 1.0
is_external	int	Gibt an, ob ein virtueller Netzweg vermietet ist. Zulässige Werte: 1 (virtuellen Netzweg ist vermietet) 0 (virtuellen Netzweg ist nicht vermietet)	ab Version 1.0
associated_route	int	ID des zugehörigen virtuellen Netzweges	ab Version 1.0
dampingdamping_left1	string	Dämpfung des virtuellen Netzweges (A → E 1310nm)	ab Version 1.0
damping_left2	string	Dämpfung des virtuellen Netzweges (A → E 1550nm)	ab Version 1.0
damping_right1	string	Dämpfung des virtuellen Netzweges (E → A 1310nm)	ab Version 1.0
damping_right2	string	Dämpfung des virtuellen Netzweges (E → A 1550nm)	ab Version 1.0	redundant_routes	string	Kommaseparierte Liste von redundanten virtuellen Netzweg-IDs	ab Version 1.0

Rückgabewert

...

Gibt die automatisch berechnete Dämpfung eines virtuellen Netzweges aus.

Beispielaufruf

Codeblock
{ "method":"cable.virtual_route.get_calculated_damping", "params":{ "apikey":"24174j3tqj", "obj_id":4 }, "version":"2.0", "id": 1 }

Parameter

Parameter	Typ	Beschreibung	Version
obj_id	int	ID des virtuellen Netzweg-Objektes	ab Version 1.0

Rückgabewert

Wert	Typ	Beschreibung	Version
length	int	Gesamtlänge des virtuellen Netzweges	ab Version 1.0
length_1310	float	Wellenlänge 1310nm	ab Version 1.0
length_1550	float	Wellenlänge 1550nm	ab Version 1.0
sum_1310	float	Gesamtdämpfung 1310nm	ab Version 1.0
sum_1550	float	Gesamtdämpfung 1550nm	ab Version 1.0
connectors	array	Liste der beteiligten Anschlüsse mit deren Anzahl und oberer Übergangsdämpfung	ab Version 1.0

...

cable.virtual_route.validate

Beschreibung

Prüft ob der virtuelle Netzweg als normaler Netzweg ins System übernommen werden kann.

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
	"method":"cable.virtual_route.validate",
    "params":{
        "apikey":"24174j3tqj",
        "obj_id": 1234
    },
    "version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
obj_id	int	ID des virtuellen Netzweges	ab Version 1.0

Rückgabewert

Wert	Typ	Beschreibung	Version
is_valid	boolean	Gibt an, ob der virtuelle Netzweg angelegt werden kann oder nicht	ab Version 1.0
message	string	Eine entsprechende Meldung dazu	ab Version 1.0
patched_connectors	array	Falls der Netzweg nicht angelegt kann, werden hier alle bereits gepatchten Anschlüsse aufgelistet	ab Version 1.0

...

cable.virtual_route.convert

Beschreibung

Übernimmt den virtuellen Netzweg als normalen Netzweg ins System.

Beispielaufruf

Codeblock

language	bash
theme	RDark

{
	"method":"cable.virtual_route.get_calculated_dampingconvert",
    "params":{
        "apikey":"24174j3tqj",
        "obj_id":4 1234
    },
    "version":"2.0",
    "id": 1
}

Parameter

Parameter	Typ	Beschreibung	Version
obj_id	int	ID des

virtuellen Netzweg-Objektesab Version 1.0

Rückgabewert

WertTypBeschreibungVersionlengthintGesamtlänge des virtuellen Netzwegesab Version 1.0length_1310floatWellenlänge 1310nm

Ausgangs-Objektes

ab Version 1.0

length_1550floatWellenlänge 1550nmab Version 1.0sum_1310floatGesamtdämpfung 1310nm

Rückgabewert

Wert	Typ	Beschreibung	Version
current_date	string	Zeitstempel	ab Version 1.0

sum_1550

id

floatGesamtdämpfung 1550nm

int

ID des neu erzeugten Netzweges

ab Version 1.0

connectors

message

arrayListe der beteiligten Anschlüsse mit deren Anzahl und oberer Übergangsdämpfung

string

Ausgabemeldung

ab Version 1.0

...

cable.virtual_route.delete

Beschreibung

Löscht einen virtuellen Netzweg.

Beispielaufruf

Codeblock

language	bash
theme	RDark

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

Parameter

Parameter	Typ	Beschreibung	Version
id	int	ID des zu löschenden virtuellen Netzweges	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

...

Versionen im Vergleich

Alte Version 1

Neue Version Aktuell

Schlüssel

Rückgabewert

Rückgabewert

Beispielaufruf

Parameter

Rückgabewert

cable.virtual_route.validate

Beschreibung

Beispielaufruf

Parameter

Rückgabewert

cable.virtual_route.convert

Beschreibung

Beispielaufruf

Parameter

Rückgabewert

Rückgabewert

cable.virtual_route.delete

Beschreibung

Beispielaufruf

Parameter

Rückgabewert