Über Swagger können Sie eine Dokumentationsseite sowohl für die Live- als auch für die Trainingsumgebung von Coachview finden. Auf dieser Dokumentationsseite finden Sie die APIs (Entitäten) und mögliche Anweisungen (Anfragen), die derzeit verfügbar sind.

Inhaltsübersicht:


Seiten der Dokumentation:
Es ist wichtig zu wissen, dass es zwei Dokumentationsseiten gibt, da es Unterschiede in den Daten und den verfügbaren APIs für die Coachview Live- und Trainingsumgebung geben kann.
Auf diesen Dokumentationsseiten finden Sie eine Liste der verschiedenen APIs, für die eine oder mehrere Anfragen verfügbar sind. Die Anfragen sind nach Entitäten gruppiert.
  1. Klicken Sie hier für die Dokumentationsseite der Coachview-Trainingsumgebung.
  2. Klicken Sie hier für die Dokumentationsseite der Live-Umgebung von Coachview.
Bitte beachten Sie, dass Sie mit Swagger derzeit nicht in der Live-Umgebung testen können.

Bitte anmelden:
Wenn Sie nur die Dokumentation ansehen möchten, müssen Sie sich nicht anmelden. Wenn Sie testen möchten, müssen Sie sich anmelden. Der Token ist 30 Minuten lang gültig.
Klicken Sie auf die Schaltfläche "Autorisieren". Dadurch erhalten Sie Zugang zu den APIs und können mit den Tests beginnen.
Der folgende Bildschirm wird geöffnet.
  1. Eine client_id wird automatisch generiert.
  2. Markieren Sie immer "api general access".
  3. Liste der Geltungsbereiche (APIs). Markieren Sie die APIs, die Sie für den Test verwenden möchten. Testen Sie und haben Sie vergessen, die zu testende API hier zu überprüfen? Dann erhalten Sie nicht die richtigen Werte zurück, sondern Beispiele. Alle publicid's sind dann dieselben.
Scrollen Sie dann nach unten und klicken Sie auf die Schaltfläche "Autorisieren".
Sind Sie noch nicht bei Coachview eingeloggt? Dann erscheint der Coachview-Anmeldebildschirm. Melden Sie sich mit einem Benutzerkonto an, das über ausreichende Lese- und Schreibrechte verfügt.
Sie werden automatisch zur Dokumentationsseite von Swagger zurückkehren.

  1. Hier sehen Sie, dass Sie berechtigt sind.
  2. Schließen Sie den Bildschirm.
  3. Schließen Sie den Bildschirm.
  4. Schließen Sie den Bildschirm und melden Sie sich ab.
Vergessen Sie nicht, sich abzumelden, wenn Sie fertig sind.

Liste der APIs:
Sie kehren dann zur Dokumentationsseite zurück. Wenn das Schloss geschlossen ist, sind Sie weiterhin berechtigt.
Die Seite listet auch APIs auf, für die eine oder mehrere Anfragen verfügbar sind.

Requests:
Wenn Sie auf den Namen einer API (Entität) klicken, sehen Sie die Anfragen, die innerhalb dieser API möglich sind.
  1. Get: Datenabfrage.
  2. Post: Daten hinzufügen.
  3. Put: Daten ändern.
  4. Delete: Löschung von Daten.
  5. Patch: einen Teil der Daten zu ändern.
  1. Ein geschlossenes Vorhängeschloss zeigt an, dass Sie autorisiert sind und prüfen können.
  2. Ein offenes Schloss bedeutet, dass Sie nicht berechtigt sind und die Informationen nur einsehen können.
Wenn Sie auf den Namen eines Antrags klicken, sehen Sie dessen Dokumentation. Zum Beispiel das GET für das Schulung des Abrufs.
Sie werden zunächst eine kurze Erklärung und einige Beispiele sehen.
Im Folgenden finden Sie die verschiedenen Parameter mit einer kurzen Erklärung und einigen Beispielen für jeden Parameter.
Search:
  1. Erläuterung der Suchoptionen.
  2. Ein Beispiel dafür, was Sie eingeben können.
  3. Füllen Sie Ihr eigenes Suchkriterium aus. Search= kann weggelassen werden. Zum Beispiel den Code oder den Namen oder einen Teil des Namens des Schulungen.

Filter:
Je nach GET haben Sie die Möglichkeit, einen oder mehrere Filter zu setzen.
Beispiel Filter 1 Text:

