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
| Parameter | Type | Standard | Beschreibung |
|---|---|---|---|
| appl | text | lukida | Name der Applikation. |
| tokens.api | text | – | API-Token zur Autorisierung |
| tokens.user | text | – | Benutzer-Token aus der Anmeldung |
| login | text | – | Benutzerkennung |
| type | text | request | Art der Aktion |
| id | text | – | ID des Exemplars |
Payload Optional
| Parameter | Type | Standard | Beschreibung |
|---|---|---|---|
| requesttype | text | – | Unterscheidung Bestellung / Vormerkung, sofern das Bibliothekssystem beides kennt |
| desk | text | – | Abholort, wenn die Bibliothek mehrere anbietet |
Antwort
| Parameter | Type | Beschreibung |
|---|---|---|
| status | number | 1 erfolgreich, -1 nicht erfolgreich |
| code | text | Meldungscode, 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
| Parameter | Type | Standard | Beschreibung |
|---|---|---|---|
| appl | text | lukida | Name der Applikation. |
| tokens.api | text | – | API-Token zur Autorisierung |
| tokens.user | text | – | Benutzer-Token aus der Anmeldung |
| login | text | – | Benutzerkennung |
| type | text | renew | Art der Aktion |
| id | text | – | ID der Ausleihe. Mehrere durch Komma getrennt. |
Payload Optional
Keine.
Antwort
| Parameter | Type | Beschreibung |
|---|---|---|
| status | number | 1 erfolgreich, -1 nicht erfolgreich |
| code | text | Meldungscode, 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
| Parameter | Type | Standard | Beschreibung |
|---|---|---|---|
| appl | text | lukida | Name der Applikation. |
| tokens.api | text | – | API-Token zur Autorisierung |
| tokens.user | text | – | Benutzer-Token aus der Anmeldung |
| login | text | – | Benutzerkennung |
| type | text | cancel | Art der Aktion |
| id | text | – | ID der Bestellung |
Payload Optional
Keine.
Antwort
| Parameter | Type | Beschreibung |
|---|---|---|
| status | number | 1 erfolgreich, -1 nicht erfolgreich |
| code | text | Meldungscode, 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
| Parameter | Type | Standard | Beschreibung |
|---|---|---|---|
| appl | text | lukida | Name der Applikation. |
| tokens.api | text | – | API-Token zur Autorisierung |
| tokens.user | text | – | Benutzer-Token aus der Anmeldung |
| login | text | – | Benutzerkennung |
| type | text | changepw | Art der Aktion |
| oldpw | text | – | Bisheriges Passwort |
| newpw | text | – | Neues Passwort |
Payload Optional
Keine.
Antwort
| Parameter | Type | Beschreibung |
|---|---|---|
| status | number | 1 erfolgreich, -1 nicht erfolgreich |
| code | text | Meldungscode, 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
| Parameter | Type | Standard | Beschreibung |
|---|---|---|---|
| appl | text | lukida | Name der Applikation. |
| tokens.api | text | – | API-Token zur Autorisierung |
| tokens.user | text | – | Benutzer-Token aus der Anmeldung |
| login | text | – | Benutzerkennung |
| type | text | changemail | Art der Aktion |
| newmail | text | – | Neue Mailadresse |
Payload Optional
Keine.
Antwort
| Parameter | Type | Beschreibung |
|---|---|---|
| status | number | 1 erfolgreich, -1 nicht erfolgreich |
| code | text | Meldungscode, 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
| Parameter | Type | Standard | Beschreibung |
|---|---|---|---|
| appl | text | lukida | Name der Applikation. |
| tokens.api | text | – | API-Token zur Autorisierung |
| tokens.user | text | – | Benutzer-Token aus der Anmeldung |
| login | text | – | Benutzerkennung |
| type | text | resetpw | Art der Aktion |
Payload Optional
Keine.
Antwort
| Parameter | Type | Beschreibung |
|---|---|---|
| status | number | 1 erfolgreich, -1 nicht erfolgreich |
| code | text | Meldungscode, z. B. paramsmissing |
Beispiel
{
"tokens": { "api": "<API-Token>" },
"appl": "lukida",
"type": "resetpw",
"login": "<Benutzerkennung>"
}