© 2022 by Elsevier GmbH
Bitte nutzen Sie das untenstehende Formular um uns Kritik, Fragen oder Anregungen zukommen zu lassen.
Willkommen
Mehr InformationenMedizinwelt API
-
1.1
-
1.2
-
1.3
-
1.4
-
1.5
-
1.6
-
1.7
1.1
Allgemeines
1.1.1
API Schlüssel
1.1.2
User Token
1.1.3
Anfrageformat
API URL
https://medizinwelt.elsevier-staging.de/api/{main-action}/{specific-action}?options
-
search (siehe 1.2 Suchen)
-
get
-
set
1.1.4
Rückgabeformat
1.2
Suchen
1.2.1
Allgemeine Form
Suchen URL
https://medizinwelt.elsevier-staging.de/api/search/{specific-action}?options
1.2.2
Spezifische Aktionen
-
medizinwelt (Durchsuche Buchkapitel der Medizinwelt)
-
wirkstoffe (Durchsuche Wirkstoffe der Medizinwelt)
-
medikament (Durchsuche Medikamente der Medizinwelt)
-
image (Durchsuche Bilder der Medizinwelt)
1.2.3
Optionen
Parameter | Anmerkung |
q | Suchbegriff(e) |
start | Startwert für Paging (Default: NULL). Nicht anwendbar auf specific-action "wirkstoff". |
limit | Maximale Rückgabeanzahl. Nur anwendbar auf specific-action "image". |
worlds | Komma-separierte Liste der Welten-ID's, welche durchsucht werden sollen. Nur anwendbar auf specific-action "medizinwelt". |
books | Komma-separierte Liste der Buch-ID's, welche durchsucht werden sollen. Nur anwendbar auf specific-action "medizinwelt". |
content_length | Komma-separierte Liste von Werten "short","middle","long". Bestimmt die "Länge" der zurückgelieferten Inhalte. Nur anwendbar auf specific-action "medizinwelt". |
faculty | Nur für die {specific-action} medizinwelt und image: Gibt das Fachgebiet der Suche an |
audience | Nur für die {specific-action} medizinwelt und image: Gibt die Zielgruppe der Suche an |
1.3
User
1.3.1
Allgemeine Form
User URL
https://medizinwelt.elsevier-staging.de/api/user/{specific-action}?{specific-parameters}
1.3.2
Spezifische Aktionen
-
check - Prüft die Benutzerdaten ohne ein User-Session-Token zu erstellen
Parameter ({specific-parameters}):- email (string - benötigt)
- password (string - benötigt)
- success (boolean): true/false
-
login - Versucht den Benutzer mit den Login-Daten zu verfizieren
Parameter ({specific-parameters}):- email (string - benötigt)
- password (string - benötigt)
- persistent (boolean - optional): Definiert ob der Login dauerhaft (max. 30 Tage) bestehen soll
- success (boolean): true/false
- token (string): User-Session-Token für benutzerspezifische Anfragen
-
verify - Prüft einen User-Session-Token auf Gültigkeit
Parameter ({specific-parameters}):- token (string - benötigt): Der User-Session-Token
- success (boolean): true/false
-
info - Liefert informationen über den Benutzer
Parameter ({specific-parameters}):- token (string - benötigt): Der User-Session-Token
- Gibt alle benutzerspezifischen Daten (Vor- und Nachname, Straße etc.) zurück.
-
update - Aktualisiert die E-Mail Adresse der User-Session
Parameter ({specific-parameters}):- email (string - benötigt)
- password (string - benötigt)
- token (string - benötigt): Der User-Session-Token
- success (boolean): true/false
-
destroy - Entfernt die User-Session und invalidiert den User-Session-Token)
Parameter ({specific-parameters}):- token (string - benötigt): Der User-Session-Token
- success (boolean): true/false
1.4
Abfragen
1.4.1
Allgemeine Form
Abfragen URL
https://medizinwelt.elsevier-staging.de/api/get/{specific-action}?{specific-parameters}
1.4.2
Spezifische Aktionen
-
changelog - Liefert Informationen zu den Updates der Welten
Parameter ({specific-parameters}):- keine
Array mit allen Updates:- id (int): ID-Eintrag der Datenbank
- version (string): Versionsnummer des Updates
- timestamp (timestamp): Zeitstempel des Updates
- description (string): Beschreibung des Updates
- updated_worlds (string): Aktualisierte Welten-ID's (kommasepariert)
-
world - Liefert Informationen zu einer oder aller Welten
Parameter ({specific-parameters}):- world_id (string - erforderlich): Die ID der Welt
Array mit allen Welten passend zur Anfrage:- name (string): Name der Welt
- id (string): ID der Welt
-
global (object): Gruppiert alle Unter-Welten zu dieser Welt
-
rights (array|object): Array von Objekten wenn mehrere Unter-Welten existieren. Ansonsten ein einfaches Objekt.
- @attributes (object): Enthält alle Attribute des "rights" Objekts.
- right (array): Allen ISBNs die diese Welt freischalten.
-
rights (array|object): Array von Objekten wenn mehrere Unter-Welten existieren. Ansonsten ein einfaches Objekt.
-
book - Liefert Informationen zu Büchern
Parameter ({specific-parameters}):- world (string - optional): ID der Welt
- id (string - optional): ID des Buchs
- length (string - optional): Länge des Contents
Array mit allen Büchern passend zur Anfrage:-
@attributes (object): Attribute des Buches
- id (string): ID des Buches
- length (string): Länge des Contents
- belongs_to (string): ID der Unter-Welt (siehe @attibutes world)
- title (string): Titel des Buches
-
tags (object):
- tab (string): Der Tab in dem das Buch erscheinen soll
- category (string): Die Kategorie in dem das Buch erscheinen soll
- src (string): Die relative URL des Covers
- url (string): Die relative URL des Buches
-
rights (object):
- right (array|string): Alle ISBNs die dieses Buch freischalten.
-
database (object):
- table (string): Tabelle der Bücher
- id (integer): Datenbank-ID des Buches (wichtig für weitere Anfragen)
-
item - Liefert Buchkapitel und Zusatzinhalte des Buches
Parameter ({specific-parameters}):- book (integer - benötigt): Die Datenbank-ID des Buches (siehe book - database)
Array aus Objekten mit allen Items passend zur Anfrage:- id (integer): Datenbank-ID des Items
- book (integer): Datenbank-ID des Buches
- title (string): Titel des Inhalts
- link (string): Relative URL des Inhalts
- locked (boolean): Offen für alle?
- tab (string): Zu welchem Inhalts-Tab gehört der Inhalt
- type (string): "link" oder "label"
- prio (integer): Reihenfolge
-
item_version - Liefert Versions-Informationen zu einem Item
Parameter ({specific-parameters}):- item (integer - benötigt): Die Datenbank-ID des Items
Array aus Objekten mit allen Informationen passend zur Anfrage:- id (integer): Datenbank-ID der Version
- item (integer): Datenbank-ID des Items
- num (string): Versions-Nr.
- fullversion (boolean): Vollwertige Version?
- role (integer): Die Rollen-Nr.
- user (string): Benutzer der die Version angelegt hat
- file (string): Relativer Dateipfad zur Version
- created (date): Datum der Version.
-
content - Liefert den HTML-Inhalt eines Items
Parameter ({specific-parameters}):- item (integer - benötigt): Die Datenbank-ID des Items
Array aus Objekten mit allen Informationen passend zur Anfrage:- html (string): HTML-Code des Inhalts
- link (string): Absolute URL des Inhalts
-
watchlist - Liefert die Watchlist eines Users zurück
Parameter ({specific-parameters}):- user|token (string - benötigt): Entweder "user" mit einer validen E-Mail oder "token" mit einem validen User-Session-Token
Array aus Objekten mit allen Informationen passend zur Anfrage:- id (integer): Datenbank-ID der des Watchlist-Eintrags
- email (string): E-Mail des Benutzers
- item|item_id (integer): Datenbank-ID des beobachteten Items
- title (string): Titel des beobachteten Items
- link (string): Relative URL des beobachteten Items
- book (string): Titel des Buches welches das beobachtete Item enthält
- book_id (integer): Datenbank-ID des Buches
-
offlinelist - Liefert die Offlinelist eines Users zurück
Parameter ({specific-parameters}):- user|token (string - benötigt): Entweder "user" mit einer validen E-Mail oder "token" mit einem validen User-Session-Token
Array aus Objekten mit allen Informationen passend zur Anfrage:- id (integer): Datenbank-ID der des Offlinelist-Eintrags
- email (string): E-Mail des Benutzers
- item|item_id (integer): Datenbank-ID des offline-verfügbaren Items
- title (string): Titel des offline-verfügbaren Items
- link (string): Relative URL des offline-verfügbaren Items
- book (string): Titel des Buches welches das offline-verfügbare Item enthält
- book_id (integer): Datenbank-ID des Buches
-
checkout_info - Liefert Kauf-Informationen für die Welten zurück
Parameter ({specific-parameters}):- world (string - optional): Die ID der Welt
- sub_world (string - optional): Die ID der Unter-Welt
Array aus Objekten mit allen Informationen passend zur Anfrage:- checkout_isbn (string): Die "Haupt"-ISBN der Welt
-
Produkt-Typ ["book", "base", "upgrade", "extra"](object): Wenn vorhanden ein Objekt mit Informationen zum Produkt-Typ
- product_isbn (string): ISBN des Produkts
- price (string): Preis des Produkts
- title (string): Titel des Produkts
-
user_book - Liefert die user-spezifischen Bücher zurück
Parameter ({specific-parameters}):- user (string): Die E-Mail des Users
Array aus Objekten mit allen Informationen passend zur Anfrage:- id (integer): Datenbank-ID des Benutzer-Buches
- user (string): E-Mail des Benutzers
- title (string): Titel des Buches
- created (timestamp): Zeitstempel wann der Eintrag erstellt wurde
-
user_chapter - Liefert die user-spezifischen Kapitel zurück
Parameter ({specific-parameters}):- user (string): Die E-Mail des Users
- book (array): Komma separierte Liste mit Buch-IDs
Array aus Objekten mit allen Informationen passend zur Anfrage:- id (integer): Datenbank-ID des Benutzer-Kapitels
- user (string): E-Mail des Benutzers
- title (string): Titel des Kapitels
- book (integer): ID des Buches
- created (timestamp): Zeitstempel wann der Eintrag erstellt wurde
-
user_content - Liefert die user-spezifischen Inhalte zurück
Parameter ({specific-parameters}):- user (string): Die E-Mail des Users
- chapter (integer): Die ID des Kapitels
Liefert den User-Inhalt im HTML Format zurück.
-
team - Liefert das Team eines Nutzers zurück
Parameter ({specific-parameters}):- user (string): Die E-Mail des Users
Array aus Objekten mit allen Informationen passend zur Anfrage:- id (integer): Datenbank-ID des Teams
- name (string): Der Name des Teams
- user (array): Liste der User, die zum Team gehören
-
audiences - Liefert alle Zielgruppen zurück
Parameter ({specific-parameters}):
Rückgabe:
Array aus Objekten mit allen Informationen passend zur Anfrage:- id (integer): Datenbank-ID der Zielgruppe
- name (string): Der Name der Zielgruppe
- gruppe (string): Name der Gruppe der die Zielgruppe zugehört
-
faculties - Liefert alle Fachgebiete zurück
Parameter ({specific-parameters}):
Rückgabe:
Array aus Objekten mit allen Informationen passend zur Anfrage:- id (integer): Datenbank-ID des Fachgebiets
- name (string): Name des Fachgebiets
- gruppe (string): Name der Gruppe der das Fachgebiet zugehört
- prio (integer): Priorität des Fachgebiets
-
item_xml - Liefert den Inhalt eines Items
Parameter ({specific-parameters}):- user (string): Die E-Mail des Users
- chapter (integer): Die ID des Kapitels
- type (string): Der Typ des Items welches zurück gegeben werden soll ("user_content" oder "default")
Der Inhalt im XML Format.
-
item_html - Liefert den Inhalt eines Items
Parameter ({specific-parameters}):- user (string): Die E-Mail des Users
- chapter (integer): Die ID des Kapitels
- type (string): Der Typ des Items welches zurück gegeben werden soll ("user_content" oder "default")
Der Inhalt im HTML Format.
-
navi - Liefert den Inhalt der Navigation
Parameter ({specific-parameters}):
Rückgabe:
Der Inhalt im XML Format.
-
highlight_infos - Liefert Informationen zum Modalfenster, das beim Markieren von Text erscheint
Parameter ({specific-parameters}):- text (string): Der Text, für welchen Informationen zurückgeliefert werden sollen
Array mit allen Informationen:- lab (string): URL zum Laborwerte-Eintrag
- diff (string): URL zum Differentialdiagnostik-Eintrag
- roche (string): URL zum Roche-Lexikon (Suche)
- drug (string): URL zur Medikamentendatenbank (Suche)
- checkme (string): URL zum Checkme-Klinikstandards-Eintrag
- definition (string): Definition aus dem Roche-Lexikon
- wiki (string): URL zum Wikipedia-Eintrag
- num_results (int): Anzahl der zurückgelieferten Einträge, die angezeigt werden sollen
- images (search object): Bilder (aus der Medizinwelt Suche, Token notwendig für die Anzeige)
1.5
Setzen
1.5.1
Allgemeine Form
Setzen URL
https://medizinwelt.elsevier-staging.de/api/set/{specific-action}?{specific-parameters}
1.5.2
Spezifische Aktionen
-
watchlist - Setzt ein Item (z.B. Kapitel) auf die Watchlist eines Benutzers oder verändert den Status
Parameter ({specific-parameters}):- type (string - optional): Leer um zu löschen, "follow" um Benachrichtungen zu erhalten, "unfollow" um keine Benachrichtungen mehr zu erhalten, "add" um hinzuzufügen
- user|token (string - benötigt): Entweder "user" mit einer validen E-Mail oder "token" mit einem validen User-Session-Token
- item_id (integer - benötigt): Die Datenbank-ID des betreffenden Items
Array mit allen Welten passend zur Anfrage:- success (boolean): Wurde die Aktion erfolgreich ausgeführt?
-
offlinelist - Setzt oder Entfernt ein Item auf die Offlineliste
Parameter ({specific-parameters}):- user (string - benötigt): E-Mail des Users
- item_id (integer - benötigt): ID des Items welches gesetzt werden soll
- type (string - optional): Typ der Anfrage: "add" oder "default" (bzw. leer)
Array mit allen Welten passend zur Anfrage:- success (boolean): Wurde die Aktion erfolgreich ausgeführt?
-
user_content - Speichert einen userspezifischen Inhalt
Parameter ({specific-parameters}):- user (string - benötigt): E-Mail des Users
- chapter (string - benötigt): Name des Kapitels welches gespeichert werden soll
- html (string - benötigt): Inhalt des Kapitels in HTML
Array mit allen Welten passend zur Anfrage:- success (boolean): Wurde die Aktion erfolgreich ausgeführt?
-
user_chapter - Aktualisiert den Titel ein userspezifisches Kapitel
Parameter ({specific-parameters}):- user (string - benötigt): E-Mail des Users
- chapter (integer - benötigt): Id des Kapitels
- title (string - benötigt): Der neue Titel des Kapitels
Array mit allen Welten passend zur Anfrage:- success (boolean): Wurde die Aktion erfolgreich ausgeführt?
1.6
Erstellen
1.6.1
Allgemeine Form
Erstellen URL
https://medizinwelt.elsevier-staging.de/api/create/{specific-action}?{specific-parameters}
1.6.2
Spezifische Aktionen
-
user_book - Erstellt ein neues userspezifisches Buch
Parameter ({specific-parameters}):- user (string - benötigt): E-Mail des Users
- title (string - benötigt): Titel des Buches
Array mit allen Welten passend zur Anfrage:- status (string): "ok" oder "error"
- message (string): Enthält die Fehlermeldung wenn status auf "error" gesetzt ist
- user (string): Die E-Mail des Benutzers wenn die Aktion erfolgreich war
- book (integer): Die Datenbank-ID des erstellten Buches
-
user_chapter - Erstellt ein neues userspezifisches Kapitel
Parameter ({specific-parameters}):- user (string - benötigt): E-Mail des Users
- book (integer - benötigt): Datenbank-ID des Buches
- num (integer - benötigt): Die Kapitel-Nummer
- title (string - benötigt): Titel des Buches
Array mit allen Welten passend zur Anfrage:- status (string): "ok" oder "error"
- message (string): Enthält die Fehlermeldung wenn status auf "error" gesetzt ist
- title (string): Der Titel des Kapitels
- book (integer): Die Datenbank-ID des Buches
- chapter (integer): Die Datenbank-ID des erstellten Kapitels
- html (string): Der HTML-Inhalt des Kapitels
1.7
Entfernen
1.7.1
Allgemeine Form
Entfernen URL
https://medizinwelt.elsevier-staging.de/api/remove/{specific-action}?{specific-parameters}
1.7.2
Spezifische Aktionen
-
user_book - Löscht ein userspezifisches Buch und alle zugehörigen Kapitel
Parameter ({specific-parameters}):- user (string - benötigt): E-Mail des Users
- book (id - benötigt): Datenbank-ID des Buches
Array mit allen Welten passend zur Anfrage:- status (string): "ok" oder "error"
- message (string): Enthält die Fehlermeldung wenn status auf "error" gesetzt ist
-
user_chapter - Löscht ein userspezifisches Kapitel
Parameter ({specific-parameters}):- user (string - benötigt): E-Mail des Users
- chapter (id - benötigt): Datenbank-ID des Kapitels
Array mit allen Welten passend zur Anfrage:- status (string): "ok" oder "error"
- message (string): Enthält die Fehlermeldung wenn status auf "error" gesetzt ist