Commit 8d1d739f authored by man14's avatar man14

Release 1.1.0 Dokumentation und Changelog

parent 5fa1ff2c
# Change Log
Alle relevanten Änderungen an der Schnittstelle werden in dieser Datei dokumentiert.
## [1.1.0] - 2016-09-26
### Added
- Lizenz laden mit DOSB Lizenznummer (/load) aufruf hinzugefügt
### Fixed
- korrekter header in der PDF Rückgabe im sample client
## [1.0.1] - 2016-06-15
### Fixed
......
......@@ -7,6 +7,7 @@ Die LiMS Schnittstelle des DOSB Bildungsnetz ermöglicht Ihnen unter anderem Liz
* neue Lizenzen anfordern,
* vorhandene Lizenzen verlängern und korrigieren,
* vorhandene Lizenz aus LiMs laden
* PDF Lizenzvordrucke laden
Alle Anfragen müssen im produktiv Betrieb an die URL *https://bildungsnetz.dosb.de/api/lims* gestellt werden. Bitte beachten Sie, dass es sich hier um produktive Daten handelt. Darum testen sie Ihre Implementierung am besten zunächst auf unserer Testumgebung. Diese kann analog zum Live-System über die URL *https://bildungsnetz.ghostthinker.de/api/lims* adressiert werden.
......@@ -171,6 +172,39 @@ Bitte verwenden Sie für die Anfragen immer **UTF-8** als Zeichenkodierung.
**Notes:**
Ein Beispiel dazu befindet sich hier: https://gitlab.ghostthinker.de/gt/lims_connect/blob/master/php_sample_client/sample_download_license.php
### Lizenz laden mit DOSB Lizenznummer ###
----
Aufruf zu Laden aller Felder einer Lizenz anhand der DOSB Lizenznummer.
**URL**
/load
**Method:**
`POST`
**URL Params**
`license_number_dosb`
**Success Response:**
Bei Erfolg werden die Felder der Lizenz zurückgegeben. Die Felder bzw Bezeichnung sind die selben wie beim anfordern.
**Code:** 200 <br />
**Content-Type:** application/pdf <br />
**Content:** Inhalt der pdf
**Error Response:**
**Code:** 401 UNAUTHORIZED <br />
**Content:** `[ Invalid login credentials ]`
**Code:** 403 ACCESS DENIED <br />
**Content:** `["Access denied for user %username ]`
## Sequenzdiagramm
......
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