Zum Inhalt springen

Lukida API 5 · Benutzermodul

Lukida API 5 · Benutzermodul

Aktionen

Ein Einstieg, sechs Vorgänge: was geschieht, entscheidet das Feld type.

request

POST /5/user/action mit "type": "request"

Beschreibung

Bestellt oder merkt ein Exemplar vor.

Payload Fix

ParameterTypeStandardBeschreibung
appltextlukidaName der Applikation.
tokens.apitext–API-Token zur Autorisierung
tokens.usertext–Benutzer-Token aus der Anmeldung
logintext–Benutzerkennung
typetextrequestArt der Aktion
idtext–ID des Exemplars

Payload Optional

ParameterTypeStandardBeschreibung
requesttypetext–Unterscheidung Bestellung / Vormerkung, sofern das Bibliothekssystem beides kennt
desktext–Abholort, wenn die Bibliothek mehrere anbietet

Antwort

ParameterTypeBeschreibung
statusnumber1 erfolgreich, -1 nicht erfolgreich
codetextMeldungscode, z. B. paramsmissing

Beispiel

{
    "tokens": { "api": "<API-Token>", "user": "<Benutzer-Token>" },
    "appl": "lukida",
    "type": "request",
    "login": "<Benutzerkennung>",
    "id": "<Exemplar-ID>"
}

Antwort

{
    "status": 1,
    "code": "requestsuccessful"
}

renew

POST /5/user/action mit "type": "renew"

Beschreibung

Verlängert eine Ausleihe.

Payload Fix

ParameterTypeStandardBeschreibung
appltextlukidaName der Applikation.
tokens.apitext–API-Token zur Autorisierung
tokens.usertext–Benutzer-Token aus der Anmeldung
logintext–Benutzerkennung
typetextrenewArt der Aktion
idtext–ID der Ausleihe. Mehrere durch Komma getrennt.

Payload Optional

Keine.

Antwort

ParameterTypeBeschreibung
statusnumber1 erfolgreich, -1 nicht erfolgreich
codetextMeldungscode, z. B. paramsmissing

Beispiel

{
    "tokens": { "api": "<API-Token>", "user": "<Benutzer-Token>" },
    "appl": "lukida",
    "type": "renew",
    "login": "<Benutzerkennung>",
    "id": "<Ausleih-ID>"
}

cancel

POST /5/user/action mit "type": "cancel"

Beschreibung

Storniert eine Bestellung oder Vormerkung.

Payload Fix

ParameterTypeStandardBeschreibung
appltextlukidaName der Applikation.
tokens.apitext–API-Token zur Autorisierung
tokens.usertext–Benutzer-Token aus der Anmeldung
logintext–Benutzerkennung
typetextcancelArt der Aktion
idtext–ID der Bestellung

Payload Optional

Keine.

Antwort

ParameterTypeBeschreibung
statusnumber1 erfolgreich, -1 nicht erfolgreich
codetextMeldungscode, z. B. paramsmissing

Beispiel

{
    "tokens": { "api": "<API-Token>", "user": "<Benutzer-Token>" },
    "appl": "lukida",
    "type": "cancel",
    "login": "<Benutzerkennung>",
    "id": "<Bestell-ID>"
}

changepw

POST /5/user/action mit "type": "changepw"

Beschreibung

Ändert das Passwort des Bibliothekskontos.

Payload Fix

ParameterTypeStandardBeschreibung
appltextlukidaName der Applikation.
tokens.apitext–API-Token zur Autorisierung
tokens.usertext–Benutzer-Token aus der Anmeldung
logintext–Benutzerkennung
typetextchangepwArt der Aktion
oldpwtext–Bisheriges Passwort
newpwtext–Neues Passwort

Payload Optional

Keine.

Antwort

ParameterTypeBeschreibung
statusnumber1 erfolgreich, -1 nicht erfolgreich
codetextMeldungscode, z. B. paramsmissing

Beispiel

{
    "tokens": { "api": "<API-Token>", "user": "<Benutzer-Token>" },
    "appl": "lukida",
    "type": "changepw",
    "login": "<Benutzerkennung>",
    "oldpw": "<altes Passwort>",
    "newpw": "<neues Passwort>"
}

Hinweis: Nach einer Passwortänderung wird der Benutzer-Token ungültig. Die Anmeldung muss mit dem neuen Passwort wiederholt werden.

changemail

POST /5/user/action mit "type": "changemail"

Beschreibung

Ändert die im Bibliothekskonto hinterlegte Mailadresse.

Payload Fix

ParameterTypeStandardBeschreibung
appltextlukidaName der Applikation.
tokens.apitext–API-Token zur Autorisierung
tokens.usertext–Benutzer-Token aus der Anmeldung
logintext–Benutzerkennung
typetextchangemailArt der Aktion
newmailtext–Neue Mailadresse

Payload Optional

Keine.

Antwort

ParameterTypeBeschreibung
statusnumber1 erfolgreich, -1 nicht erfolgreich
codetextMeldungscode, z. B. paramsmissing

Beispiel

{
    "tokens": { "api": "<API-Token>", "user": "<Benutzer-Token>" },
    "appl": "lukida",
    "type": "changemail",
    "login": "<Benutzerkennung>",
    "newmail": "neue@adresse.de"
}

resetpw

POST /5/user/action mit "type": "resetpw"

Beschreibung

Stößt das Zurücksetzen des Passworts an. Die Bibliothek verschickt daraufhin eine Mail mit weiteren Anweisungen.

Payload Fix

ParameterTypeStandardBeschreibung
appltextlukidaName der Applikation.
tokens.apitext–API-Token zur Autorisierung
tokens.usertext–Benutzer-Token aus der Anmeldung
logintext–Benutzerkennung
typetextresetpwArt der Aktion

Payload Optional

Keine.

Antwort

ParameterTypeBeschreibung
statusnumber1 erfolgreich, -1 nicht erfolgreich
codetextMeldungscode, z. B. paramsmissing

Beispiel

{
    "tokens": { "api": "<API-Token>" },
    "appl": "lukida",
    "type": "resetpw",
    "login": "<Benutzerkennung>"
}