{"id":488,"date":"2024-12-11T11:24:09","date_gmt":"2024-12-11T11:24:09","guid":{"rendered":"https:\/\/linqur.com\/docs\/?post_type=ht_kb&p=488"},"modified":"2024-12-11T11:24:13","modified_gmt":"2024-12-11T11:24:13","slug":"api-eindpunt-documentatie","status":"publish","type":"ht_kb","link":"https:\/\/linqur.com\/docs\/nl\/documentatie\/api-eindpunt-documentatie\/","title":{"rendered":"API eindpunt documentatie"},"content":{"rendered":"\n
\n

Een uitgebreide beschrijving van alle eindpunten.<\/p>\n<\/blockquote>\n\n

Methode<\/strong><\/td>HTTP-verzoek<\/strong><\/td>Beschrijving<\/strong><\/td><\/tr>
cursusAdd()<\/td>GET<\/strong> \/cursus\/toevoegen<\/td>Een nieuwe cursus maken<\/td><\/tr>
cursusverwijderen()<\/td>GET<\/strong> \/cursus\/verwijderen<\/td>Een bestaande cursus verwijderen aan de hand van zijn ID<\/td><\/tr>
cursusleerobjectverwijderen()<\/td>GET<\/strong> \/cursus\/leerobject\/verwijderen<\/td>Een specifiek leerobject verwijderen<\/td><\/tr>
CourseLearningObjectScormAdd()<\/td>POST<\/strong> \/cursus\/leerobject\/scrom\/toevoegen<\/td>Een SCORM-pakket aan een cursus toevoegen<\/td><\/tr>
cursusLeerObjectLijst()<\/td>GET<\/strong> \/cursus\/leerobject\/lijst<\/td>Leerobjecten voor een cursus ophalen<\/td><\/tr>
cursusleerdoelScormUpdate()<\/td>POST<\/strong> \/cursus\/leerobject\/scrom\/update<\/td>SCORM-leerobject bijwerken<\/td><\/tr>
cursuslijst()<\/td>GET<\/strong> \/cursus\/lijst<\/td>Alle cursussen ophalen<\/td><\/tr>
cursusLtiRegistratiesDag()<\/td>GET<\/strong> \/cursus\/lti\/inschrijvingen_per_dag<\/td>Ontvang LTI-registraties per dag<\/td><\/tr>
cursusLtiRegistratiesSomBijCursus()<\/td>GET<\/strong> \/cursus\/lti\/registraties_som_per_cursus<\/td>Totaal aantal LTI-registraties per cursus<\/td><\/tr>
cursusToolAdd()<\/td>GET<\/strong> \/cursus\/tool\/toevoegen<\/td>Nieuw hulpmiddel aan een cursus toevoegen<\/td><\/tr>
cursusToolVerwijderen()<\/td>GET<\/strong> \/cursus\/tool\/verwijderen<\/td>Een specifieke cursus verwijderen<\/td><\/tr>
cursusToolList()<\/td>GET<\/strong> \/cursus\/tool\/lijst<\/td>Alle LTI-tools in een cursus weergeven<\/td><\/tr>
cursusToolUpdate()<\/td>GET<\/strong> \/cursus\/tool\/bijwerken<\/td>Een specifieke cursus bijwerken<\/td><\/tr>
cursusupdate()<\/td>GET<\/strong> \/cursus\/update<\/td>Een bestaande cursus bijwerken<\/td><\/tr>
tokenAdd()<\/td>GET<\/strong> \/token\/toevoegen<\/td>Een nieuw API token toevoegen<\/td><\/tr>
tokenVerwijderen()<\/td>GET<\/strong> \/token\/verwijderen<\/td>Een API token verwijderen<\/td><\/tr>
tokenLijst()<\/td>GET<\/strong> \/token\/lijst<\/td>Lijst van API tokens opvragen<\/td><\/tr>
gebruiker verwijderen()<\/td>GET<\/strong> \/gebruiker\/verwijderen<\/td>Een gebruiker verwijderen op ID<\/td><\/tr>
userDeleteBulk()<\/td>GET<\/strong> \/gebruiker\/verwijderen_bulk<\/td>Meerdere gebruikers verwijderen op ID<\/td><\/tr>
gebruikerslijst()<\/td>GET<\/strong> \/gebruiker\/lijst<\/td>Lijst van gebruikers in een tool opvragen<\/td><\/tr><\/tbody><\/table><\/figure>\n\n

cursusAdd()<\/h2>\n\n
courseAdd($coursename, $coursenameshort): \\LtiSaasApi\\Model\\CourseAdd200Response<\/code><\/pre>\n\n
Een nieuwe cursus maken<\/strong><\/p>\n\n
Met dit eindpunt kun je een nieuwe cursus aanmaken. De cursusnaam moet worden doorgegeven als een query parameter. <\/p>\n\n
Voorbeeld<\/strong><\/p>\n\n
<?php<\/strong>\nrequire_once(__DIR__ . '\/vendor\/autoload.php');\n\n\n\/\/ Configure API key authorization: token\n$config = LtiSaasApi\\Configuration::getDefaultConfiguration()->setApiKey('Access-Token', 'YOUR_API_KEY');\n\/\/ Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n\/\/ $config = LtiSaasApi\\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Access-Token', 'Bearer');\n\n\n$apiInstance = new LtiSaasApi\\Api\\DefaultApi(\n    \/\/ If you want use custom http client, pass your client which implements `GuzzleHttp\\ClientInterface`.\n    \/\/ This is optional, `GuzzleHttp\\Client` will be used as default.\n    new GuzzleHttp\\Client(),\n    $config\n);\n$coursename = 'coursename_example'; \/\/ string | The name of the course to be created\n$coursenameshort = 'coursenameshort_example'; \/\/ string | The shortname of the course to be created\n\ntry {\n    $result = $apiInstance->courseAdd($coursename, $coursenameshort);\n    print_r($result);\n} catch (Exception $e) {\n    echo 'Exception when calling DefaultApi->courseAdd: ', $e->getMessage(), PHP_EOL;\n}<\/code><\/pre>\n\n
Parameters<\/strong><\/a><\/p>\n\n
Naam<\/th>Type<\/th>Beschrijving<\/th>Opmerkingen<\/th><\/tr><\/thead>
cursusnaam<\/strong><\/td>string<\/strong><\/td>De naam van de cursus die moet worden aangemaakt<\/td><\/td><\/tr>
cursusnaam<\/strong><\/td>string<\/strong><\/td>De korte naam van de cursus die moet worden aangemaakt<\/td>[optional]<\/td><\/tr><\/tbody><\/table><\/figure>\n\n
Type terugkeer<\/strong><\/a><\/p>\n\n
\\LtiSaasApi \\CursusToevoeging200Respons<\/p>\n\n
Machtiging: token<\/a><\/p>\n\n
HTTP verzoek-headers<\/a><\/h3>\n\n