API – LMS

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",
  "@id": "string", // Id de l'élément
  "@type": "string", // Type de l'élément (= activityConfiguration)
  "title": "string", // Titre donné à l'activité
  "activityAlias": "string", // Alias du type d'activité (*)
  "configured": boolean // État de la configuration
}
				
			

* ActivityAlias <> Activité correspondante : 

  • activity_scorm <>  Activité SCORM
  • activity_self_assessment <>  Autoévaluation
  • activity_certificate <>  Certification
  • activity_webchat <>  Chat
  • activity_course <>  Cours
  • activity_collaborative_document <>  Document collaboratif
  • activity_survey <>  Enquête
  • activity_exam <>  Epreuve
  • activity_forum <>  Forum
  • activity_externallink <>  Lien externe
  • activity_in_person_lesson <>  Présentiel
  • activity_questions <>  Questions
  • activity_actbook <>  Recueil d’actes
  • activity_skilltreebook <>  Référentiel de compétences
  • activity_homework <>  Travaux
  • activity_mentoring <>  Tutorat
  • activity_webinar <>  Visioconférence

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 est 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 : 

				
					{
...
  "hydra:member": [
    {
      "@context": "string",
      "@id": "string", // Id de l'élément
      "@type": "string", // Type de l'élément (=LearningSessionActivity)
      "type": 0, // Type de la structure (0 : Parcours / 1 : Session de formation)
      "trainingProgram": "string", // Id du parcours
      "trainingProgramNode": { 
        "@context": "string",
        "@id": "string", // Id du noeud du parcours
        "@type": "string", // Type de l'élément (=TrainingProgramNode)
        "type": 0, // Type de noeud (*)
        "trainingProgram": "string", // Id du parcours
        "accessPeriodType": 0, // Période d'accès (**)
        "activityConfiguration": "string" // État de la configuration
      },
      "learningStartDate": "2023-08-21T13:17:02.650Z", // Date de début d'apprentissage de l'activité (Null si égale à la date de début de la session)
      "learningEndDate": "2023-08-21T13:17:02.650Z", // Date de fin d'apprentissage de l'activité (Null si égale à la date de début de la session)
      "accessPeriodType": 0, // Statut de la période d'accès
      "status": 0, // Statut de l'activité
      "parentGroup": "LearningSessionActivityGroup" // Affiche l'ensemble des éléments d'un groupe d'activité
    }
}
				
			

*Type

  • 0 : Sous-module
  • 1 : Groupe d’activités
  • 2 : activité
  • 4 : Dossier racine

 

**AccessPeriodType

  • 0 : Entre les dates d’apprentissage
  • 1 : A partir de la date de début d’apprentissage jusqu’à la fin de la session
  • 2 : Toujours accessible
  • 3 : Correspond aux dates de la session
GET /api/learning_session_activities/{id}/activity_instance

Description :

Récupère un ensemble de données d’une LearningSessionActivities 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.

On note que l’activité concernée doit être configurée.

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",
  "@id": "string", // Id de l'élément
  "@type": "string", // Type de l'élément (=LearningSessionSelfAssessmentActivityInstance)
  "selfAssesment": "string", //Id de l'autoévaluation
  "id": "string", // Id de l'élément LearningSessionSelfAssessmentActivityInstance
  "learningSessionActivity": "string", // Id de l'élément learningSessionActivity
  "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 une 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) : Chaine de caractères contenu dans l’identifiant complet de l’utilisateur ayant accédé aux activités (= « /api/users/28743″)

actor[] (array[string]) : Tableau des identifiants des utilisateurs ayant ayant accédé aux activités

createdAt[before] (string) : Dates inférieures ou égales pour lesquelles les utilisateurs ont accédé aux activités pour la première fois

createdAt[strictly_before] (string) : Dates strictement inférieures pour lesquelles les utilisateurs ont accédé aux activités pour la première fois

createdAt[after] (string) : Dates supérieures ou égales pour lesquelles les utilisateurs ont accédé aux activités pour la première fois

createdAt[strictly_after] (string) : Dates strictement supérieures pour lesquelles les utilisateurs ont accédé aux activités pour la première fois

updatedAt[before] (string) : Dates inférieures ou égales pour lesquelles les utilisateurs ont accédé aux activités pour la dernière fois

updatedAt[strictly_before] (string) : Dates strictement inférieures pour lesquelles les utilisateurs ont accédé aux activités pour la dernière fois

updatedAt[after] (string) : Dates supérieures ou égales pour lesquelles les utilisateurs ont accédé aux activités pour la dernière fois

updatedAt[strictly_after] (string) : Dates strictement supérieures pour lesquelles les utilisateurs ont accédé aux activités pour la dernière fois

page (integer) : 1 (valeur par défaut)

Réponse : 

				
					{
...
  "hydra:member": [ // 
    {
      "@id": "string", // Id de l'élément
      "@type": "string", // Type de l'élément (=LearningSessionActivityTimeTracking)
      "actor": "string", // Id de l'utilisateur
      "seconds": 0, // Durée de l'accès
      "createdAt": "2023-08-21T13:18:25.372Z", // Date et heure de premier accès
      "updatedAt": "2023-08-21T13:18:25.372Z" // Date et heure de dernier accès
    }
  ],
...
}
				
			

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.name (string) : Chaine de caractères contenu dans le nom de l’/les étiquettes

page (integer) : 1 (valeur par défaut)

Réponse : 

				
					{
...
  "hydra:member": [
    {
      "@id": "string", // Id de l'élément
      "@type": "string", // Type de l'élément (=TrainingProgram)
      "name": "string", // Nom du parcours
      "description": "string", // Description du parcours
      "type": 0, // Type du parcours (*)
      "tags": [
        {
          "@id": "string", // Id de l'étiquette
		      "@type": "string", // Type de l'élément (=Tag)
          "name": "string", // Nom de l'étiquette
          "category": "string" // Id de la catégorie de l'étiquette
        }
      ]
    }
  ],
...
}
				
			

*Type 

  • 0 : Créé au niveau du menu Apprentissage > Parcours
  • 1 : Créé au niveau d’une session de formation
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",
  "@id": "string", // Id de lélément
  "@type": "string", // Type de l'élément
  "name": "string", // Nom du parcours
  "description": "string", // Description du parcours
  "type": 0, // Type du parcours (*)
  "tags": [
    {
      "@id": "string", // Id de l'étiquette
      "@type": "string", // Type de l'élément (=Tag)
      "name": "string", // Nom de l'étiquette
      "category": "string" // Id de la catégorie de l'étiquette
    }
  ]
}
				
			

