With our simple API you can automatically add participants to your Exam or Academy and send them an invitation.
API Language
Our API accepts application/x-www-form-urlencoded or multipart/form-data and json.
Exam API
Add participant
This API call only works if the access of your Exam is set to A predefined group of users.
HTTP method: POST
Endpoint: https://www.onlinequizcreator.com/?r=api/exam/addParticipant
Success response
{ Â
  "success":true
}Â
Error response
{
 "success":false, Â
  "error":"Example error"
}Â
Field - Type - Description
apikey - String - The generated API key for your account.
email - String - The email address of the participant you want to add.
name - String - The name of the participant you want to add.
examId - Integer - The ID of the Exam.Â
Add participant without notifying
Add a participant to your Exam without sending him an invitation. The login credentials will be returned in the response.
HTTP method: POST
Endpoint: https://www.onlinequizcreator.com/?r=api/exam/addParticipantWithoutNotifyingÂ
Success response
{ Â
"success":true, Â
"data":
  {
    "playUrl":"[https://the.url/to/your/exam](https://the.url/to/your/exam)",  Â
    "email":"[john@doe.com](mailto:john@doe.com)",  Â
    "authenticationCode":"ExampleAuthenticationCode" Â
  }
}Â
Error response
{ Â "success":false, Â "error":"Example error"}Â
Field - Type - Description
apikey - String - The generated API key for your account.
email - String - The email address of the participant you want to add.
name - String - The name of the participant you want to add.
examId - Integer - The ID of the Exam.
identifier - String - The identifier for the participant.Â
Academy API
Add participant
Add a participant to your Academy. You can add a participant to one or more groups in your Academy (group IDs can be found on the Group overview page).
HTTP method: POST
Endpoint: https://www.onlinequizcreator.com/?r=api/academy/addParticipantÂ
Success response
{ Â "success":true}Â
Error response
{ Â "success":false, Â "error":"Example error"}Â
Field - Type - Description
apikey - String - The generated API key for your account.
email - String - The email address of the participant you want to add.
name - String - The name of the participant you want to add.
groups - String - The groups you want to add the participant to. Separate group IDs with a comma.
Add participant without notifying
Add a participant to your Academy but don't send an invitation. The login credentials will be returned in the response. You can add a participant to one or more groups in your Academy (group IDs can be found on the Group overview page).
HTTP method: POST
Endpoint: https://www.onlinequizcreator.com/?r=api/academy/addParticipantWithoutNotifyingÂ
Success response
{ Â
"success":true, Â
"data":
   {  Â
     "playUrl":"[https://the.url/to/your/academy](https://the.url/to/your/academy)",  Â
      "email":"[john@doe.com](mailto:john@doe.com)",  Â
      "authenticationCode":"ExampleAuthenticationCode" Â
   }
}Â
Error response
{ Â "success":false, Â "error":"Example error"}Â
Field - Type - Description
apikey - String - The generated API key for your account.
email - String - The email address of the participant you want to add.
name - String - The name of the participant you want to add.
identifier - String - The identifier for the participant in your system.
groups - String - The groups you want to add the participant to. Separate group IDs with a comma.
API Language
Our API accepts application/x-www-form-urlencoded or multipart/form-data and json.
Exam API
Add participant
This API call only works if the access of your Exam is set to A predefined group of users.
HTTP method: POST
Endpoint: https://www.onlinequizcreator.com/?r=api/exam/addParticipant
Success response
{ Â
  "success":true
}Â
Error response
{
 "success":false, Â
  "error":"Example error"
}Â
Field - Type - Description
apikey - String - The generated API key for your account.
email - String - The email address of the participant you want to add.
name - String - The name of the participant you want to add.
examId - Integer - The ID of the Exam.Â
Add participant without notifying
Add a participant to your Exam without sending him an invitation. The login credentials will be returned in the response.
HTTP method: POST
Endpoint: https://www.onlinequizcreator.com/?r=api/exam/addParticipantWithoutNotifyingÂ
Success response
{ Â
"success":true, Â
"data":
  {
    "playUrl":"[https://the.url/to/your/exam](https://the.url/to/your/exam)",  Â
    "email":"[john@doe.com](mailto:john@doe.com)",  Â
    "authenticationCode":"ExampleAuthenticationCode" Â
  }
}Â
Error response
{ Â "success":false, Â "error":"Example error"}Â
Field - Type - Description
apikey - String - The generated API key for your account.
email - String - The email address of the participant you want to add.
name - String - The name of the participant you want to add.
examId - Integer - The ID of the Exam.
identifier - String - The identifier for the participant.Â
Academy API
Add participant
Add a participant to your Academy. You can add a participant to one or more groups in your Academy (group IDs can be found on the Group overview page).
HTTP method: POST
Endpoint: https://www.onlinequizcreator.com/?r=api/academy/addParticipantÂ
Success response
{ Â "success":true}Â
Error response
{ Â "success":false, Â "error":"Example error"}Â
Field - Type - Description
apikey - String - The generated API key for your account.
email - String - The email address of the participant you want to add.
name - String - The name of the participant you want to add.
groups - String - The groups you want to add the participant to. Separate group IDs with a comma.
Add participant without notifying
Add a participant to your Academy but don't send an invitation. The login credentials will be returned in the response. You can add a participant to one or more groups in your Academy (group IDs can be found on the Group overview page).
HTTP method: POST
Endpoint: https://www.onlinequizcreator.com/?r=api/academy/addParticipantWithoutNotifyingÂ
Success response
{ Â
"success":true, Â
"data":
   {  Â
     "playUrl":"[https://the.url/to/your/academy](https://the.url/to/your/academy)",  Â
      "email":"[john@doe.com](mailto:john@doe.com)",  Â
      "authenticationCode":"ExampleAuthenticationCode" Â
   }
}Â
Error response
{ Â "success":false, Â "error":"Example error"}Â
Field - Type - Description
apikey - String - The generated API key for your account.
email - String - The email address of the participant you want to add.
name - String - The name of the participant you want to add.
identifier - String - The identifier for the participant in your system.
groups - String - The groups you want to add the participant to. Separate group IDs with a comma.