Skip to content

Latest commit

 

History

History
243 lines (174 loc) · 5.75 KB

API.md

File metadata and controls

243 lines (174 loc) · 5.75 KB

Sprachdialogsysteme API Documentation

Stand: 26. Mai 2014

API für den Server des Infosystems der THM im Rahmen des Faches Sprachdialogsysteme im Sommersemester 2014 an der Technischen Hochschule Mittelhessen.

Table of Contents generated with DocToc

Add Report: Start Call

Erstelle Logeintrag für Event: Start Call

Target

POST /reports/start

Parameters

Name Type Description
callId string Required ID of the Call
timestamp string Required Timestamp of the Report in the format "YYYY-MM-DDTHH:mm:ss"
ani string Required ANI of the Call

Request

curl -X POST "http://0.0.0.0:8080/reports/start?callId=123&timestamp=2014-05-27T12:15:11&ani=0800111111"

Response

Erfolgreich Eintrag angelegt und bekannte ANI

{
    "status": "ok",
    "name": "Max Mustermann"
}

Fehlende oder fehlerhafte Parameter

{
    "status": "not_ok",
    "name": ""
}

Add Report: Menu Choice

Erstelle Logeintrag für Menüauswahl-Event:

Target

POST /reports/menu

Parameters

Name Type Description
callId string Required ID of the Call
timestamp string Required Timestamp of the Report
choice string Required Menu-Choice

Request

curl -X POST "http://0.0.0.0:8080/reports/menu?callId=123&timestamp=2014-05-27T12:15:11&choice=asd"

Response

Erfolgreich angelegt

{
    "status": "ok"
}

Fehlende oder fehlerhafte Parameter

{
    "status": "not_ok"
}

Add Report: End Call

Erstelle Logeintrag für End-Call-Event:

Target

POST /reports/end

Parameters

Name Type Description
callId string Required. ID of the Call
timestamp string Required Timestamp of the Report

Request

curl -X POST "http://0.0.0.0:8080/reports/end?callId=123&timestamp=2014-05-27T12:15:11"

Response

Erfolgreich angelegt

{
    "status": "ok"
}

Fehlende oder fehlerhafte Parameter

{
    "status": "not_ok"
}

Check Matrikelnummer

Prüfe Matrikelnummer auf Gültigkeit und gebe Name zurück.

Target

GET /matrikelnummer

Parameters

Name Type Description
callId string Required. ID of the Call
matrikelnummer string Required. Matrikelnummer of the User

Request

curl -X GET "http://0.0.0.0:8080/matrikelnummer?callId=123&matrikelnummer=123456"

Response

Matrikelnummer gefunden

{
    "status": "ok",
    "name": "Max Mustermann"
}

Matrikelnummer nicht gefunden

{
    "status": "not_ok",
    "name": ""
}

ClassInfo

Gebe Informationen zu Kurs anhand von KursID.

Target

GET /class

Parameters

Name Type Description
callId string Required. ID of the Call
classId string Required. ID of the class

Request

curl -X GET "http://0.0.0.0:8080/class?callId=123&classId=MM14"

Response

Kurs gefunden

{
    "status": "ok",
    "classId": "MM14",
    "classTitle": "Konzeption von Sprachdialogsystemen und Realisierung von Sprachportalen",
    "description": "Vorlesung: Architektur und Komponenten von Voice Plattformen (Voice Engines und Prozesse), Konzeptionierung eines Voice-User-Interfaces (Dialogstrukturen, Prompting und Persona Design), Dialog Implementierung (VoiceXML, Grammatikerstellung, Audioaufbereitung) Konzeption und Aufbau eines Sprachportals, Dynamische Dialoge mit Content aus Datenbank, Planung und Management von Sprachprojekten Ausblick auf multimodale Interaktionssysteme. Praktikum: Programmierung eines Sprachdialogs in VoiceXML; Realisierung eines Sprachportals mit dynamischen Content aus Datenbank."
}

Kurs nicht gefunden

{
    "status": "not_ok",
    "classId": "",
    "classTitle": "",
    "description": ""
}