*Type 

  • 0 : Créé au niveau du menu Apprentissage > Parcours
  • 1 : Créé au niveau d’une session de formation

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 le champ « parent ».

Paramètres d’entrée : 

Id (string) : Identifiant du parcours.

page (integer) : 1 (valeur par défaut)

Réponse : 

				
					{
...
  "hydra:member": [
    {
      "@id": "string", // Id du noeud du parcours
      "@type": "string", // Type de l'élément (=TrainingProgramNode)
      "name": "string", // Nom du noeud
      "description": "string", // Description du noeud 
      "type": 0, // Type du noeud (*)
      "trainingProgram": "string", // Id du parcours
      "accessPeriodType": 0, // Statut de la période d'accès (**)
      "parent": "string", // Id de l'élément TrainingProgramNode parent
      "activityConfiguration": "ActivityConfiguration" // Affiche l'ensemble des éléments d'une configuration d'activité
    }
  ],
...
}
				
			

*Type

  • 0 : Sous-module
  • 1 : Groupe d’activités
  • 2 : activité
  • 4 : Dossier racine

 

**AccessPeriodType

  • 0 : Entre les dates d’apprentissage
  • 1 : A partir de la date de début d’apprentissage jusqu’à la fin de la session
  • 2 : Toujours accessible
  • 3 : Correspond aux dates de la session

3. Session de formation

GET /api/learning_sessions

Description :

Récupère des informations sur les sessions de formation présentes sur la plateforme, dont le nom, les dates, et l’état.

Paramètres d’entrée : 

name (string) : Chaine de caractères contenu dans le nom de la session

tags.name (string) : Chaine de caractères contenu dans le nom de l’/les étiquettes

startDate[before] (string) : Dates inférieures ou égales pour lesquelles des sessions débutent

startDate[strictly_before] (string) : Dates strictement inférieures pour lesquelles des sessions débutent

startDate[after] (string) : Dates supérieures ou égales pour lesquelles des sessions débutent

startDate[strictly_after] (string) : Dates strictement supérieures pour lesquelles des sessions débutent

endDate[before] (string) : Dates inférieures ou égales pour lesquelles des sessions se terminent

endDate[strictly_before] (string) : Dates strictement inférieures pour lesquelles des sessions se terminent

endDate[after] (string) : Dates supérieures ou égales pour lesquelles des sessions se terminent

endDate[strictly_after] (string) : Dates strictement supérieures pour lesquelles des sessions se terminent

Page (integer) : 1 (valeur par défaut)

Réponse : 

				
					{
...
  "hydra:member": [
    {
      "@id": "string", // Id de la session de formation
      "@type": "string", // Type de l'élément (=LearningSession)
      "name": "string", // Nom de la session de formation
      "startDate": "2023-08-21T13:22:00.364Z",  // Date de début de la session
      "endDate": "2023-08-21T13:22:00.364Z", // date de fin de la session
      "enabled": true, // Statut de la session (archivée ou non)
      "trainingPrograms": [
        "string" // Id du ou des parcours 
      ]
    }
  ],
...
}
				
			
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", // Id de la session
  "@type": "string", // Type de l'élément (=LearningSession)
  "name": "string", // Nom de la session
  "tags": [
    {
      "@id": "string", // Id de l'étiquette
      "@type": "string", // Type de l'élément (=Tag)
      "name": "string", // Nom de l'étiquette
      "category": "string" // Catégorie de l'étiquette
    }
  ],
  "startDate": "2023-09-18T15:38:50.757Z", // Date de début de la session
  "endDate": "2023-09-18T15:38:50.757Z", // Date de fin de la session
  "enabled": true, //Statut de la session (archivée ou non)
  "trainingPrograms": [
    {
      "@id": "string", // Id de l'élément
      "@type": "string", // Type de l'élément (=LearningSessionTrainingProgram)
      "trainingProgram": {
        "@id": "string", // Id du parcours
        "@type": "string", // Type de l'élément (=TrainingProgram)
        "tags": [
          {
              "@id": "string", // Id de l'étiquette
              "@type": "string", // Type de l'élément (=Tag)
              "name": "string", // Nom de l'étiquette
              "category": "string" // Catégorie de l'étiquette
          }
        ]
      },
      "position": 0 // Ordre du parcours dans la session
    }
  ]
}
				
			
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", // Nom de la session
  "tags": [
    {
      "name": "string", // Nom de l'étiquette
      "category": "string" // Catégorie de l'étiquette
    }
  ],
  "startDate": "2023-08-21T13:23:19.042Z", // Date de début de la session 
  "endDate": "2023-08-21T13:23:19.042Z", // Date de fin de la session
  "enabled": true // Statut de la session (archivée ou non)
}
				
			

Réponse : 

				
					{
  "@context": "string",
  "@id": "string", // Id de la session
  "@type": "string", // Type de l'élément (=LearningSession)
  "name": "string", // Nom de la session
  "tags": [
    {
      "@id": "string", // Id de l'étiquette
      "@type": "string", // Type de l'élément (=Tag)
      "name": "string", // Nom de l'étiquette
      "category": "string" // Catégorie de l'étiquette
    }
  ],
  "startDate": "2023-09-18T15:38:50.757Z", // Date de début de la session
  "endDate": "2023-09-18T15:38:50.757Z", // Date de fin de la session
  "enabled": true, //Statut de la session (archivée ou non)
  "trainingPrograms": [
    {
      "@id": "string", // Id de l'élément
      "@type": "string", // Type de l'élément (=LearningSessionTrainingProgram)
      "trainingProgram": {
        "@id": "string", // Id du parcours
        "@type": "string", // Type de l'élément (=TrainingProgram)
        "tags": [
          {
              "@id": "string", // Id de l'étiquette
              "@type": "string", // Type de l'élément (=Tag)
              "name": "string", // Nom de l'étiquette
              "category": "string" // Catégorie de l'étiquette
          }
        ]
      },
      "position": 0 // Ordre du parcours dans la session
    }
  ]
}
				
			
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 l'élément
      "@type": "string", // Type de l'élément (=LearningSessionActivity)
      "type": 0, // 0 pour un LearningSessionActivity
      "trainingProgramNode"
      {
        "@id": "string" //Id du noeud du parcours
        "@type": "string" //Type de l'élément (=TrainingProgramNode)
        "type": integer //Type de noeud (*)
        "trainingProgram": "string" //Id du parcours
        "accessPeriodType": integer (**)
        "activityConfiguration": 
        {
              "@id": "string", // Id de l'élément
              "@type": "string", // Type de l'élément (= activityConfiguration)
              "title": "string", // Titre de 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ébut d'apprentissage de l'activité (Null si égale à la date de début de la session)
      "learningEndDate": "2023-08-21T13:20:07.876Z", // Date de fin d'apprentissage de l'activité (Null si égale à la date de début de la session)
      "accessPeriodType": 0, // Période d'accès (**)
      "status": 0, // Statut de l'activité
      "parentGroup": 
        {
              "@id": "string", // Id de l'élément
              "@type": "string", // Type de l'élément (= LearningSessionActivityGroup)(=Groupe d'activités)
              "type": 1, // 1 pour un LearningSessionActivityGroup
              "trainingProgram": "string", // Identifiant de l'élément Training_programs
              "accessPeriodType": 0 // Période d'accès (**)
              "activityConfiguration": "string" // État de la configuration
        }
      ]
    }
  ],
...
}
				
			

*Type

  • 0 : Sous-module
  • 1 : Groupe d’activités
  • 2 : activité
  • 4 : Dossier racine

 

**AccessPeriodType

  • 0 : Entre les dates d’apprentissage
  • 1 : A partir de la date de début d’apprentissage jusqu’à la fin de la session
  • 2 : Toujours accessible
  • 3 : Correspond aux dates de la session
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) : Type exact de l’action

verb[] (array[string]) : Tableau des types exacts des actions

actor (string) : Chaine de caractères contenu dans l’identifiant complet de l’utilisateur ayant effectué des actions dans la session (= « /api/groups/28743″)

actor[] (array[string]) : Tableau des identifiants des utilisateurs ayant effectué différentes actions dans la session

relatedActor (string) :

relatedActor[] (array[string]) :

createdAt[before] (string) : Dates inférieures ou égales pour lesquelles des traces ont été enregistrées

createdAt[strictly_before] (string) : Dates strictement inférieures pour lesquelles des traces ont été enregistrées

createdAt[after] (string) : Dates supérieures ou égales pour lesquelles des traces ont été enregistrées

createdAt[strictly_after] (string) : Dates strictement supérieures pour lesquelles des traces ont été enregistrées

page (integer) : 1 (valeur par défaut)

Réponse :

				
					{
...
  "hydra:member": [
    {
      "@context": "string",
      "@id": "string", // Id de l'élément
      "@type": "string", // Type de l'élément (=LearningSessionActivityTrace)
      "id": integer, // Id de l'élément 
      "activity": "string", // Id de l'élément learning_session_activities
      "createdAt": "2023-08-21T13:25:18.360Z", // Date et heure de l'action de l'utilisateur
      "verb": "string", // Type d'action effectuée (*)
      "actor": "string", // Id de l'utilisateur
      "relatedActor": "string",
      "visibleByRelatedActor": true,
      "data": [
        "string" // Informations concernant l'action réalisée (Question posée, Cours consulté, Notes à l'autoévaluation,...)
      ] 
      ]
    }
  ],
...
}
				
			

* Verb :

  • accessed
  • terminated
  • responded
  • updated
  • saved
  • launched
  • scored
  • completed
  • exited
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 l'élément
      "@type": "string", // Type de l'élément (=LearnerGroup)
      "id": integer, // Id de l'élément
      "group": "string", // Id du groupe
      "learningSession": "string", // Id de la session de formation
      "mode": 0 // Mode d'inscription (0:Strict / 1:Non strict)
    }
  ],
...
}
				
			
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 l'élément
      "@type": "string", // Type de l'élément (=LearnerUser)
      "id": integer, // Id de l'élément
      "user": "string", // Id de l'utilisateur
      "learningSession": "string", // Id de la session de formation
      "registrationType": "string", // Type d'inscription (group ou classic)
      "enabled": true // Actif ou non dans la session
    }
  ],
