Commit abb80f8d authored by Lina Kuche's avatar Lina Kuche
Browse files

Update README.md

parent 48902961
......@@ -79,6 +79,8 @@ Bitte verwenden Sie für die Anfragen immer **UTF-8** als Zeichenkodierung.
Das Feld valid_until wird im Status "created" und "requested" automatisch auf den maximalmöglichen Wert gesetzt, falls das Feld leer übermittelt wird.
Das Feld first_issue_date kann gesetzt werden, falls es sich um Bestandsdaten handelt.
Ansonsten wird hierfür der selbe Wert wie für issue_date verwendet.
Die Felder training_activity_1 und training_activity_2, falls sie angegeben sind, überschreiben z.B. beim Aktualisieren die Fortbildungsmaßnahmen.
Es werden keine Haken "Berechtigt zur Verlängerung", wie bspw. bei der Weboberfläche, berücksichtigt.
**Invalid:**
......@@ -232,6 +234,61 @@ neue Gültigkeit laut Vorschlag: 07.02.2027.
**Notes:**
Ein Beispiel dazu befindet sich hier: https://gitlab.ghostthinker.de/pub/lims_connect/blob/master/php_sample_client/sample_download_license.php
### Abruf von Lizenzen
----
Abruf von Lizenzen anhand der optionalen Parameter.
**URL**
/lookup
**Method:**
`POST`
**URL Params**
keine
**Data Params für Lizenzen-Abruf**
**Required:**
keine
**Optional:** `organisation_id` , `offset` , `limit` , `validation_status` , `is_obscured` , `ids_only`
`offset` = Startwert der Abfrage
`limit` = Anzahl der DOSB-Lizenzen für die Abfrage (max. 1000), bei DOSB-Lizenznummern (Lizenz-IDs) max. 20000
`validation_status => 0` = Abgelaufene Lizenzen <br />
`validation_status => 1` = Gültige Lizenzen
Mögliche Werte für `is_obscured` => <br />
`ja, Ja, j, 1, TRUE, true` = liefert nur anonymisierte DOSB-Lizenzen zurück <br />
`nein, Nein, n, 0, FALSE, false` = liefert nur vollständige DOSB-Lizenzen zurück <br />
`ids_only => TRUE` = liefert eine Liste von DOSB-Lizenznummern (Lizenz-IDs)
**Success Response:**
Bei Erfolg wird die Anzahl der enthaltenen Ergebnisse (size), der übermittelte Offset-Wert (offset), die Größe des Abfrage-Ergebnisses (total)
und die Lizenzen oder nur die Lizenz-IDs zurückgegeben.
Die Felder bzw Bezeichnung sind die selben wie beim Anfordern einer Lizenz.
**Code:** 200 <br />
**Content-Type:** application/json <br />
**Content:** size, offset, total mit Lizenz-IDs oder Lizenzen <br />
**Error Response:**
**Code:** 401 UNAUTHORIZED <br />
**Content:** `[ Invalid login credentials ]`
**Code:** 403 ACCESS DENIED <br />
**Content:** `["Access denied for user %username ]`
### Lizenz laden mit DOSB Lizenznummer ###
----
......@@ -305,6 +362,8 @@ Bitte beachten Sie, dass die Felder vom Typ "Date" als Unixzeit, also dem POSIX-
| custom_1* | Zusatzfeld 1 | string | 0,1024 |
| custom_2* | Zusatzfeld 2 | string | 0,1024 |
| additional_info * | Ergänzungseintrag (wird auf der Lizenz ausgegeben) | string | 0,1024 |
| training_activity_1* | Fortbildungsmaßnahme 1 | string | 1,127 |
| training_activity_2* | Fortbildungsmaßnahme 2 | string | 1,127 |
\* Felder mit sind optional.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment