Met onze eenvoudige API kun je automatisch deelnemers aan je Examen of Academy toevoegen en hen een uitnodiging sturen.

API-taal

Onze API accepteert applicatie/x-www-form-urlencoded of multipart/form-data en json.

Examen-API

Deelnemer toevoegen

Deze API-aanroep werkt alleen als de toegang tot je examen is ingesteld op . Een vooraf gedefinieerde groep gebruikers.

HTTP methode: POST

Eindpunt: https://www.onlinequizcreator.com/?r=api/exam/addParticipant

Succesvol antwoord
{
"succes":waar
}

Foutreactie
{
"succes": vals,
"Fout": "Voorbeeldfout"
}

Veld - Type - Beschrijving

apikey - String - De gegenereerde API sleutel voor je account.
e-mail - String - Het e-mailadres van de deelnemer die je wilt toevoegen.
naam - String - De naam van de deelnemer die je wilt toevoegen.
examenId - Integer - Het ID van het examen.

Deelnemer toevoegen zonder kennisgeving

Voeg een deelnemer toe aan je examen zonder hem een [uitnodiging] te sturen (https://help.easy-lms.com/en-us/article/inviting-participants-to-take-an-exam-136fsvw/). De inloggegevens worden in de reactie teruggestuurd.

HTTP methode: POST

Eindpunt: https://www.onlinequizcreator.com/?r=api/exam/addParticipantWithoutNotifying

Succesvol antwoord
{
"succes": waar,
"gegevens":
{
"playUrl":"[https://the.url/to/your/exam](https://the.url/to/your/exam)",
"e-mail":"[john@doe.com](mailto:john@doe.com)",
"authenticatieCode": "VoorbeeldAuthenticatieCode".
}
}

Foutreactie

{"succes":fout, "fout":"voorbeeldfout"}

Veld - Type - Beschrijving
apikey - String - De gegenereerde API sleutel voor je account.
e-mail - String - Het e-mailadres van de deelnemer die je wilt toevoegen.
naam - String - De naam van de deelnemer die je wilt toevoegen.
examenId - Integer - Het ID van het examen.
Identifier - String - De identifier voor de deelnemer.

Academy API

Deelnemer toevoegen

Voeg een deelnemer toe aan je Academy. Je kunt een deelnemer toevoegen aan één of meerdere groepen in je Academy (groeps-ID's zijn te vinden op de Groepsoverzicht pagina).

HTTP methode: POST

Eindpunt: https://www.onlinequizcreator.com/?r=api/academy/addParticipant

Succesvol antwoord

{"succes":waar}

Foutreactie

{"succes":fout, "fout":"voorbeeldfout"}

Veld - Type - Beschrijving

apikey - String - De gegenereerde API sleutel voor je account.
e-mail - String - Het e-mailadres van de deelnemer die je wilt toevoegen.
naam - String - De naam van de deelnemer die je wilt toevoegen.
groepen - String - De groepen waar je de deelnemer aan wilt toevoegen. Scheid de groeps-ID's met een komma.

Deelnemer toevoegen zonder kennisgeving

Voeg een deelnemer toe aan je Academy maar stuur geen uitnodiging. De inloggegevens worden in de reactie teruggestuurd. Je kunt een deelnemer toevoegen aan één of meerdere groepen in je Academy (groeps-ID's zijn te vinden op de Groepsoverzicht pagina).

HTTP-methode: POST

Eindpunt: https://www.onlinequizcreator.com/?r=api/academy/addParticipantWithoutNotifying

Succesvol antwoord
{
"succes": waar,
"gegevens":
{
"playUrl":"[https://the.url/to/your/academy](https://the.url/to/your/academy)",
"e-mail":"[john@doe.com](mailto:john@doe.com)",
"authenticatieCode": "VoorbeeldAuthenticatieCode".
}
}

Foutreactie

{"succes":fout, "fout":"voorbeeldfout"}

Veld - Type - Beschrijving

apikey - String - De gegenereerde API sleutel voor je account.
e-mail - String - Het e-mailadres van de deelnemer die je wilt toevoegen.
naam - String - De naam van de deelnemer die je wilt toevoegen.
Identifier - String - De identifier voor de deelnemer in je systeem.
groepen - String - De groepen waar je de deelnemer aan wilt toevoegen. Scheid de groeps-ID's met een komma.

Gepubliceerd op: 14 / 12 / 2020