...
}
				
			
POST /api/learning_sessions/{id}/learner_groups

Description :

Inscrit un groupe d’utilisateurs à une session de formation.

Paramètres d’entrée : 

Id (string) : Identifiant de l’épreuve

Corps de la requête :

				
					{
  "learnerGroups": [
    {
      "group": "string" //Id complet du groupe (Ex : /api/groups/28737)
    }
  ]
}
				
			

Réponse : 

				
					{
  "@context": "string",
  "@id": "string", // Id de la session
  "@type": "string", // Type de l'élément (=LearningSession)
  "learnerGroups": [
    {
      "@id": "string", // Id complet de l'élément learner_groups
      "@type": "string", // Type de l'élément (learnerGroups)
      "id": integer, // Id de l'élément learner_groups
      "group": "string" // Id du groupe
    }
  ]
}
				
			

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 activité d’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",
  "@id": "string", // Id de l'élément
  "@type": "string", // Type de l'élément (=SelfAssessment)
  "title": "string", // Titre de l'autoévaluation
  "assessmentOptions": {
    "@id": "string", // Id de l'élément
    "@type": "string", // Type de l'élément (=AssessmentOptions)
    "id": integrer, // Id de l'élément
    "maxSubmission": 0, // Nombre maximal de soumission
    "singleAssessmentSession": true,
    "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
  },
}
				
			
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) : Dates inférieures ou égales des dernières générations de copies corrigées (= »2023-09-20T15:55:59+00:00″)

lastCorrectionDate[strictly_before] (string) : Dates strictement inférieures des dernières générations de copies corrigées (= »2023-09-20T15:55:59+00:00″)

lastCorrectionDate[after] (string) : Dates supérieures ou égales des dernières générations de copies corrigées (= »2023-09-20T15:55:59+00:00″)

lastCorrectionDate[strictly_after] (string) : Dates strictement supérieures ou égales des dernières générations de copies corrigées (= »2023-09-20T15:55:59+00:00″)

user(string) : Chaine de caractères contenu dans l’identifiant complet de l’utilisateur ayant participé à l’épreuves (= « /api/groups/28743″)

user[] (array[string]) : Tableau des identifiants des utilisateurs ayant participé à l’épreuve

page (integer) : 1 (valeur par défaut)

itemsPerPage (integer) : 15 (valeur par défaut)

Réponse : 

				
					{
...
  "hydra:member": [
    {
      "@id": "string", // Id de l'élément
      "@type": "string", // Id du type (=AssessmentParticipant)
      "participantGroups": [],
      "user": "string", // Id de l'utilisateur
      "status": null,
    }
  ],
...
}
				
			
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.

On note que l’activité ne doit pas être « non publiée ».

Paramètres : 

Id (string) : Identifiant de l’élément self_assesment

lastCorrectionDate[before] (string) : Dates inférieures ou égales des dernières générations de copies corrigées (= »2023-09-20T15:55:59+00:00″)

lastCorrectionDate[strictly_before] (string) : Dates strictement inférieures des dernières générations de copies corrigées (= »2023-09-20T15:55:59+00:00″)

lastCorrectionDate[after] (string) : Dates supérieures ou égales des dernières générations de copies corrigées (= »2023-09-20T15:55:59+00:00″)

lastCorrectionDate[strictly_after] (string) : Dates strictement supérieures ou égales des dernières générations de copies corrigées (= »2023-09-20T15:55:59+00:00″)

user(string) : Chaine de caractères contenu dans l’identifiant complet de l’utilisateur ayant participé à l’épreuves (= « /api/groups/28743″)

user[] (array[string]) : Tableau des identifiants des utilisateurs ayant participé à l’épreuve

page (integer) : 1 (valeur par défaut)

itemsPerPage (integer) : 15 (valeur par défaut)

