Digibib API (concept versie)
Overview
API voor het aanbieden van producten en het wijzigen van deze producten. Deze producten kunnen via een LTI-koppeling door leerlingen en docenten worden benaderd. Onder producten worden
Version information
Version : v0_1
Contact information
Contact : Stipp
Contact Email : servicedesk@stipp.nl
URI scheme
Host : api-digibib.consortiumbo.nl
Schemes : HTTPS
Paths
Lees producten
GET /api/product/alleproductenDescription
Geeft informatie van alle producten van de content-leverancier die eerder zijn toegevoegd aan de Digibib.
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | De producten | < Product > array |
| 404 | NotFound | No Content |
Produces
application/json
Tags
- Producten
Lees product
GET /api/product/lees/{productcode}Description
Informatie van een product dat eerder is toegevoegd aan de Digibib.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | productcode required |
De code van het product | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Het product | Product |
| 404 | NotFound | No Content |
Produces
application/json
Tags
- Producten
Voeg een product toe
POST /api/product/nieuw/{productcode}Description
Voegt een nieuw product toe aan de Digibib.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | productcode required |
De code van het product | string |
| Body | product required |
Nieuwe velden | Product |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Het product | Gewijzigd |
| 404 | NotFound | No Content |
Consumes
application/json
Produces
application/json
Tags
- Producten
Lees producten
GET /api/product/productenvangebruiker/{gebruikerid}Description
Geeft informatie van alle producten waarop de gebruiker een abonnement heeft. De producten worden gefilterd op de content-leverancier.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | gebruikerid required |
Het ID van de gebruiker zoals dit is meegekomen met de LTI-launch | string |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | De producten | < Product > array |
| 404 | NotFound | No Content |
Produces
application/json
Tags
- Producten
Wijzigt de informatie van een product
PUT /api/product/wijzig/{productcode}Description
De informatie van een product dat eerder is toegevoegd aan de Digibib kan hiermee worden gewijzigd.
Parameters
| Type | Name | Description | Schema |
|---|---|---|---|
| Path | productcode required |
De code van het product | string |
| Body | product required |
Te wijzigen velden | Product |
Responses
| HTTP Code | Description | Schema |
|---|---|---|
| 200 | Het product | Gewijzigd |
| 404 | NotFound | No Content |
Consumes
application/json
Produces
application/json
Tags
- Producten
Definitions
Gewijzigd
Gewijzigde data
| Name | Description | Schema |
|---|---|---|
| Boodschap optional read-only |
De boodschap. "OK" als alles goed is gegaan | string |
| ID optional read-only |
De code van het product | string |
Product
Product informatie
| Name | Description | Schema |
|---|---|---|
| Beschrijving optional |
De beschrijving van het product zoals het in de catalogus van de Digibib opgenomen zal worden. | string |
| Code optional read-only |
De code van het product | string |
| Meerinfo optional |
De url naar de pagina waar meer informatie over dit product is opgenomen. Deze link wordt opgenomen in de catalogus van de Digibib. | string |
| Naam optional |
De naam van het product | string |
| Url optional |
Url naar het product. Dit is de pagina waar de leerling of docent wordt doorverwezen. Dit is de URL waarnaar een LTI-Launch Request wordt gedaan. | string |
Security
apiKey
Type : apiKey
Name : apikey
In : HEADER