{"swagger":"2.0","info":{"version":"v0_1","title":"Digibib API (versie 0.1)","description":"API voor het aansluiten van derde partijen op de Digibib.","contact":{"name":"Consortium Beroepsonderwijs","url":"http://www.consortiumbo.nl","email":"info@consortiumbo.nl"}},"host":"digibib-api.consortiumbo.nl","schemes":["https"],"paths":{"/api/product/alleproducten":{"get":{"tags":["Product"],"summary":"Lees producten","description":"Geeft informatie van alle producten van de content-leverancier die eerder zijn toegevoegd aan de Digibib.","operationId":"AlleProducten","consumes":[],"produces":["application/json"],"responses":{"200":{"description":"Geeft informatie van alle producten van de content-leverancier die eerder zijn toegevoegd aan de Digibib","schema":{"type":"array","items":{"$ref":"#/definitions/Product"}}},"404":{"description":"NotFound"}}}},"/api/product/lees/{productcode}":{"get":{"tags":["Product"],"summary":"De informatie van een product dat eerder is toegevoegd aan de Digibib kan hiermee worden opgevraagd.","operationId":"LeesProduct","consumes":[],"produces":["application/json"],"parameters":[{"name":"productcode","in":"path","description":"De code van het product","required":true,"type":"string"}],"responses":{"200":{"description":"De informatie van een product dat eerder is toegevoegd aan de Digibib kan hiermee worden opgevraagd.","schema":{"$ref":"#/definitions/Product"}},"404":{"description":"NotFound"}}}},"/api/product/productenvangebruiker/{gebruikerid}":{"get":{"tags":["Product"],"summary":"Geeft informatie van alle producten waarop de gebruiker een abonnement heeft. De producten worden gefilterd op de content-leverancier.","operationId":"ProductenVanGebruiker","consumes":[],"produces":["application/json"],"parameters":[{"name":"gebruikerid","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"Geeft informatie van alle producten waarop de gebruiker een abonnement heeft. De producten worden gefilterd op de content-leverancier.","schema":{"type":"array","items":{"$ref":"#/definitions/Product"}}},"404":{"description":"NotFound"}}}},"/api/product/wijzig/{productcode}":{"put":{"tags":["Product"],"summary":"De informatie van een product dat eerder is toegevoegd aan de Digibib kan hiermee worden gewijzigd.","operationId":"WijzigProduct","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"productcode","in":"path","description":"De code van het product","required":true,"type":"string"},{"name":"product","in":"body","description":"De gegevens van het product","required":true,"schema":{"$ref":"#/definitions/Product"}}],"responses":{"200":{"description":"De informatie van een product dat eerder is toegevoegd aan de Digibib kan hiermee worden gewijzigd.","schema":{"$ref":"#/definitions/Product"}},"404":{"description":"NotFound"}}}},"/api/product/nieuw/{productcode}":{"post":{"tags":["Product"],"summary":"Voegt een nieuw product toe aan de Digibib.","operationId":"NieuwProduct","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"productcode","in":"path","description":"De code van het product","required":true,"type":"string"},{"name":"product","in":"body","description":"De gegevens van het product","required":true,"schema":{"$ref":"#/definitions/Product"}}],"responses":{"200":{"description":"Voegt een nieuw product toe aan de Digibib.","schema":{"$ref":"#/definitions/Product"}},"404":{"description":"NotFound"}}}}},"definitions":{"Product":{"required":["Code","Naam","Url"],"type":"object","properties":{"Beschrijving":{"description":"De beschrijving van het product zoals het in de catalogus van de Digibib opgenomen zal worden.","type":"string"},"Code":{"description":"De code van het product","type":"string"},"MeerInfo":{"description":"De url naar de pagina waar meer informatie over dit product is opgenomen. Deze link wordt opgenomen in de catalogus van de Digibib.","type":"string"},"Naam":{"description":"De naam van het product","type":"string"},"Url":{"description":"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.","type":"string"},"CrebonummerWerkprocesCombinatie":{"description":"Unieke combinaties van crebonummer van het kwalificatiedossier met de code van het werkproces. Deze combinatie wordt gebruik om dit product te koppelen aan een uitgave in de Digibib.\r\nDe combinatie is samengesteld met {crebonummer van kwalificatiedossier}-{werkprocescode}. \r\n\r\nDeze gegvens komen uit het Kwaliicatiedossier. De kwalificatiedossiers zijn te vinden op https://kwalificaties.s-bb.nl/\r\n\r\nAls bijvoorbeeld van het kwalificatiedossier 'Middenkader bouw en infra' de werkprocessen van 'Verzamelt, registreert en beheert projectinformatie' en 'Integreert projectinformatie'\r\nrelevant zijn, kan hier de waarden '23053-B1-K1-W1' en '23053-B1-K1-W2' worden meegegeven.","type":"array","items":{"type":"string"}}}}},"securityDefinitions":{"apiKey":{"type":"apiKey","description":"API Key Authenticatie","name":"apikey","in":"header"}}}