Menu
1. Activités
1.1. ActivityConfiguration
GET /api/activity_configurations /{id}
Description :
Récupère un ensemble de données d’une ActivityConfiguration. Il s’agit d’un élément qui décrit la configuration d’une activité.
Paramètres d’entrée :
Id (string) : Identifiant de la configuration de l’activité (activityConfiguration). Cet élément peut être obtenu en appelant /api/learning_sessions/{id}/activities.
Réponse :
{
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route (= activityConfiguration)
"title": "string", // Titre donné à l'activité
"activityAlias": "string", // Alias du type d'activité
"configured": boolean // État de la configuration
}
1.2. LearningSessionActivity
GET /api/learning_session_activities/{id}
Description :
Récupère un ensemble de données d’une LearningSessionActivities. Il s’agit d’un élément qui composé d’une activité, de la configuration de cette activité ainsi que de sa planification. Une session de formation est composée de plusieurs LearningSessionActivities.
Paramètres d’entrée :
Id (string) : Identifiant de la LearningSessionActivities. Cet élément peut être obtenu en appelant /api/learning_sessions/{id}/activities.
Il est important de noter que cet identifiant n’est pas celui de la session de formation.
Réponse :
{
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"type": 0, // Type de l'activité
"trainingProgram": "string", // ID du programme d'entraînement
"trainingProgramNode": { // ID du noeud d'activité
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"type": 0, // Type de l'activité
"trainingProgram": "string", // ID du programme d'entraînement
"accessPeriodType": 0, // État de la période d'accès
"activityConfiguration": "string" // État de la configuration
},
"learningStartDate": "2023-08-21T13:17:02.650Z", // Date d'accès de l'activité
"learningEndDate": "2023-08-21T13:17:02.650Z", // Date de fin de l'activité
"accessPeriodType": 0, // État de la période d'accès
"status": 0, // Statut de l'activité
"parentGroup": "string" // Noeud supérieur dans l'activité
}
GET /api/learning_session_activities/{id}/activity_instance
Description :
Récupère un ensemble de données d’une LearningSessionActivites dont les identifiants de la configuration de l’activité et éventuellement l’identifiant de l’instance d’autoévaluation. Cette dernière permet d’obtenir, entre autres, les résultats des participants.
Paramètres d’entrée :
Id (string) : Identifiant de la LearningSessionActivities. Cet élément peut être obtenu en appelant /api/learning_sessions/{id}/activities.
Réponse :
{
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"selfAssesment": "string", //ID de l'instance d'autoévaluation
"id": "string", // ID de l'instance d'activité
"learningSessionActivity": "string", // ID de l'instance d'activité
"activityConfiguration": "string", // ID de la configuration de l'activité
}
GET /api/learning_session_activities/{id}/time_trackings
Description :
Récupère un ensemble de données concernant le temps passé par les étudiants sur chacune des activité qui compose la LearingSessionActivity.
Chaque accès d’un étudiant à l’activité va générer un élément de la collection.
Paramètres d’entrée :
Id (string) : Identifiant de la LearningSessionActivity
actor (string) :
actor[] (array[string]) :
createdAt[before] (string) :
createdAt[strictly_before] (string) :
createdAt[after] (string) :
createdAt[strictly_after] (string) :
updatedAt[before] (string) :
updatedAt[strictly_before] (string) :
updatedAt[after] (string) :
updatedAt[strictly_after] (string) :
page (integer) : 1 (valeur par défaut)
Réponse :
{
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "hydra:Collection","hydra:member": [ //
{
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"actor": "string", // Participants à l'activité
"seconds": 0, // Durée de l'accès
"createdAt": "2023-08-21T13:18:25.372Z", // Date et heure de l'accès
"updatedAt": "2023-08-21T13:18:25.372Z" // Date et heure de fin d'accès
}
],
"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", // Derniière page
"hydra:next": "string" // Page suivante
},
"hydra:search": { // Module des filtres
"@type": "string", // Type de la route
"hydra:template": "string", // Filtres
"hydra:variableRepresentation": "string", // Filtres
"hydra:mapping": [
{
"@type": "string", // Type de la route
"variable": "string", // Variable des filtres
"property": "string", // Variable des filtres
"required": true // État d'utilisation des filtres
}
]
}
}
2. Parcours d'activités
2.1. TrainingProgram
GET /api/training_programs
Description :
Récupère un ensemble de données lié aux parcours (TrainingProgram) présents sur la plateforme. Ces parcours peuvent être créés au niveau d’un menu dédié ou directement dans une session de formation. Ces éléments peuvent donc présenter le même nom qu’une session de formation.
Paramètres d’entrée :
tags (string) :
tags[] (array[string]) :
tags.name (string) :
page (integer) : 1 (valeur par défaut)
Réponse :
{
"@context": "string" //Nom de la route,
"@id": "sring" //Id de la route,
"@type": "hydra:Collection","hydra:member": [
{
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"name": "string", // Nom du programme d'entraînement
"description": "string", // Description du programme d'entraînement
"type": 0, // Type du programme
"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/training_programs/{id}
Description :
Récupère un ensemble de données lié à un parcours (TrainingProgram).
Paramètres d’entrée :
Id (string) : Identifiant du parcours d’activité.
Réponse :
{
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"name": "string", // Nom du programme d'entraînement
"description": "string", // Description du programme d'entraînement
"type": 0, // Type du programme
"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.2. TrainingProgramNode
GET /api/training_programs/{id}/nodes
Description :
Récupère un ensemble de données concernant les nœuds d’un parcours (TrainingProgram). Il s’agit des sous-modules qui compose le parcours. Le lien entre chaque élément est assuré par « parent ».
Paramètres d’entrée :
Id (string) : Identifiant du parcours.
page (integer) : 1 (valeur par défaut)
Réponse :
{
"@context": "string" //Nom de la route
"@id": "string" //ID de la route
"@type": "hydra:Collection",
"hydra:member": [
{
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"id": 0, // ID
"name": "string", // Nom du noeud d'activité
"description": "string", // Description du noeud d'activité
"type": 0, // Type du noeud d'activité
"trainingProgram": "string", // ID du programme d'entrainement
"accessPeriodType": 0, // Caractérisation de la période d'accès
"root": "string", // Dossier root
"parent": "string", // Dossier parent
"activityConfiguration": "string" // Option de configuration d'activité
}
],
"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
}
]
}
}
3. Session de formation
GET /api/learning_sessions
Description :
Récupère des informations sur des sessions de formation présentes sur la plateforme, dont le nom, les dates, et l’état.
Paramètres d’entrée :
name (string) :
tags (string) :
tags[] (array[string]) :
tags.name (string) :
startDate[before] (string) :
startDate[strictly_before] (string) :
startDate[after] (string) :
startDate[strictly_after] (string) :
endDate[before] (string) :
endDate[strictly_before] (string) :
endDate[after] (string) :
endDate[strictly_after] (string) :
Page (integer) : 1 (valeur par défaut)
Réponse :
{
"hydra:member": [
{
"@id": "string", // ID de la session de formation
"@type": "string", // Type de la session de formation
"name": "string", // Nom de la session de formation
"startDate": "2023-08-21T13:22:00.364Z", // Date de départ de la session
"endDate": "2023-08-21T13:22:00.364Z", // Fate de fin de la session
"enabled": true, // État d'utilisation de la session
"trainingPrograms": [
"string" // ID du programme d'entraînement utilisé
]
}
],
"hydra:totalItems": 0, // Nombre total de sessions
"hydra:view": { // Module pour les 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 iltres
"@type": "string", // type de la route
"hydra:template": "string", // Filtres
"hydra:variableRepresentation": "string", // Filtres
"hydra:mapping": [
{
"@type": "string", // Type de la route
"variable": "string", // Variable de filtre
"property": "string", // Variable de filtre
"required": true // État d'utilisation des filtres
}
]
}
}
GET /api/learning_sessions/{id}
Description :
Récupère des informations sur une des sessions de formation.
Paramètres d’entrée :
Id (string) : Identifiant de la session de formation
Réponse :
{
"@context": "string",
"@id": "string",
"@type": "string",
"name": "string",
"tags": [
{
"@context": "string",
"@id": "string",
"@type": "string",
"name": "string",
"category": "string"
}
],
"startDate": "2023-09-18T15:38:50.757Z",
"endDate": "2023-09-18T15:38:50.757Z",
"enabled": true,
"trainingPrograms": [
{
"@context": "string",
"@id": "string",
"@type": "string",
"trainingProgram": {
"@context": "string",
"@id": "string",
"@type": "string",
"tags": [
{
"@context": "string",
"@id": "string",
"@type": "string",
"name": "string",
"category": "string"
}
]
},
"startDate": "2023-09-18T15:38:50.757Z",
"position": 0
}
]
}
PATCH /api/learning_sessions/{id}
Description :
Met à jour les dates d’ouverture, le statut, le nom ainsi que les étiquettes d’une session de formation.
Paramètres d’entrée :
Id (string) : Identifiant de la session de formation
Corps de la requête :
{
"name": "string",
"tags": [
{
"name": "string",
"category": "string"
}
],
"startDate": "2023-08-21T13:23:19.042Z",
"endDate": "2023-08-21T13:23:19.042Z",
"enabled": true
}
Réponse :
{
"@context": "string",
"@id": "string",
"@type": "string",
"name": "string",
"tags": [
{
"@context": "string",
"@id": "string",
"@type": "string",
"name": "string",
"category": "string"
}
],
"startDate": "2023-09-18T15:44:51.604Z",
"endDate": "2023-09-18T15:44:51.604Z",
"enabled": true,
"trainingPrograms": [
{
"@context": "string",
"@id": "string",
"@type": "string",
"trainingProgram": {
"@context": "string",
"@id": "string",
"@type": "string",
"tags": [
{
"@context": "string",
"@id": "string",
"@type": "string",
"name": "string",
"category": "string"
}
]
},
"startDate": "2023-09-18T15:44:51.604Z",
"position": 0
}
]
}
GET /api/learning_sessions/{id}/activities
Description :
Récupère la liste des activités ainsi que leur position dans l’arborescence d’une session de formation. Si une planification est configurée, alors les dates d’apprentissage et la période d’accès à l’activité sont renseignées (sinon null)
Paramètres d’entrée :
Id (string) : Identifiant de la session de formation
page (integer) : 1 (valeur par défaut)
Réponse :
{
"hydra:member": [
{
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"id": 0, // ID de l'activité
"type": 0, // Type de l'activité
"trainingProgramNode"
{
"@id": "string" //Identifiant du noeud du parcours
"@type": "string" //Type de l'élément (=TrainingProgramNode)
"type": "integer" //Type de noeud
"trainingProgram": "string" //Identifiant du parcours
"accessPeriodType": "integer" //Type de période d'accès
"activityConfiguration":
{
"@id": "string", // ID de la route
"@type": "string", // Type de la route (= activityConfiguration)
"title": "string", // Titre donné à l'activité
"activityAlias": "string", // Alias du type d'activité
"configured": boolean // État de la configuration
}
"learningStartDate": "2023-08-21T13:20:07.876Z", // Date de départ
"learningEndDate": "2023-08-21T13:20:07.876Z", // Date de fin
"accessPeriodType": 0, // Période d'accès
"status": 0, // Statut
"parentGroup": "string", // Groupe parenté affilité
"activityInstance": "string", // Présence ou non d'instance d'activité
"timeTrackings": [
"string" // Présence ou non de compteur
]
}
],
"hydra:totalItems": 0, // Nombre total d'activité
"hydra:view": { // Module pour les 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 de filtres
"@type": "string", // Type de la route
"hydra:template": "string", // Filtre
"hydra:variableRepresentation": "string", // Filtre
"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/learning_sessions/{id}/activities_traces
Description :
Récupère un ensemble de données sur les traces d’apprentissage des étudiants d’une session de formation.
Paramètres d’entrée :
Id (string) : Identifiant de la session de formation
verb (string) :
verb[] (array[string]) :
actor (string) :
actor[] (array[string]) :
relatedActor (string) :
relatedActor[] (array[string]) :
createdAt[before] (string) :
createdAt[strictly_before] (string) :
createdAt[after] (string) :
createdAt[strictly_after] (string) :
page (integer) : 1 (valeur par défaut)
Réponse :
{
"hydra:member": [
{
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"id": 0, // ID
"activity": "string", // ID de l'activité
"createdAt": "2023-08-21T13:25:18.360Z", // Date et heure de l'action de l'utilisateur
"verb": "string", // Dernière action effectuée
"actor": "string", // Par qui elle a été effectuée
"relatedActor": "string", // Quelle autre personne elle implique
"visibleByRelatedActor": true, // Accessible à l'autre personne
"data": [
"string" // Données concernant les traces de l'activité
]
}
],
"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/learning_sessions/{id}/learner_groups
Description :
Récupère un ensemble de données sur les participants inscrits par groupe à une session de formation. Aucun item ne sera renvoyé si les inscriptions sont réalisées individuellement.
Paramètres d’entrée :
Id (string) : Identifiant de la session de formation
page (integer) : 1 (valeur par défaut)
Réponse :
{
"hydra:member": [
{
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"id": 0, // ID de l'élément LearnerGroup
"group": "string", // Identifiant du groupe
"learningSession": "string", // Session de formation effectée
"mode": 0 // Mode utilisée
}
],
"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/learning_sessions/{id}/learner_users
Description :
Récupère un ensemble de données sur les participants inscrits à une session de formation. Il peut s’agir d’utilisateurs inscrits de manière individuelle ou par groupe.
Paramètres d’entrée :
Id (string) : Identifiant de la session de formation
page (integer) : 1 (valeur par défaut)
Réponse :
{
"hydra:member": [
{
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"id": 0, // ID de l'élément LearnerUser
"user": "string", // Utilisateur concerné
"learningSession": "string", // Session de formation concernée
"registrationType": "string", // Type d'enregistrement à la session
"enabled": true // Autorisation
}
],
"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 filtres
"@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
}
]
}
}
4. Autoévaluations
GET /api/self_assessments/{id}
Description :
Récupère un ensemble de données, comme les informations de configuration, d’une autoévaluation appelée dans une session de formation.
Paramètres :
Id (string) : Identifiant de l’élément self_assesment disponible en appelant /api/learning_session_activities/{id}/activity_instance.
Il est important de noter que cet identifiant ne correspond pas à celui des autoévaluations de la plateforme mais bien à l’entité self_assesment qui identifie cette autoévaluation au sein de la session.
Réponse :
{
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"title": "string", // Titre de l'autoévaluation
"assessmentOptions": {
"@context": "string", // Nom de la route
"@id": "string", // ID de la route
"@type": "string", // Type de la route
"id": 0, // ID
"maxSubmission": 0, // Nombre de soumission maximal
"singleAssessmentSession": true, // Option de passage unique
"randomQuestionsDisplay": true, // Option de l'affichage aléatoire des questions
"randomChoicesDisplay": true, // Option de l'affichage aléatoire des choix de réponses
"timeLimit": 0, // Limite de temps, exprimée en seconde
"allowCalculator": true // Option de l'utilisation de la calculatrice
},
"anticheatEnabled": true // Option de l'anti-triche
}
GET /api/self_assessments/{id}/participants
Description :
Récupère un ensemble d’informations concernant les participants à une autoévaluation présente dans une certaine session de formation. Toutes les personnes ayant accédé à son autoévaluation sont considérées comme participantes. Elles n’ont donc pas forcément enregistré des réponses ou soumis leur copie.
Paramètres :
Id (string) : Identifiant de l’élément self_assesment
lastCorrectionDate[before] (string) :
lastCorrectionDate[strictly_before] (string) :
lastCorrectionDate[after] (string) :
lastCorrectionDate[strictly_after] (string) :
user(string) :
user[] (array[string]) :
page (integer) : 1 (valeur par défaut)
itemsPerPage (integer) : 15 (valeur par défaut)
Réponse :
{
"@context": "string",
"@id": "string",
"@type": "string"
"hydra:member": [
{
"@id": "string",
"@type": "string",
"participantGroups": [],
"user": "string",
"additionalTime": null,
"status": null,
"placeNumber": null
}
],
"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/self_assessments/{id}/participants_results
Description :
Récupère un ensemble de données concernant les résultats des participants à une autoévaluation.
Paramètres :
Id (string) : Identifiant de l’élément self_assesment
lastCorrectionDate[before] (string) :
lastCorrectionDate[strictly_before] (string) :
lastCorrectionDate[after] (string) :
lastCorrectionDate[strictly_after] (string) :
user(string) :
user[] (array[string]) :
page (integer) : 1 (valeur par défaut)
itemsPerPage (integer) : 15 (valeur par défaut)
Réponse :
{
"@context": "/api/contexts/AssessmentParticipant",
"@id": "/api/self_assessments/153320/participants",
"@type": "hydra:Collection",
"hydra:member": [
{
"@id": "/api/assessment_participants/8038682",
"@type": "AssessmentParticipant",
"assessmentSessions": [
{
"@id": "/api/assessment_sessions/6788553",
"@type": "AssessmentSession",
"status": 3,
"createdAt": "2023-09-19T09:50:22",
"beginDate": "2023-09-19T09:50:22",
"endDate": "2023-09-19T09:50:27",
"score": 1,
"questionFoldersResults": [
{
"@type": "QuestionFolderResultDto",
"@id": "_:8632",
"correctionConfiguration": {
"@type": "QuestionFolderCorrectionConfigurationDto",
"@id": "_:8650",
"questionnaireQuestionFolder": "/api/questionnaire_folders/134570",
"weight": 1,
"markScheme": "sides3"
},
"questionResults": [
{
"@type": "QuestionResultDto",
"@id": "_:8675",
"correctionConfiguration": {
"@type": "QuestionCorrectionConfigurationDto",
"@id": "_:8700",
"question": "/api/questions/1281808",
"weight": 1
},
"score": 1,
"answered": true,
"discordanceCount": 0,
"fatalResponded": null
}
]
}
]
}
],
"firstScore": 1,
"lastScore": 1,
"lastCorrectionDate": "2023-09-19T09:50:28+00:00",
"firstCorrectionDate": "2023-09-19T09:50:28+00:00",
"additionalTime": null,
"status": null,
"placeNumber": null
}
],
"hydra:totalItems": 0,
"hydra:view": {
"@id": "string",
"@type": "string",
"hydra:first": "string",
"hydra:last": "string",
"hydra:next": "string"
},
"hydra:search": {
"@type": "string",
"hydra:template": "string",
"hydra:variableRepresentation": "string",
"hydra:mapping": [
{
"@type": "string",
"variable": "string",
"property": "string",
"required": true
}
]
}
}
GET /api/self_assessments/{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’élément self_assessment
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
}
5. Enquêtes
GET /api/survey_assessments/{id}
Description :
Récupère un ensemble de données d’une enquête appelée dans une session de formation.
Paramètres d’entrée :
Id (string) : Identifiant de l’élément SurveyAssessment.
Afin d’obtenir cet élément, il est important d’utiliser /api/learning_sessions/{id}/activities puis /api/learning_session_activities/{id}/activity_instance.
Réponse :
{
"@context": "string", // Nom de la route
"@id": "string", // ID de l'a route'élément
"@type": "string", // Type de l'élément (=SurveyAssessment)
"title": "string" // Titre de l'enquête appelée dans la session
}
GET /api/survey_assessments/{id}/participants
Description :
Récupère un ensemble de données concernant l’ensemble des participants à une enquête appelée dans une session de formation.
Paramètres :
Id (string) : Identifiant de l’élément self_assesment
lastCorrectionDate[before] (string) :
lastCorrectionDate[strictly_before] (string) :
lastCorrectionDate[after] (string) :
lastCorrectionDate[strictly_after] (string) :
user(string) :
user[] (array[string]) :
page (integer) : 1 (valeur par défaut)
itemsPerPage (integer) : 15 (valeur par défaut)
Réponse :
{
"@context": "string",
"@id": "string",
"@type": "string"
"hydra:member": [
{
"@id": "string",
"@type": "string",
"participantGroups": [],
"user": "string",
"additionalTime": null,
"status": null,
"placeNumber": null
}
],
"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/survey_assessments/{id}/questionnaire
Description :
Récupère les données concernant l’organisation des dossiers d’une enquête appelée dans une session de formation.
Paramètres :
Id (string) : Identifiant de l’élément self_assesment
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
}