VoiceForm-Webservices
VoiceCheck stellt einen Webservice bereit, mit dem ein VoiceForm erstellt werden kann, das im Grunde nichts anderes als ein Datenimport ist. Mit diesem Webservice können sowohl neue VoiceForms erstellt als auch vorhandene VoiceForms aktualisiert und vom VoiceCheck-Server gelöscht werden. Wenn dieser Webservice aufgerufen wird, validiert VoiceCheck das System und prüft Folgendes:
- Wenn kein passender VoiceForm-Name vorhanden ist, wird ein neues VoiceForm erstellt.
- Wenn ein passender VoiceForm-Name vorhanden ist, wird kein neues VoiceForm erstellt.
Ein VoiceForm kann mit oder ohne VoiceForm-Schritten importiert werden. Das Importieren ohne Schritte bietet Technikern die Möglichkeit, die VoiceForm-Schritte zu einem späteren Zeitpunkt zu erstellen.
Wenn VoiceCheck diese Meldung zum Lesen, Aktualisieren und Löschen von VoiceForms empfängt, finden die folgenden Validierungen statt:
- Wenn der VoiceForm-Name in VoiceCheck nicht vorhanden ist, werden in der Antwort keine Details zurückgegeben.
- Wenn das VoiceForm vorhanden ist, kann der Webservice nur den Namen des VoiceForm aktualisieren.
- Wenn das VoiceForm nicht auf eine andere Entität in VoiceCheck verweist, kann es gelöscht werden. Anderenfalls ist die Löschung des VoiceForm nicht zulässig.
VoiceForm-Details erstellen
REST-Webservice
WADL: <http oder https>://<Host>:<Port>/VoiceCheck/services/voiceform?_wadl
URL: <http oder https>://<Host>:<Port>/VoiceCheck/services/voiceform
Methode: POST
Inhaltstyp: application/json;charset=UTF-8
Meldungstext: JSON gemäß Schema in der WADL-Datei. Die Elemente sind in der Eingabeelementetabelle beschrieben.
Antwort: Bei Erfolg wird der HTTP-Statuscode 200 mit Payload "VoiceForm saved" zurückgegeben. Bei Fehlern gibt das System eine Fehlermeldung aus. Jeder andere HTTP-Statuscode als 200 oder 204 wird als Fehler gewertet. Wenn möglich, sollte das Hostsystem bei Fehlern Text zurückgeben.
POST-Parameter
VoiceForm-Datei mit gültigen Parametern im Text.
VOICEFORM-DETAILS LESEN
REST-WEBSERVICE
WADL: <http oder https>://<Host>:<Port>/VoiceCheck/services/voiceform?_wadl
URL: <http oder https>://<Host>:<Port>/VoiceCheck/services/voiceform/{voiceformname}
Methode: GET
Inhaltstyp: application/json;charset=UTF-8
Antwort: Bei Erfolg wird der HTTP-Statuscode 200 mit oder ohne Text zurückgegeben. Bei Fehlern gibt das System eine Fehlermeldung aus.
VOICEFORM-DETAILS AKTUALISIEREN
WADL: <http oder https>://<Host>:<Port>/VoiceCheck/services/voiceform?_wadl
URL: <http oder https>://<Host>:<Port>/VoiceCheck/services/voiceform/update/{voiceformname}/{newvoiceformname}
Methode: POST
Inhaltstyp: application/json;charset=UTF-8
Antwort: Bei Erfolg wird der HTTP-Statuscode 200 mit oder ohne Text zurückgegeben. Bei Fehlern gibt das System eine Fehlermeldung aus.
VOICEFORM-DETAILS LÖSCHEN
WADL: <http oder https>://<Host>:<Port>/VoiceCheck/services/voiceform?_wadl
URL: <http oder https>://<Host>:<Port>/VoiceCheck/services/voiceform/{voiceformname}
Methode: DELETE
Antwort: Bei Erfolg wird der HTTP-Statuscode 200 mit oder ohne Text zurückgegeben. Bei Fehlern gibt das System eine Fehlermeldung aus.
Bilder verwalten
REST-WEBSERVICE
WADL: <http oder https>://<Host>:<Port>/VoiceCheck/services/imageService?_wadl
URL: <http oder https>://<VoiceCheck-IP>:<Port>/VoiceCheck/services/imageService/<Verzeichnis/Ordnername><Verzeichnis/Ordnername>.....<Foto-Dateiname mit Erweiterung>
Methode: GET
Parameter: Bildpfad im Dateisystem mit Bildname (Parameter wird an die URL gesendet)
Inhaltstyp: (leer)
Antwort: Bei Erfolg wird der HTTP-Statuscode 200 zurückgegeben. Wird das Foto nicht gefunden, generiert der Service eine WebAppplicationException mit dem HTTP-Statuscode 404 (nicht gefunden).
Basisauthentifizierung: VoiceCheck-Benutzername und -Kennwort
EINGABEELEMENTE
| EIGENSCHAFT | TYP | PFLICHT? | DEFINITION | VALIDIERUNG |
|---|---|---|---|---|
| voiceformname |
Zeichenfolge |
Ja | Name des VoiceForm | Muss innerhalb von VoiceCheck eindeutig sein |