Réponse : 

				
					{
...
  "hydra:member": [
    {
      "@id": "/api/assessment_participants/8038682", // Id de l'élément
      "@type": "AssessmentParticipant", // Type de l'élément (=AssessmentParticipant)
      "assessmentSessions": [
        {
          "@id": "/api/assessment_sessions/6788553", // Id de l'élément
          "@type": "AssessmentSession", // Type de l'élément (=AssessmentSession)
          "status": 3,
          "createdAt": "2023-09-19T09:50:22", // Date et heure de création de l'autoévaluation
          "beginDate": "2023-09-19T09:50:22", // Date de départ de l'autoévaluation
          "endDate": "2023-09-19T09:50:27", // Date de soumission. null si la copie n'est pas soumise.
          "score": 1, // Note /1
          "questionFoldersResults": [
            {
              "@type": "QuestionFolderResultDto", // Type de l'élément (=QuestionFolderResultDto)
              "@id": "_:8632",  // Id de l'élément QuestionFolderResultDto
              "correctionConfiguration": {
                "@type": "QuestionFolderCorrectionConfigurationDto", // Type de l'élément (=QuestionFolderCorrectionConfigurationDto)
                "@id": "_:8650", // Id de l'élément QuestionFolderCorrectionConfigurationDto
                "questionnaireQuestionFolder": "/api/questionnaire_folders/134570", // Id de l'élément QuestionnaireFolder
                "weight": 1, // Pondération du dossier au sein de l'épreuve
                "markScheme": "sides3"
              },
              "questionResults": [
                {
                  "@type": "QuestionResultDto", // Type de l'élément (=QuestionResultDto)
                  "@id": "_:8675", // Id de l'élément QuestionResultDto
                  "correctionConfiguration": {
                    "@type": "QuestionCorrectionConfigurationDto", // Type de l'élément (=QuestionCorrectionConfigurationDto)
                    "@id": "_:8700", // Id de l'élément QuestionCorrectionConfigurationDto
                    "question": "/api/questions/1281808", // Id de la question
                    "weight": 1 // Pondération de la question dans l'épreuve
                  },
                  "score": 1, // Score obtenu /1 à la question
                  "answered": true, // État d'enregistrement de la réponse
                  "discordanceCount": 0, // Nombre de discordance à la question
                  "fatalResponded": null //participant a coché une case innaceptable ou indispensable
                }
              ]
            }
          ]
        }
      ],
      "firstScore": 1, // Score /1 à la  première réalisation 
      "lastScore": 1, // Score /1 à la  dernière réalisation 
      "lastCorrectionDate": "2023-09-19T09:50:28+00:00", // Date de dernière correction automatique (ou soumission) 
      "firstCorrectionDate": "2023-09-19T09:50:28+00:00", // Date de première correction automatique (ou soumission) 
      "status": null,
    }
  ],
...
}
				
			
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 : 

				
					{
...
  "hydra:member": [
    {
      "@id": "string", // Id de l'élément
      "@type": "string", // Type de l'élément (=Questionnaire)
      "questionFolders": [
        {
          "@id": "string", // Id du dossier dans l'autoévaluation
          "@type": "string", // Type de l'élément (=QuestionnaireFolder)
          "folder": {
            "@id": "string", // Id du dossier
            "@type": "string" // Type de l'élément (=QuestionFolder)
          },
          "position": 0 // Position du dossier dans l'examen
        }
      ]
    }
  ],
...
}
				
			

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", 
  "@id": "string", // Id de l'é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

user(string) : Chaine de caractères contenu dans l’identifiant complet de l’utilisateur ayant participé à l’épreuves (= « /api/groups/28743″)

user[] (array[string]) : Tableau des identifiants des utilisateurs ayant participé à l’épreuve

page (integer) : 1 (valeur par défaut)

itemsPerPage (integer) : 15 (valeur par défaut)

Réponse : 

				
					{
...
  "hydra:member": [
    {
      "@id": "string", // Id de l'élément
      "@type": "string", // Type de l'élément (=AssessmentParticipant)
      "participantGroups": [],
      "user": "string", // Id de l'utilisateur
      "status": null,
    }
  ],
...
}
				
			
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 : 

				
					{
...
  "hydra:member": [
    {
      "@id": "string", // Id de l'élément
      "@type": "string", // Type de l'élément (=Questionnaire)
      "questionFolders": [
        {
          "@id": "string", // Id du dossier dans l'enquête
          "@type": "string", // Type de l'élément (=QuestionnaireFolder)
          "folder": {
            "@id": "string", // Id du dossier
            "@type": "string" // Type de l'élément (=QuestionFolder)
          },
          "position": 0 // Position du dossier dans l'examen
        }
      ]
    }
  ],
...
}