Menu
1. Dossiers / Questions
1.1. QuestionFolder
GET /api/question_folders
Description :
Récupère un ensemble de données sur les dossiers de questions présents dans le menu Evaluations > Questions.
Les Dossiers Tirage Au Sort (DTAS) ne sont pas concernés.
Paramètres d’entrée :
title (string) :
tags (string) :
tags[] (array[string]) :
tags.name (string) :
createdAt[before] (string) :
createdAt[strictly_before] (string) :
createdAt[after] (string) :
createdAt[strictly_after] (string) :
archived (boolean) :
page (integer) : 1 (Valeur par défaut)
Réponse :
{
"hydra:member": [
{
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"title": "string", // Titre du dossier de question
"createdAt": "2023-08-21T13:28:26.171Z", // Date de création
"type": "string", // Type de dossier
"independant": true, // État d'indépendance du dossier
"archived": true, // État d'archivage du dossier
"status": 0, // Statut du dossier
"weight": 0, // Pondération
"tags": [
{
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"name": "string", // Nom de l'étiquette
"category": "string" // Catégorie de l'étiquette
}
]
}
],
"hydra:totalItems": 0, // Nombre total d'activité
"hydra:view": { // Module des pages
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"hydra:first": "string", // Première page
"hydra:last": "string", // Dernière page
"hydra:next": "string" // Page suivante
},
"hydra:search": { // Module des fktres
"@type": "string", // Type de la route
"hydra:template": "string", // Représentation des filtres
"hydra:variableRepresentation": "string", // Représentation des filtres
"hydra:mapping": [
{
"@type": "string", // Type de la route
"variable": "string", // Variable de filtre
"property": "string", // Variable de filtre
"required": true // État d'utilisation du filtre
}
]
}
}
GET /api/question_folders/{id}
Description :
Récupère un ensemble de données d’un dossier, dont la liste des questions présentes.
Les Dossiers Tirage Au Sort (DTAS) ne sont pas concernés.
Paramètres d’entrée :
Id (string) : Identifiant du dossier. Il est important de noter que l’identifiant correspond à celui renseigné sur la plateforme.
Réponse :
{
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"introduction": {
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string" // Type de la route
},
"questions": [
"string" //Liste des ID des questions présentes dans le dossier
],
"title": "string", // Titre du dossier
"createdAt": "2023-08-21T13:30:15.021Z", // Date de création
"type": "string", // Type de la route
"independant": true, // État d'indépendance du dossier
"archived": true, // État d'archivage du dossier
"status": 0, // Statut du dossier
"weight": 0, // Pondération du dossier
"tags": [
{
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"name": "string", // Nom de l'étiquette
"category": "string" // Catégorie de l'étiquette
}
]
}
```
1.2. RandomQuestionFolder
GET /api/random_question_folders
Description :
Récupère un ensemble de données sur les Dossiers Tirage Au Sort (DTAS) présents dans le menu Evaluations > Questions.
Paramètres d’entrée :
title (string) :
tags (string) :
tags[] (array[string]) :
tags.name (string) :
createdAt[before] (string) :
createdAt[strictly_before] (string) :
createdAt[after] (string) :
createdAt[strictly_after] (string) :
archived (boolean) :
page (integer) : 1 (Valeur par défaut)
Réponse :
{
"hydra:member": [
{
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"title": "string", // Titre du dossier
"createdAt": "2023-08-21T13:59:52.577Z", // Date de création du dossier
"type": "string", // Type de dossier
"independant": true, // État d'indépendance du dossier
"archived": true, // État d'archivage du dossier
"status": 0, // Statut du dossier
"weight": 0, // Pondération du dossier
"tags": [
{
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"name": "string", // Nom de l'étiquette
"category": "string" // Catégorie de l'étiquette
}
]
}
],
"hydra:totalItems": 0, // Nombre total d'activité
"hydra:view": { // Module des pages
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"hydra:first": "string", // Première page
"hydra:last": "string", // Dernière page
"hydra:next": "string" // Page suivante
},
"hydra:search": { // Module des fktres
"@type": "string", // Type de la route
"hydra:template": "string", // Représentation des filtres
"hydra:variableRepresentation": "string", // Représentation des filtres
"hydra:mapping": [
{
"@type": "string", // Type de la route
"variable": "string", // Variable de filtre
"property": "string", // Variable de filtre
"required": true // État d'utilisation du filtre
}
]
}
}
GET /api/random_question_folders/{id}
Description :
Récupère un ensemble de données d’un DTAS.
Paramètres :
Id (string) : Identifiant du DTAS. Il est important de noter que l’identifiant correspond à celui renseigné sur la plateforme.
Réponse :
{
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"introduction": {
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string" // Type de la route
},
"folderQuestions": [
{
"@id": "string", // ID du dossier libre
"@type": "string", // Type de la route
"questionFolder": "string", // Identifiant du dossier libre au sein du DTAS
"nbToPick": 0 // Nombre de question
}
],
"title": "string", // Titre du dossier
"createdAt": "2023-08-21T13:59:00.387Z", // Date de création
"type": "string", // Type de la route
"independant": true, // État d'indépendance du dossier
"archived": true, // État d'archivage du dossier
"status": 0, // Statut du dossier
"weight": 0, // Pondération du dossier
"tags": [
{
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"name": "string", // Nom de l'étiquette
"category": "string" // Catégorie de l'étiquette
}
]
}
1.3. Question
GET /api/question
Description :
Récupère un ensemble de données concernant l’ensemble des questions isolées présentes dans le menu Evaluations > Questions.
Paramètres :
title (string) :
tags (string) :
tags[] (array[string]) :
tags.name (string) :
createdAt[before] (string) :
createdAt[strictly_before] (string) :
createdAt[after] (string) :
createdAt[strictly_after] (string) :
archived (boolean) :
page (integer) : 1 (Valeur par défaut)
Réponse :
{
"hydra:member": [
{
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"title": "string", // Titre de la question
"createdAt": "2023-08-21T13:30:46.344Z", // Date de création de la question
"type": "string", // Type de la question
"independant": true, // État d'indépendance de la question
"archived": true, // État d'archivage de la question
"status": 0, // Statut de la question
"weight": 0, // Pondération de la question
"tags": [
{
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"name": "string", // Nom de l'étiquette
"category": "string" // Catégorie de l'étiquette
}
]
}
],
"hydra:totalItems": 0, // Nombre total d'activité
"hydra:view": { // Module des pages
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"hydra:first": "string", // Première page
"hydra:last": "string", // Dernière page
"hydra:next": "string" // Page suivante
},
"hydra:search": { // Module des fktres
"@type": "string", // Type de la route
"hydra:template": "string", // Représentation des filtres
"hydra:variableRepresentation": "string", // Représentation des filtres
"hydra:mapping": [
{
"@type": "string", // Type de la route
"variable": "string", // Variable de filtre
"property": "string", // Variable de filtre
"required": true // État d'utilisation du filtre
}
]
}
}
GET /api/question/{id}
Description :
Récupère un ensemble données d’une question isolée.
Paramètres :
Id (string) : Identifiant de la question isolée. Il est important de noter que l’identifiant correspond à celui renseigné sur la plateforme.
Réponse :
{
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"statement": {
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"textBlocks": [
{
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"textContent": "string", // Contenu du texte de la question
"contentType": "string", // Type de question
"position": 0 // Position de la question
}
],
"imageBlocks": [
{
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"fileLink": {
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"fileUrl": "string" // URL ou Fichier utilisé
},
"position": 0 // Position dans la question
}
],
"videoBlocks": [
{
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"fileLink": {
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"fileUrl": "string" // URL ou Fichier utilisé
},
"position": 0 // Position dans la question
}
],
"audioBlocks": [
{
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"fileLink": {
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"fileUrl": "string" // URL ou Fichier utilisé
},
"position": 0 // Position dans la question
}
],
"position": 0 // Position dans la question
},
"title": "string", // Titre de la question
"createdAt": "2023-08-21T13:31:47.342Z", // Date de création
"type": "string", // Type de question
"independant": true, // État d'indépendance de la question
"archived": true, // État d'archivage de la question
"status": 0, // Statut de la question
"weight": 0, // Pondération de la question
"tags": [
{
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // type de la route
"name": "string", // Nom de l'étiquette
"category": "string" // Catégorie de l'étiquette
}
]
}
2. Examens
GET /api/exams
Description :
Récupère un ensemble de données concernant l’ensemble des examens et conférences présents dans le menu Evaluations > Epreuves.
Les entrainements et devoirs ne sont pas concernés.
Paramètres d’entrée :
creator (string) :
creator[] (array[string]) :
title (string) :
page (integer) : 1 (Valeur par défaut)
Réponse :
{
"hydra:member": [ // Entité de l'item
{
"@id": "string", // ID de l'examen
"@type": "string", // Type de l'examen
"startDate": "2023-08-21T12:32:40.075Z", // Date de départ de l'examen
"endDate": "2023-08-21T12:32:40.075Z", // Date de fin de l'examen
"accessCode": "string", // Code d'accès de l'examen
"title": "string", // Titre de l'examen
"creator": "string", // ID du créateur de l'examen
"archived": true // État de l'archivage de l'examen
}
],
"hydra:totalItems": 0, // Nombre total d'items
"hydra:view": {
"@id": "string", // Page sur laquelle se trouve l'examen
"@type": "string", // Type de route
"hydra:first": "string", // Numéro de la première page
"hydra:last": "string", // Numéro de la dernière page
"hydra:next": "string" // Numéro de la prochaine page
},
"hydra:search": {
"@type": "string", // Type de filtre utilisé
"hydra:template": "string", // Type de filtre utilisé
"hydra:variableRepresentation": "string", // Type de route
"hydra:mapping": [
{
"@type": "string", // Type de route
"variable": "string", // Variable filtre
"property": "string", // Variable filtre
"required": true // État d'utilisation du filtre
}
]
}
}
GET /api/exams/{id}
Description :
Récupère un ensemble de données d’un examen ou d’une conférence.
Paramètres d’entrée :
Id (string) : Identifiant de l’épreuve. Il est important de noter que l’identifiant correspond à celui renseigné sur la plateforme.
Réponse :
{
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"accessCode": "string", // Code d'accès de l'examen
"title": "string", // Titre de l'examen
"creator": "string", // ID du créateur de l'examen
"assessmentOptions": "string", // ID des options
"archived": true, // État d'archivage de l'examen
"anticheatEnabled": true // État de l'option anti-triche
}
GET /api/exams/{id}/correction
Description :
Initie le calcul des notes pour l’ensemble des participants d’une épreuve terminée.
Une fois qu’un examen est terminé, il est impératif d’appeler cette route afin de pouvoir exporter les notes.
Paramètres :
Id (string) : Identifiant de l’épreuve.
Réponse :
{
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"correction": [
"pendingJobs": false, // État d'actions de correction en attente
"pendingJobsResult": [], // État des résultats de correction
"correctionStatus": true, // État du statut de correction
"isFinishedExam": true // État du statut de l'examen
]
}
GET /api/exams/{id}/checkjobs
Description :
Récupère un ensemble de données concernant les processus asynchrones d’une épreuve.
Cette route permet de vérifier, par exemple, que le calcul des notes est bien terminé avant de réaliser un export.
Paramètres :
Id (string) : Identifiant de l’épreuve.
Réponse :
{
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"checkJobs": [
"string"
"pendingJobs": false, // État de l'action asynchrone en cours
"pendingJobsCount": null // État de l'action asynchrone
]
}
GET /api/exams/{id}/participant_groups
Description :
Récupère la liste des participants d’un examen inscrits via l’inscription par groupe.
Les personnes inscrites via l’inscription individuelle ne sont pas concernées.
Aussi, cette route n’est fonctionnelle que pour les examens et non les conférences.
Paramètres :
Id (string) : Identifiant de l’examen
page (integer) : 1 (Valeur par défaut)
Réponse :
{
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"hydra:member": [ // Groupement des participants
{
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"assessment": {
"@id": "string", // ID de l'examen
"@type": "string" // Type de la route
},
"group": "string", // ID du groupe
"participants": [
"string" // ID des participants
]
}
],
"hydra:totalItems": 0 // Nombre total de groupe
}
GET /api/exams/{id}/participants
Description :
Récupère un ensemble de données sur l’ensemble des participants à un examen ou une conférence qu’ils soient inscrits par groupe ou individuellement.
Paramètres :
id (string) :
lastCorrectionDate[before] (string) :
lastCorrectionDate[strictly_before] (string) :
lastCorrectionDate[after] (string) :
lastCorrectionDate[strictly_after] (string) :
user (string) :
user[] (array[string]) :
Réponse :
{
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"hydra:member": [
{
"@id": "string", // ID du participant
"@type": "string", // Type de la route
"additionalTime": 0, // État du temps additionnel
"status": 0, // Statut du participant
"placeNumber": 0, // Numéro de place du participant
"participantGroups": [], // ID du groupe
"user": "string" // ID de l'utilisateur référent
}
],
"hydra:totalItems": 34, // Nombre total de participants
"hydra:view": {
"@id": "string", // Numéro de la page
"@type": "string", // Type de la route
"hydra:first": "string", // Numéro de la première page
"hydra:last": "string", // Numéro de la dernière page
"hydra:next": "string" // Numéro de la page suivante
},
"hydra:search": {
"@type": "string", // Type de la route
"hydra:template": "string", // Filtres utilisés
"hydra:variableRepresentation": "string", // Type des filtres
"hydra:mapping": [
{
"@type": "string", // Type de la route
"variable": "string", // Nom du filtre
"property": "string", // Nom du filtre
"required": false // État d'utilisation du filtre
}
]
}
}
GET /api/exams/{id}/participants_results
Description :
Récupère les résultats de l’ensemble des participants.
Paramètres :
id (string) :
lastCorrectionDate[before] (string) :
lastCorrectionDate[strictly_before] (string) :
lastCorrectionDate[after] (string) :
lastCorrectionDate[strictly_after] (string) :
user (string) :
user[] (array[string]) :
Réponse :
{
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"hydra:member": [
{
"@id": "string", // ID des participants
"@type": "string", // Type de la route
"additionalTime": 0, // État du temps additionnel
"status": 0, // Statut des participants
"placeNumber": 0, // Numéro de places de participants
"assessmentSessions": [
{
"@id": "string", // ID de la session d'examen
"@type": "string", // Type de laroute
"status": 0, // Statut de la session d'examen
"createdAt": "string", // Date de création de la session d'examen
"beginDate": "string", // Date de départ de la session d'examen
"endDate": "string", // Date de fin de la session d'examen
"score": "string", // Score total de la session d'examen
"questionFoldersResults": [
{
"@type": "string", // Type de la route
"@id": "string", // ID des résultats de l'examen
"correctionConfiguration": {
"@type": "string", // Type de la route
"@id": "string", // ID des résultats de l'examen
"questionnaireQuestionFolder": "string", // ID des résultats de l'examen
"weight": 0, // Pondération des résultats de l'examen
"markScheme": "string" // ???
},
"questionResults": [
{
"@type": "string", // Type de la route
"@id": "string", // ID de la question
"correctionConfiguration": {
"@type": "string", // Type de la route
"@id": "string", // ID des résultats de la question
"question": "string", // ID de la question
"weight": 0 // Pondération de la question
},
"score": 0, // Score de la question
"answered": true, // État de réponse à la question
"discordanceCount": 0, // Nombre de discordance à la question
"fatalResponded": "string" /// ???
},
}
]
}
],
"firstScore": "string", // Meilleure note à l'examen
"lastScore": "string", // Pire note à l'examen
"lastCorrectionDate": "string", // Dernière date de corretion
"firstCorrectionDate": "string" // Première date de correction
},
{
"@id": "string", // ID du participant
"@type": "string", // Type de la route
"additionalTime": 0, // État du temps additionnel
"status": 0, // Statut du participant
"placeNumber": 0, // Numéro de place du participant
"assessmentSessions": [],
"firstScore": "string", // Meilleure note
"lastScore": "string", // Pire note
"lastCorrectionDate": "string", // Dernière date de correction
"firstCorrectionDate": "string" // Première date de correction
},
],
"hydra:totalItems": 0, // Nombre total de participants
"hydra:view": {
"@id": "string", // ID du nombre de pages
"@type": "string", // Type de laroute
"hydra:first": "string", // Première page
"hydra:last": "string", // Dernière page
"hydra:next": "string" // Page suivante
},
"hydra:search": {
"@type": "string", // Type de la route
"hydra:template": "string", // Type de filtres utilisés
"hydra:variableRepresentation": "string", // Type de filtres utilisés
"hydra:mapping": [
{
"@type": "string", // Type de la route
"variable": "string", // Nom du filtre
"property": "string", // Nom du filtre
"required": "string" // État d'utilisation du filtre
}
]
}
GET /api/exams/{id}/questionnaire
Description :
Récupère les données concernant l’organisation des dossiers d’une autoévaluation appelée dans une session de formation.
Paramètres :
Id (string) : Identifiant de l’épreuve
Réponse :
{
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"hydra:member": [
{
"@id": "string", // ID du questionnaire
"@type": "string", // Type de la route
"questionFolders": [
{
"@id": "string", // ID du dossier questionnaire
"@type": "string", // Type de la route
"folder": {
"@id": "string", // ID du dossier
"@type": "string" // Type de la route
},
"position": 0 // Position du dossier dans l'examen
}
]
}
],
"hydra:totalItems": 0 // Nombre total de questionnaires
}