Grundlagen

Rolle des MMXL Web Service

Der MMXL Web Service macht die Funktionen der MMXL Schnittstelle des Medinet Prozesses via HTTP verfügbar. Während die originale MMXL Schnittstelle von Medinet XML zur Darstellung der Datenstrukturen verwendet, konvertiert der MMXL Web Service diese an seinem öffentlichen API in JSON und wieder zurück, um die Benutzung der MMXL Funktionen für Web Clients zu vereinfachen.

Die Schnittstelle des MMXL Web Service ist nach dem REST Paradigma (Wiki REST) gestaltet. D.h. die Anforderungen werden direkt mit HTTP an unterschiedliche URLs geschickt und die Antworten kommen direkt in den HTTP Nachrichten - meist als JSON- Objekte dargestellt - zurück. Insbesondere wird kein gesondertes Protokoll wie z.B. SOAP oder XML-RPC verwendet.

Für die Parameter und Resultate der MMXL Web Service Operationen wird weitgehend JSON verwendet, da es besonders einfach von JavaScript verwendet werden kann, aber auch geeignete Bibliotheken für viele andere Programmiersprachen zur Verfügung stehen.

Versionierung des REST Interfaces

Durch Voranstellen eines Präfix vi (i = 1..n) an die URLs der Routen erfolgt eine Versionierung der MMXL APIs. Aktuell gibt es v1 (Version 1) des API. Die komplette URL einer Operation setzt sich daher wie folgt zusammen:

HOST_ADDRESS/v1/ROUTE

zum Beispiel könnte die URL zum Abruf aller vorliegenden Analysen wie folgt lauten:

In den folgenden Dokumentationen der einzelnen Routen und Operation wird der Versionspräfix in der Regel nicht dargestellt. Er ist sinngemäß jeder Route wie hier beschrieben voranzustellen.

Table Of Contents

Previous topic

mediMACH Web Service Documentation

Next topic

API V1 Reference Documentation

This Page