12.4 Call-API

Beschreibung

Die CALL-API ruft einen bestimmten Bereich in VIA auf. Sie hat keinen Rückgabewert und benötigt eine normale Browser-Sitzung.

Diese Schnittstelle dient VIA selbst 'Schnell-Links' zu erzeugen, um eine schelle Zusammenarbeit zwischen Benutzern zu ermöglichen oder wichtige Bereiche in Form von Hyperlinks zu speichern.

Außerdem ist es Fremdsystemen damit möglich den Nutzer nahtlos zu VIA zu führen und seine Arbeit damit zu beschleunigen und einfacher zu gestalten.

Zu einem CALL-Aufruf wird jeweils nur ein Parameter übergeben. Werden weitere Parameter übergeben, überschreiben Sie den jeweils vorigen. Schlägt der Aufruf fehl, weil bspw. der Parameter-Wert nicht gefunden werden kann oder das Ergebnis nicht eindeutig ist, wird dem Nutzer eine Fehler-Information angezeigt.

Der Nutzer muss entweder bereits eine aktive VIA-Session offen haben oder sich in VIA anmelden.

Historie: Eine frühere Version sah eine Gast-Funktion vor, in der der Empfänger des Links ohne sich anmelden zu müssen und ohne weitere Nutzerrechte auf die angezeigten Daten zugreifen konnte. Aus Sicherheitsgründen wird diese Funktion nicht mehr bereitgestellt.

Syntax

Wenn VIA über eine Standalone-Installation betrieben wird (Windows, OSX, Linux-Prozess)

HTML

// Schema:
[http://][IP oder Domain]:[Port]/?[Parameter-Name]=[Parameter-Wert]
// Example:
http://10.12.12.1:9416/?call_schueler_by_snr=1812345

HTML

Verfügbare Parameter

Bereich	Parameter	Bsp. Inhalt	Bsp. Request	Beschreibung
Schüler	call_schueler_by_snr	1812345	http://10.12.12.1:9416/?call_schueler_by_snr=1812345	Ruft das Datenblatt eines Schülers auf. Selektiert den richtigen Schüler anhand der uniquen Schülernummer
call_schueler_by_name	Lehmann, Lars	http://{instanz_url}/?call_schueler_by_name=Lehmann, Lars	Ruft das Datenblatt eines Schülers auf. Selektiert den richtigen Schüler anhand des Namens (Nachname, Vorname). Dieser Aufruf sollte nur in Verbindung einer absolut mit VIA synchronen Datenbank verwendet werden.
call_schueler_by_id	1	http://{instanz_url}/?call_schueler_by_id=1	Ruft das Datenblatt eines Schülers auf. Selektiert den richtigen Schüler anhand der uniquen VIA-internen ID
Tour	call_tour_by_name	MSN-10-205	http://10.12.12.1:9416/?call_tour_by_name=MSN-10-205	Ruft das Datenblatt einer Tour auf. Selektiert die richtige Tour anhand dem Tour-Name. Der Tour-Name (oder auch Los-Bezeichnung) ist in VIA ein starkes Feld (durch Nutzer eingegeben und gegengeprüft), das mehrere Korrelationen besitzt und stets unique sein wird.
call_tour_by_id	1	http://{instanz_url}/?call_tour_by_id=1	Ruft das Datenblatt einer Tour auf. Selektiert die richtige Tour anhand der VIA-internen ID.
Unternehmen	call_unternehmen_by_name	Fritzsche, Burgstädt	http://10.12.12.1:9416/?call_unternehmen_by_name=Fritzsche, Burgstädt	Ruft das Datenblatt eines Unternehmens auf. Selektiert das richtige Unternehmen anhand der Unternehmens-Kurzform. Die Unternehmens-Kurzform ist in VIA ein starkes Feld (durch Nutzer eingegeben und gegengeprüft), das mehrere Korrelationen besitzt und stets unique sein wird.
call_unternehmen_by_id	1	http://{instanz_url}/?call_unternehmen_by_id=1	Ruft das Datenblatt eines Unternehmens auf. Selektiert das richtige Unternehmen anhand der VIA-internen ID.
Schule	call_schule_by_name	OS Thalheim	http://10.12.12.1:9416/?call_schule_by_name=OS Thalheim	Ruft das Datenblatt einer Schule auf. Selektiert die richtige Schule anhand der Schul-Kurzform. Die Schul-Kurzform ist in VIA ein starkes Feld (durch Nutzer eingegeben und gegengeprüft), das mehrere Korrelationen besitzt und stets unique sein wird.
call_schule_by_id	1	http://{instanz_url}/?call_schule_by_id=1	Ruft das Datenblatt einer Schule auf. Selektiert die richtige Schule anhand der VIA-internen ID.
Haltestelle	call_haltestelle_by_name	Adorf, Gasthof	http://10.12.12.1:9416/?call_haltestelle_by_name=Adorf, Gasthof	Ruft das Datenblatt einer Haltestelle auf. Selektiert die richtige Haltestelle anhand der Haltestellen-Bezeichnung. Die Haltestellen-Bezeichnung ist in VIA ein starkes Feld (durch Nutzer eingegeben und gegengeprüft), das mehrere Korrelationen besitzt und stets unique sein wird.
call_haltestelle_by_nr	2000111	http://{instanz_url}/?call_haltestelle_by_nr=2000111	Ruft das Datenblatt einer Haltestelle auf. Selektiert die richtige Haltestelle anhand der Haltestellen-Nummer. Die Haltestellen-Nummer ist im Idealfall die von der Verkehrsbehörde festgelegte offizielle Nummer der Haltestelle.
call_haltestelle_by_id	1	http://{instanz_url}/?call_haltestelle_by_id=1	Ruft das Datenblatt einer Haltestelle auf. Selektiert die richtige Haltestelle anhand der VIA-internen ID.