API eindpunt documentatie

Een uitgebreide beschrijving van alle eindpunten.

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

cursusAdd()

courseAdd($coursename, $coursenameshort): \LtiSaasApi\Model\CourseAdd200Response

Een nieuwe cursus maken

Met dit eindpunt kun je een nieuwe cursus aanmaken. De cursusnaam moet worden doorgegeven als een query parameter.

Voorbeeld

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKey('Access-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Access-Token', 'Bearer');


$apiInstance = new LtiSaasApi\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$coursename = 'coursename_example'; // string | The name of the course to be created
$coursenameshort = 'coursenameshort_example'; // string | The shortname of the course to be created

try {
    $result = $apiInstance->courseAdd($coursename, $coursenameshort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->courseAdd: ', $e->getMessage(), PHP_EOL;
}

Parameters

Naam	Type	Beschrijving	Opmerkingen
cursusnaam	string	De naam van de cursus die moet worden aangemaakt
cursusnaam	string	De korte naam van de cursus die moet worden aangemaakt	[optional]

Type terugkeer

\LtiSaasApi \CursusToevoeging200Respons

Machtiging: token

HTTP verzoek-headers

Inhoudstype: Niet gedefinieerd
Accepteren: toepassing/json

cursusverwijderen()

courseDelete($courseid): \LtiSaasApi\Model\CourseDelete200Response

Een bestaande cursus verwijderen aan de hand van zijn ID

Met dit eindpunt kun je een bestaande cursus verwijderen door de unieke identifier (cursus-ID) op te geven.

Voorbeeld

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKey('Access-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Access-Token', 'Bearer');


$apiInstance = new LtiSaasApi\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$courseid = 56; // int | The unique identifier of the course to be deleted

try {
    $result = $apiInstance->courseDelete($courseid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->courseDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Naam	Type	Beschrijving	Opmerkingen
cursusid	int	De unieke identifier van de te verwijderen cursus

Type terugkeer

\LtiSaasApi_cursusverwijderen200antwoord

Machtiging: token

HTTP verzoek-headers

Inhoudstype: Niet gedefinieerd
Accepteren: toepassing/json

cursusleerobjectverwijderen()

courseLearningObjectDelete($learningobjectid): \LtiSaasApi\Model\CourseUpdate200Response

Een specifiek leerobject verwijderen

Dit eindpunt verwijdert een specifiek leerobject gebaseerd op de gegeven identifier. * Het retourneert een succesrespons bij succesvol verwijderen en relevante foutresponses bij ongeldige verzoeken of ongeautoriseerde * toegang.

Voorbeeld

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKey('Access-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Access-Token', 'Bearer');


$apiInstance = new LtiSaasApi\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$learningobjectid = 56; // int | The identifier of the learning object

try {
    $result = $apiInstance->courseLearningObjectDelete($learningobjectid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->courseLearningObjectDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Naam	Type	Beschrijving	Opmerkingen
leerdoelid	int	De identifier van het leerobject

Type terugkeer

\LtiSaasApi \Cursusupdate200Response

Machtiging: token

HTTP verzoek-headers

Inhoudstype: Niet gedefinieerd
Accepteren: toepassing/json

CourseLearningObjectScormAdd()

courseLearningObjectScromAdd($courseid, $packagefile, $name, $popup, $width, $height, $grademethod, $maxgrade, $maxattempt, $whatgrade, $forcenewattempt, $lastattemptlock, $autocommit, $masteryoverride): \LtiSaasApi\Model\CourseLearningObjectScromAdd200Response

Een SCORM-pakket aan een cursus toevoegen

Met dit eindpunt kun je een SCORM-pakket als leerobject toevoegen aan een gespecificeerde cursus.

Voorbeeld

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKey('Access-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Access-Token', 'Bearer');


$apiInstance = new LtiSaasApi\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$courseid = 56; // int | The unique identifier of the course
$packagefile = "/path/to/file.txt"; // \SplFileObject | The .zip file of the SCORM package
$name = 'name_example'; // string | The name of the SCORM package
$popup = 56; // int | Indicates if the SCORM package should open in a new window (1) or not (0)
$width = 56; // int | The display width for the SCORM package
$height = 56; // int | The display height for the SCORM package
$grademethod = 56; // int | The grading method for the SCORM package (0: learning objects, 1: highest grade, 2: average      *                     grade, 3: sum grade)
$maxgrade = 56; // int | The maximum grade possible for the SCORM package
$maxattempt = 56; // int | The maximum number of attempts allowed for the SCORM package
$whatgrade = 56; // int | The grading strategy for multiple attempts (0: highest attempt, 1: average grade, 2: first      *                     attempt)
$forcenewattempt = 56; // int | Policy for forcing new attempts (0: no, 1: every new attempt is a new grade, 2: every new      *                     attempt resets previous grades)
$lastattemptlock = 56; // int | Indicates if the SCORM package should be locked after the last attempt (0: no, 1: yes)
$autocommit = 56; // int | Indicates if the SCORM package grades should auto commit (0: no, 1: yes)
$masteryoverride = 56; // int | Indicates if the mastery grade overrides the max grade (0: no, 1: yes)

try {
    $result = $apiInstance->courseLearningObjectScromAdd($courseid, $packagefile, $name, $popup, $width, $height, $grademethod, $maxgrade, $maxattempt, $whatgrade, $forcenewattempt, $lastattemptlock, $autocommit, $masteryoverride);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->courseLearningObjectScromAdd: ', $e->getMessage(), PHP_EOL;
}

Parameters

Naam	Type	Beschrijving	Opmerkingen
cursusid	int	De unieke identificatiecode van de cursus
pakketbestand	\SplFileObject**	Het .zip-bestand van het SCORM-pakket
naam	string	De naam van het SCORM-pakket
pop-up	int	Geeft aan of het SCORM-pakket in een nieuw venster moet worden geopend (1) of niet (0)	[optional]
breedte	int	De weergavebreedte voor het SCORM-pakket	[optional]
hoogte	int	De weergavehoogte voor het SCORM-pakket	[optional]
grademethod	int	De beoordelingsmethode voor het SCORM-pakket (0: leerobjecten, 1: hoogste cijfer, 2: gemiddeld * cijfer, 3: totaalcijfer)	[optional]
maxgrade	int	Het maximaal mogelijke cijfer voor het SCORM-pakket	[optional]
maximale poging	int	Het maximaal aantal toegestane pogingen voor het SCORM-pakket	[optional]
watgrade	int	De beoordelingsstrategie voor meerdere pogingen (0: hoogste poging, 1: gemiddeld cijfer, 2: eerste * poging)	[optional]
nieuwe poging	int	Beleid voor het afdwingen van nieuwe pogingen (0: nee, 1: elke nieuwe poging is een nieuw cijfer, 2: bij elke nieuwe * poging worden eerdere cijfers gereset)	[optional]
laatste poging	int	Geeft aan of het SCORM-pakket moet worden vergrendeld na de laatste poging (0: nee, 1: ja)	[optional]
autocommit	int	Geeft aan of het SCORM pakket automatisch moet worden vastgelegd (0: nee, 1: ja)	[optional]
masteryoverride	int	Geeft aan of het meestergetal het maximumcijfer overschrijft (0: nee, 1: ja)	[optional]

Type terugkeer

\LtiSaasApi \CursusLearningObjectScromAdd200Response

Autorisatie

token

HTTP verzoek-headers

Inhoudstype: multipart/form-data
Accepteren: toepassing/json

cursusLeerObjectLijst()

courseLearningobjectList($courseid): \LtiSaasApi\Model\CourseLearningobjectList200Response

Leerobjecten voor een cursus ophalen

Dit eindpunt haalt een lijst op van leerobjecten die geassocieerd zijn met een specifieke cursus, geïdentificeerd door zijn * unieke ID.

Voorbeeld

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKey('Access-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Access-Token', 'Bearer');


$apiInstance = new LtiSaasApi\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$courseid = 56; // int | The unique identifier of the course

try {
    $result = $apiInstance->courseLearningobjectList($courseid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->courseLearningobjectList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Naam	Type	Beschrijving	Opmerkingen
cursusid	int	De unieke identificatiecode van de cursus

Type terugkeer

\leervakkenlijst200antwoord

Autorisatie

token

HTTP verzoek-headers

Inhoudstype: Niet gedefinieerd
Accepteren: toepassing/json

cursusleerdoelScormUpdate()

courseLearningobjectScormUpdate($learningobjectid, $packagefile, $name, $popup, $width, $height, $grademethod, $maxgrade, $maxattempt, $whatgrade, $forcenewattempt, $lastattemptlock, $autocommit, $masteryoverride): \LtiSaasApi\Model\CourseUpdate200Response

SCORM-leerobject bijwerken

Dit eindpunt maakt het mogelijk om een SCORM-leerobject bij te werken binnen een cursus. Vereiste parameters zijn * de ID van het leerobject, het .zip-pakketbestand, de naam, de popupmodus en andere beoordelings- en weergave-eigenschappen.

Voorbeeld

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKey('Access-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Access-Token', 'Bearer');


$apiInstance = new LtiSaasApi\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$learningobjectid = 56; // int | The ID of the learning object
$packagefile = "/path/to/file.txt"; // \SplFileObject | The .zip file of the SCORM package
$name = 'name_example'; // string | The name of the SCORM package
$popup = 56; // int | Indicates if the SCORM package should open in a new window (1) or not (0)
$width = 56; // int | The display width for the SCORM package
$height = 56; // int | The display height for the SCORM package
$grademethod = 56; // int | The grading method for the SCORM package (0: learning objects, 1: highest grade, 2: average      *                     grade, 3: sum grade)
$maxgrade = 56; // int | The maximum grade possible for the SCORM package
$maxattempt = 56; // int | The maximum number of attempts allowed for the SCORM package
$whatgrade = 56; // int | The grading strategy for multiple attempts (0: highest attempt, 1: average grade, 2: first      *                     attempt)
$forcenewattempt = 56; // int | Policy for forcing new attempts (0: no, 1: every new attempt is a new grade, 2: every new      *                     attempt resets previous grades)
$lastattemptlock = 56; // int | Indicates if the SCORM package should be locked after the last attempt (0: no, 1: yes)
$autocommit = 56; // int | Indicates if the SCORM package grades should auto commit (0: no, 1: yes)
$masteryoverride = 56; // int | Indicates if the mastery grade overrides the max grade (0: no, 1: yes)

try {
    $result = $apiInstance->courseLearningobjectScormUpdate($learningobjectid, $packagefile, $name, $popup, $width, $height, $grademethod, $maxgrade, $maxattempt, $whatgrade, $forcenewattempt, $lastattemptlock, $autocommit, $masteryoverride);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->courseLearningobjectScormUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Naam	Type	Beschrijving	Opmerkingen
leerdoelid	int	De ID van het leerobject
pakketbestand	\SplFileObject**	Het .zip-bestand van het SCORM-pakket	[optional]
naam	string	De naam van het SCORM-pakket	[optional]
pop-up	int	Geeft aan of het SCORM-pakket in een nieuw venster moet worden geopend (1) of niet (0)	[optional]
breedte	int	De weergavebreedte voor het SCORM-pakket	[optional]
hoogte	int	De weergavehoogte voor het SCORM-pakket	[optional]
grademethod	int	De beoordelingsmethode voor het SCORM-pakket (0: leerobjecten, 1: hoogste cijfer, 2: gemiddeld * cijfer, 3: totaalcijfer)	[optional]
maxgrade	int	Het maximaal mogelijke cijfer voor het SCORM-pakket	[optional]
maximale poging	int	Het maximaal aantal toegestane pogingen voor het SCORM-pakket	[optional]
watgrade	int	De beoordelingsstrategie voor meerdere pogingen (0: hoogste poging, 1: gemiddeld cijfer, 2: eerste * poging)	[optional]
nieuwe poging	int	Beleid voor het afdwingen van nieuwe pogingen (0: nee, 1: elke nieuwe poging is een nieuw cijfer, 2: bij elke nieuwe * poging worden eerdere cijfers gereset)	[optional]
laatste poging	int	Geeft aan of het SCORM-pakket moet worden vergrendeld na de laatste poging (0: nee, 1: ja)	[optional]
autocommit	int	Geeft aan of het SCORM pakket automatisch moet worden vastgelegd (0: nee, 1: ja)	[optional]
masteryoverride	int	Geeft aan of het meestergetal het maximumcijfer overschrijft (0: nee, 1: ja)	[optional]

Type terugkeer

\LtiSaasApi \Cursusupdate200Response

Autorisatie

token

HTTP verzoek-headers

Inhoudstype: multipart/form-data
Accepteren: toepassing/json

cursuslijst()

courseList(): \LtiSaasApi\Model\CourseList200Response

Alle cursussen ophalen

Vraagt een lijst met cursussen op, samen met de bijbehorende LTI-informatie.

Voorbeeld

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKey('Access-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Access-Token', 'Bearer');


$apiInstance = new LtiSaasApi\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->courseList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->courseList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Dit eindpunt heeft geen parameter nodig.

Type terugkeer

\ТSaasApi ТSaasApi ТSaasApi ТSaasApi ТSaasApi ТSaasApi ТSaasApi³

Autorisatie

token

HTTP verzoek-headers

Inhoudstype: Niet gedefinieerd
Accepteren: toepassing/json

cursusLtiRegistratiesDag()

courseLtiRegistrationsByDay($from, $till, $toolid): \LtiSaasApi\Model\CourseLtiRegistrationsByDay200Response

Ontvang LTI-registraties per dag

Dit eindpunt haalt de registraties van Learning Tools Interoperability (LTI) op, gegroepeerd per dag. De resultaten * geven inzicht in de dagelijkse registraties en kunnen worden gebruikt voor analytische doeleinden.

Voorbeeld

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKey('Access-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Access-Token', 'Bearer');


$apiInstance = new LtiSaasApi\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$from = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The start date (format: DD-MM-YYYY)
$till = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The end date (format: DD-MM-YYYY)
$toolid = 56; // int | The identifier of the LTI tool (optional)

try {
    $result = $apiInstance->courseLtiRegistrationsByDay($from, $till, $toolid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->courseLtiRegistrationsByDay: ', $e->getMessage(), PHP_EOL;
}

Parameters

Naam	Type	Beschrijving	Opmerkingen
van	\Datum	De begindatum (formaat: DD-MM-JJJJ)
tot	\Datum	De einddatum (formaat: DD-MM-JJJJ)
toolid	int	De identificatiecode van het LTI-tool (optioneel)	[optional]

Type terugkeer

\LtiSaasApi \CursusLtiInschrijvingenDag200Respons

Autorisatie

token

HTTP verzoek-headers

Inhoudstype: Niet gedefinieerd
Accepteren: toepassing/json

cursusLtiRegistratiesSomByCourse()

courseLtiRegistrationsSumByCourse($from, $till, $courseid): \LtiSaasApi\Model\CourseLtiRegistrationsSumByCourse200Response

Totaal aantal LTI-registraties per cursus

Dit eindpunt haalt het totale aantal registraties van Learning Tools Interoperability (LTI) op voor elke * cursus. De resultaten kunnen gebruikt worden om inzicht te krijgen in de algemene registratieactiviteiten van elke cursus.

Voorbeeld

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKey('Access-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Access-Token', 'Bearer');


$apiInstance = new LtiSaasApi\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$from = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The start date (format: DD-MM-YYYY)
$till = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The end date (format: DD-MM-YYYY)
$courseid = 56; // int | The identifier of the course (optional)

try {
    $result = $apiInstance->courseLtiRegistrationsSumByCourse($from, $till, $courseid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->courseLtiRegistrationsSumByCourse: ', $e->getMessage(), PHP_EOL;
}

Parameters

Naam	Type	Beschrijving	Opmerkingen
van	\Datum	De begindatum (formaat: DD-MM-JJJJ)
tot	\Datum	De einddatum (formaat: DD-MM-JJJJ)
cursusid	int	De identifier van de cursus (optioneel)	[optional]

Type terugkeer

\LtiSaasApi \CursusLtiRegistratiesSomDoorCursus200Respons

Autorisatie

token

HTTP verzoek-headers

Inhoudstype: Niet gedefinieerd
Accepteren: toepassing/json

cursusToolAdd()

courseToolAdd($courseid, $ltiversion, $name, $publishmode, $learningobjectid, $maxenrolled, $roleinstructor, $rolelearner, $provisioningmodeinstructor, $provisioningmodelearner, $gradesync, $gradesynccompletion, $membersync, $membersyncmode, $enrolperiod, $enrolstartdate, $enrolenddate): \LtiSaasApi\Model\CourseToolAdd200Response

Nieuw hulpmiddel aan een cursus toevoegen

Met dit eindpunt kun je een nieuw hulpmiddel toevoegen aan een bestaande cursus. Je moet de cursus-ID en de * details van de toe te voegen tool opgeven.

Voorbeeld

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKey('Access-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Access-Token', 'Bearer');


$apiInstance = new LtiSaasApi\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$courseid = 56; // int | The ID of the course
$ltiversion = 'ltiversion_example'; // string | The version of LTI. Either LTI Advantage or Legacy LTI
$name = 'name_example'; // string | The name
$publishmode = 'publishmode_example'; // string | The mode of publishing (course or activity)
$learningobjectid = 56; // int | The ID of the learning object. Only required if publishmode is set to activity
$maxenrolled = 56; // int | The maximum enrollment. Defaults to unlimited (0).
$roleinstructor = 56; // int | The role of the instructor. Defaults to 3
$rolelearner = 56; // int | The role of the learner. Defaults to 5
$provisioningmodeinstructor = 56; // int | The provisioning mode of the instructor. Defaults to 2
$provisioningmodelearner = 56; // int | The provisioning mode of the learner. Defaults to 1
$gradesync = 56; // int | Whether grade sync is enabled. Grade synchronization (1=Yes, 0=No)
$gradesynccompletion = 56; // int | Require course or activity completion prior to grade synchronisation (1=Yes, 0=No)
$membersync = 56; // int | Whether member sync is enabled. User synchronisation (1=Yes, 0=No)
$membersyncmode = 56; // int | User synchronisation mode (1=Enrol new and unenrol missing users, 2=Enrol new users, 3=Unenrol missing users)
$enrolperiod = 56; // int | The duration of the enrolment (in seconds)
$enrolstartdate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The enrolment start date (YYYY-MM-DDTHH:mm)
$enrolenddate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The enrolment end date (YYYY-MM-DDTHH:mm)

try {
    $result = $apiInstance->courseToolAdd($courseid, $ltiversion, $name, $publishmode, $learningobjectid, $maxenrolled, $roleinstructor, $rolelearner, $provisioningmodeinstructor, $provisioningmodelearner, $gradesync, $gradesynccompletion, $membersync, $membersyncmode, $enrolperiod, $enrolstartdate, $enrolenddate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->courseToolAdd: ', $e->getMessage(), PHP_EOL;
}

Parameters

Naam	Type	Beschrijving	Opmerkingen
cursusid	int	De ID van de cursus
ltiversie	string	De versie van LTI. Ofwel LTI Advantage of Legacy LTI
naam	string	De naam
publicatiewijze	string	De manier van publiceren (cursus of activiteit)
leerdoelid	int	De ID van het leerobject. Alleen vereist als de publicatiemodus is ingesteld op activiteit	[optional]
maximaal ingeschreven	int	De maximale inschrijving. Standaard onbeperkt (0).	[optional]
rolinstructeur	int	De rol van de instructeur. Standaard ingesteld op 3	[optional]
rolleerder	int	De rol van de leerling. Standaard ingesteld op 5	[optional]
bevoorradingsmodusinstructeur	int	De bevoorradingsmodus van de instructeur. Standaard ingesteld op 2	[optional]
toeleveringsmodus lerende	int	De provisioningmodus van de leerling. Standaard ingesteld op 1	[optional]
gradesync	int	Of cijfersynchronisatie is ingeschakeld. Cijfersynchronisatie (1=Ja, 0=Nee)	[optional]
beoordeling	int	Voltooiing van cursus of activiteit vereisen voordat het cijfer wordt gesynchroniseerd (1=Ja, 0=Nee)	[optional]
ledensync	int	Of ledensynchronisatie is ingeschakeld. Gebruikerssynchronisatie (1=Ja, 0=Nee)	[optional]
ledensyncmodus	int	Modus gebruikerssynchronisatie (1=Nieuwe en ontbrekende gebruikers aanmelden, 2=Nieuwe gebruikers aanmelden, 3=Miste gebruikers aanmelden)	[optional]
inschrijvingsperiode	int	De duur van de registratie (in seconden)	[optional]
inschrijfstartdatum	\Datum	De begindatum van de inschrijving (JJJJ-MM-DDTHH:mm)	[optional]
inschrijfdatum	\Datum	De einddatum van de inschrijving (JJJJ-MM-DDTHH:mm)	[optional]

Type terugkeer

\LtiSaasApi Model CursusToolToevoeging200Respons

Autorisatie

token

HTTP verzoek-headers

Inhoudstype: Niet gedefinieerd
Accepteren: toepassing/json

cursusToolVerwijderen()

courseToolDelete($toolid): \LtiSaasApi\Model\CourseUpdate200Response

Een specifieke cursus verwijderen

Dit eindpunt verwijdert een specifieke tool in een cursus. Bij een succesvolle operatie wordt de tool verwijderd uit * de cursus. Als de tool niet gevonden wordt of niet verwijderd kan worden om welke reden dan ook, * worden de juiste foutantwoorden teruggestuurd.

Voorbeeld

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKey('Access-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Access-Token', 'Bearer');


$apiInstance = new LtiSaasApi\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$toolid = 56; // int | The identifier of the lti tool

try {
    $result = $apiInstance->courseToolDelete($toolid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->courseToolDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Naam	Type	Beschrijving	Opmerkingen
toolid	int	De identifier van het lti gereedschap

Type terugkeer

\LtiSaasApi \Cursusupdate200Response

Autorisatie

token

HTTP verzoek-headers

Inhoudstype: Niet gedefinieerd
Accepteren: toepassing/json

cursusToolList()

courseToolList($courseid, $ltitype): \LtiSaasApi\Model\CourseToolList200Response

Alle LTI-tools in een cursus weergeven

Dit eindpunt geeft een lijst van alle LTI-tools die bij een cursus horen.

Voorbeeld

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKey('Access-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Access-Token', 'Bearer');


$apiInstance = new LtiSaasApi\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$courseid = 56; // int | The ID of the course
$ltitype = 'ltitype_example'; // string | The version of LTI. Either LTI Advantage or Legacy LTI

try {
    $result = $apiInstance->courseToolList($courseid, $ltitype);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->courseToolList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Naam	Type	Beschrijving	Opmerkingen
cursusid	int	De ID van de cursus
ltitype	string	De versie van LTI. Ofwel LTI Advantage of Legacy LTI	[optional]

Type terugkeer

\LtiSaasApi \CursusToolList200Response

Autorisatie

token

HTTP verzoek-headers

Inhoudstype: Niet gedefinieerd
Accepteren: toepassing/json

cursusToolUpdate()

courseToolUpdate($toolid, $ltiversion, $name, $publishmode, $learningobjectid, $maxenrolled, $roleinstructor, $rolelearner, $provisioningmodeinstructor, $provisioningmodelearner, $gradesync, $gradesynccompletion, $membersync, $membersyncmode, $enrolperiod, $enrolstartdate, $enrolenddate): \LtiSaasApi\Model\CourseToolAdd200Response

Een specifieke cursus bijwerken

Dit eindpunt update een specifieke tool in een cursus. Gedetailleerde informatie over het * gereedschap zoals de identifier, naam, ltiversie, etc. van het gereedschap moet gegeven worden. Een succesvolle bewerking zal de details van het * gereedschap bijwerken in de cursus.

Voorbeeld

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKey('Access-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Access-Token', 'Bearer');


$apiInstance = new LtiSaasApi\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$toolid = 56; // int | The ID of the lti tool
$ltiversion = 'ltiversion_example'; // string | The version of LTI
$name = 'name_example'; // string | The name
$publishmode = 'publishmode_example'; // string | The mode of publishing (course or activity)
$learningobjectid = 56; // int | The ID of the learning object. Only required if publishmode is set to activity
$maxenrolled = 56; // int | The maximum enrollment
$roleinstructor = 56; // int | The role of the instructor
$rolelearner = 56; // int | The role of the learner
$provisioningmodeinstructor = 56; // int | The provisioning mode of the instructor
$provisioningmodelearner = 56; // int | The provisioning mode of the learner
$gradesync = 56; // int | Whether grade sync is enabled. Grade synchronization (1=Yes, 0=No)
$gradesynccompletion = 56; // int | Require course or activity completion prior to grade synchronisation (1=Yes, 0=No)
$membersync = 56; // int | Whether member sync is enabled. User synchronisation (1=Yes, 0=No)
$membersyncmode = 56; // int | User synchronisation mode (1=Enrol new and unenrol missing users, 2=Enrol new users, 3=Unenrol missing users)
$enrolperiod = 56; // int | The duration of the enrolment (in seconds)
$enrolstartdate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The enrolment start date (YYYY-MM-DDTHH:mm)
$enrolenddate = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | The enrolment end date (YYYY-MM-DDTHH:mm)

try {
    $result = $apiInstance->courseToolUpdate($toolid, $ltiversion, $name, $publishmode, $learningobjectid, $maxenrolled, $roleinstructor, $rolelearner, $provisioningmodeinstructor, $provisioningmodelearner, $gradesync, $gradesynccompletion, $membersync, $membersyncmode, $enrolperiod, $enrolstartdate, $enrolenddate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->courseToolUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Naam	Type	Beschrijving	Opmerkingen
toolid	int	De ID van het lti gereedschap
ltiversie	string	De versie van LTI	[optional]
naam	string	De naam	[optional]
publicatiewijze	string	De manier van publiceren (cursus of activiteit)	[optional]
leerdoelid	int	De ID van het leerobject. Alleen vereist als de publicatiemodus is ingesteld op activiteit	[optional]
maximaal ingeschreven	int	De maximale inschrijving	[optional]
rolinstructeur	int	De rol van de instructeur	[optional]
rolleerder	int	De rol van de leerling	[optional]
bevoorradingsmodusinstructeur	int	De bevoorradingsmodus van de instructeur	[optional]
toeleveringsmodus lerende	int	De bevoorradingsmodus van de leerling	[optional]
gradesync	int	Of cijfersynchronisatie is ingeschakeld. Cijfersynchronisatie (1=Ja, 0=Nee)	[optional]
beoordeling	int	Voltooiing van cursus of activiteit vereisen voordat het cijfer wordt gesynchroniseerd (1=Ja, 0=Nee)	[optional]
ledensync	int	Of ledensynchronisatie is ingeschakeld. Gebruikerssynchronisatie (1=Ja, 0=Nee)	[optional]
ledensyncmodus	int	Modus gebruikerssynchronisatie (1=Nieuwe en ontbrekende gebruikers aanmelden, 2=Nieuwe gebruikers aanmelden, 3=Miste gebruikers aanmelden)	[optional]
inschrijvingsperiode	int	De duur van de registratie (in seconden)	[optional]
inschrijfstartdatum	\Datum	De begindatum van de inschrijving (JJJJ-MM-DDTHH:mm)	[optional]
inschrijfdatum	\Datum	De einddatum van de inschrijving (JJJJ-MM-DDTHH:mm)	[optional]

Type terugkeer

\LtiSaasApi Model CursusToolToevoeging200Respons

Autorisatie

token

HTTP verzoek-headers

Inhoudstype: Niet gedefinieerd
Accepteren: toepassing/json

cursusupdate()

courseUpdate($coursename, $courseid, $coursenameshort): \LtiSaasApi\Model\CourseUpdate200Response

Een bestaande cursus bijwerken

Met dit eindpunt kun je een bestaande cursus bijwerken. Het cursus id moet worden doorgegeven als een query * parameter.

Voorbeeld

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKey('Access-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Access-Token', 'Bearer');


$apiInstance = new LtiSaasApi\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$coursename = 'coursename_example'; // string | The name of the course to be created
$courseid = 56; // int | The unique identifier of the course to be deleted
$coursenameshort = 'coursenameshort_example'; // string | The name of the course to be created

try {
    $result = $apiInstance->courseUpdate($coursename, $courseid, $coursenameshort);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->courseUpdate: ', $e->getMessage(), PHP_EOL;
}

Parameters

Naam	Type	Beschrijving	Opmerkingen
cursusnaam	string	De naam van de cursus die moet worden aangemaakt
cursusid	int	De unieke identifier van de te verwijderen cursus
cursusnaam	string	De naam van de cursus die moet worden aangemaakt	[optional]

Type terugkeer

\LtiSaasApi \Cursusupdate200Response

Autorisatie

token

HTTP verzoek-headers

Inhoudstype: Niet gedefinieerd
Accepteren: toepassing/json

tokenAdd()

tokenAdd($name): \LtiSaasApi\Model\TokenAdd200Response

Een nieuw API token toevoegen

Dit eindpunt maakt een nieuw API token aan. * Er is een naam nodig om een nieuw API token aan te maken. * Bij een succesvolle operatie zal een nieuw API token worden toegevoegd aan het systeem en de details zullen worden geretourneerd. * Als het API token om bepaalde redenen niet kan worden aangemaakt, worden de juiste foutreacties geretourneerd.

Voorbeeld

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKey('Access-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Access-Token', 'Bearer');


$apiInstance = new LtiSaasApi\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$name = 'name_example'; // string | The name of the token for your own administration purposes

try {
    $result = $apiInstance->tokenAdd($name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->tokenAdd: ', $e->getMessage(), PHP_EOL;
}

Parameters

Naam	Type	Beschrijving	Opmerkingen
naam	string	De naam van het token voor uw eigen administratiedoeleinden

Type terugkeer

\LtiSaasApi\Model \TokenAdd200Response

Autorisatie

token

HTTP verzoek-headers

Inhoudstype: Niet gedefinieerd
Accepteren: toepassing/json

tokenVerwijderen()

tokenDelete($token): \LtiSaasApi\Model\CourseUpdate200Response

Een API token verwijderen

Dit eindpunt verwijdert een API token gebaseerd op een gegeven token ID. * Het vereist het token van de API om deze bewerking uit te voeren. * Bij succesvolle verwijdering wordt het API token verwijderd uit het systeem. * In het geval dat het token ID niet wordt gevonden of niet kan worden verwijderd om bepaalde redenen, * zullen passende foutreacties worden geretourneerd.

Voorbeeld

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKey('Access-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Access-Token', 'Bearer');


$apiInstance = new LtiSaasApi\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$token = 'token_example'; // string | The tokenkey you want to delete

try {
    $result = $apiInstance->tokenDelete($token);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->tokenDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Naam	Type	Beschrijving	Opmerkingen
token	string	De tokenkey die u wilt verwijderen

Type terugkeer

\LtiSaasApi \Cursusupdate200Response

Autorisatie

token

HTTP verzoek-headers

Inhoudstype: Niet gedefinieerd
Accepteren: toepassing/json

tokenLijst()

tokenList(): \LtiSaasApi\Model\TokenList200Response

Lijst van API tokens opvragen

Dit eindpunt haalt een lijst op van alle API tokens. Het resultaat is een lijst van API tokens met hun respectievelijke * informatie, zoals token, endpoint, naam, enz. Dit kan gebruikt worden voor het beheren of auditen van het gebruik van API tokens in het * systeem.

Voorbeeld

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKey('Access-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Access-Token', 'Bearer');


$apiInstance = new LtiSaasApi\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->tokenList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->tokenList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Dit eindpunt heeft geen parameter nodig.

Type terugkeer

\LtiSaasApi\ModelokenList200Response

Autorisatie

token

HTTP verzoek-headers

Inhoudstype: Niet gedefinieerd
Accepteren: toepassing/json

gebruiker verwijderen()

userDelete($id): \LtiSaasApi\Model\CourseUpdate200Response

Een gebruiker verwijderen op ID

Dit eindpunt verwijdert een gebruiker op basis van een gegeven ID. * Bij succesvolle verwijdering wordt de gebruiker verwijderd uit het systeem. * In het geval dat de gebruikers-ID niet gevonden wordt of niet verwijderd kan worden vanwege bepaalde redenen, zullen * gepaste foutreacties teruggestuurd worden.

Voorbeeld

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKey('Access-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Access-Token', 'Bearer');


$apiInstance = new LtiSaasApi\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$id = 56; // int | The identifier of the user

try {
    $result = $apiInstance->userDelete($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->userDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Naam	Type	Beschrijving	Opmerkingen
id	int	De identificatie van de gebruiker

Type terugkeer

\LtiSaasApi \Cursusupdate200Response

Autorisatie

token

HTTP verzoek-headers

Inhoudstype: Niet gedefinieerd
Accepteren: toepassing/json

userDeleteBulk()

userDeleteBulk($ids): \LtiSaasApi\Model\CourseUpdate200Response

Meerdere gebruikers verwijderen op ID

Dit eindpunt verwijdert meerdere gebruikers gebaseerd op gegeven ID’s. Bij succesvolle verwijdering worden de gebruikers * verwijderd uit het systeem. In het geval dat een van de gebruikers ID’s niet wordt gevonden of niet kan worden verwijderd om bepaalde redenen, * zal een passende foutmelding worden teruggestuurd.

Voorbeeld

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKey('Access-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Access-Token', 'Bearer');


$apiInstance = new LtiSaasApi\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$ids = array(56); // int[] | Comma-separated list of identifiers of the users to delete

try {
    $result = $apiInstance->userDeleteBulk($ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->userDeleteBulk: ', $e->getMessage(), PHP_EOL;
}

Parameters

Naam	Type	Beschrijving	Opmerkingen
ids	int[]	Door komma’s gescheiden lijst met identifiers van de te verwijderen gebruikers

Type terugkeer

\LtiSaasApi \Cursusupdate200Response

Autorisatie

token

HTTP verzoek-headers

Inhoudstype: Niet gedefinieerd
Accepteren: toepassing/json

gebruikerslijst()

userList($toolid): \LtiSaasApi\Model\UserList200Response

Lijst van gebruikers in een tool opvragen

Dit eindpunt haalt een lijst op van gebruikers die geregistreerd zijn in een specifieke tool. Het resultaat is een lijst van * gebruikers met hun respectieve informatie, die kan worden gebruikt voor verdere bewerkingen of analyses.

Voorbeeld

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure API key authorization: token
$config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKey('Access-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = LtiSaasApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Access-Token', 'Bearer');


$apiInstance = new LtiSaasApi\Api\DefaultApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$toolid = 56; // int | The identifier of the tool (optional)

try {
    $result = $apiInstance->userList($toolid);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->userList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Naam	Type	Beschrijving	Opmerkingen
toolid	int	De identificatie van het gereedschap (optioneel)	[optional]

Type terugkeer

\LtiSaasApi\Modelgebruikerlijst200antwoord

Autorisatie

token

HTTP verzoek-headers

Inhoudstype: Niet gedefinieerd
Accepteren: toepassing/json

Updated on 11 december 2024

Was this article helpful?

Yes No

cursusAdd()

HTTP verzoek-headers

cursusverwijderen()

cursusleerobjectverwijderen()

CourseLearningObjectScormAdd()

cursusLeerObjectLijst()

cursusleerdoelScormUpdate()

HTTP verzoek-headers

cursuslijst()

HTTP verzoek-headers

cursusLtiRegistratiesDag()

HTTP verzoek-headers

cursusLtiRegistratiesSomByCourse()

cursusToolAdd()

cursusToolVerwijderen()

cursusToolList()

cursusToolUpdate()

cursusupdate()

tokenAdd()

tokenVerwijderen()

tokenLijst()

gebruiker verwijderen()

userDeleteBulk()

gebruikerslijst()

Related Articles

Leave a Comment