Text als Filter. In diesem Beispiel können Sie einen oder mehrere Orte durch ein Komma getrennt hinzufügen.


Place= kann weggelassen werden.

Beispielfilter 2 IncludeFreeFields:

In Coachview ist es möglich, ein oder mehrere freie Felder für verschiedene Dateien einzurichten, in diesem Fall das Schulung. In diesen Feldern werden zusätzliche Informationen aufgezeichnet, die nicht von Coachview zur Verfügung gestellt werden.

  1. -- nicht anwendbar.
  2. richtig, ja geben Sie mir Informationen aus den freien Feldern.
  3. falsch, nein, ich möchte nicht sammeln.

Beispielfilter 3 PublicID:

Eine PublicID, die auf eine Datei in Coachview verweist. In diesem Beispiel ein Trainer. Sie können mehrere IDs, getrennt durch ein ',' (Komma), kombinieren. Die IDs von, in diesem Fall, Trainer werden mit einer anderen API abgerufen.


Nehmen Sie:

Die Anzahl der abzurufenden Ergebnisse. Der Standardwert ist 10 und der Höchstwert ist 100.


Take= kann weggelassen werden.


Skip:
Die Anzahl der zu überspringenden Ergebnisse. Kann für die Paginierung der abgerufenen Daten verwendet werden, in Kombination mit take.

Order by:
Sortieroptionen absteigend oder aufsteigend. Sie können alle Felder auf der höchsten Ebene verwenden. Zum Beispiel für die Schulung zu Name und/oder Code. Es ist auch möglich, mehrere Felder zu kombinieren, indem man sie mit einem ',' (Komma) trennt. Die Standardsortierung ist aufsteigend.

Where:
Zusätzliche Filter für ein oder mehrere Felder auf höchster Ebene. Es ist möglich, mehrere Filter zu kombinieren, indem man die Felder mit einem ',' (Komma) trennt.

Beispiel mit 1 Textfeld:

Suche nach (einem Teil) des Feldes.



Beispiel mit 2 Datumsfeldern und Zahlen:

Diese Operatoren sind erlaubt:

  1. Größer als: >
  2. Kleiner als: <
  3. Entspricht: =
  4. Nicht gleichzusetzen mit: <>
  5. Größer als oder gleich: >=
  6. Kleiner als oder gleich: <=

Ein Bereich kann angegeben werden, indem zwei Daten durch ein Komma getrennt werden.

Beispiel mit 3 Statusfeldern:

Das Filtern nach mehreren Werten gleichzeitig ist möglich, indem die Werte durch ein ',' (Komma) getrennt werden.

Beispiel mit 4 Ja/Nein-Feldern:

Verwenden Sie true (Ja) oder false (Nein).

Beispiel mit 5 freien Feldern:

Das Suchkriterium ist der Code des freien Feldes, gefolgt von dem zu suchenden Wert. Nur = (gleich) und <> (nicht gleich) sind erlaubt.


In Coachview haben wir als Beispiel das freie Feld eines Schulung.


Count:
Gibt nur die Anzahl der Ergebnisse zurück, es werden keine Daten abgerufen.

Wollen Sie testen und dabei Werte eintragen? Klicken Sie dann auf die Schaltfläche 'Try it out'.
Nach den Parametern finden Sie die Schaltfläche "Execute". Mit dieser Schaltfläche werden die Anfragen ausgeführt. Mit der Schaltfläche "Clear", die nach der ersten Ausführung execute, löschen Sie die eingegebenen Werte.

Server response:
Das Ergebnis wird mit Codes und bei Erfolg mit den abgerufenen Daten zurückgegeben.
Code 200 -> Details:
Erfolgreich. Einschließlich der abgerufenen Daten.
Code 200 -> Description: 
Beispielhafte (nicht reale) Daten.
Code 401 of 403:
Fehlermeldungen.
Curl:
Informationen, die erforderlich sind, um eine Anfrage zu stellen, z. B. von Postman.
Klicken Sie auf dieses Symbol, um das Ergebnis zu kopieren.
Request URL:
Hier können Sie sehen, wie die request ausgeführt wurde.
Nach /Schulungen sehen Sie ein ?, um anzuzeigen, dass Parameter folgen. In diesem Beispiel folgt auf "Take=1" ein "&", um anzuzeigen, dass ein weiterer Parameter folgt.