Sessions des formations et événements (Lära)

Miro Lagueux

Modifié le : Mer, 15 Janv., 2025 à 12:51 H

TABLE DES MATIÈRES

SESSION DES FORMATIONS ET ÉVÉNEMENTS

Sessions : workspaceinstance/get

https://www.domaine.com/lmsapi/workspaceinstance/get

/workspaceinstance/get (request) - Requête d'une session d'une formation ou événement par identifiant

{
  "id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d"
}

/workspaceinstance/get (response) - Retourne un objet représentant une session pour une formation ou événement

{
  "id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d", 
  "workspaceId": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d"
  "creationDate": "0001-01-01T00:00:00",
  "websiteId": "V7y5yT3O8nuCDCdA1rE%2fxg%3d%3d",
  "name": "Ma formation", 
  "startDate": "0001-01-01T00:00:00", 
  "endDate": "0001-01-01T00:00:00", 
  "minParticipants": 0, 
  "maxParticipants": 0, 
  "isOverBookingSubscription": false,   
  "nbUsersSubbed": -1, 
  "nbUsersQueue": -1,
  "daysAvailable", 365,
  "daysToComplete", 180,
  "isHidden": false,
  "status": 0,
  “isFormula” : false,
  "locationId": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
  "createdByUserID": "%2fUtsC30QAPbKKJCD7cUkJA%3d%3d",
  "lastModificationDate": "0001-01-01T00:00:00",
  "taxEnabled": true,  
  "taxCountryId": 123,  
  "taxStateId": 321,
  "isPlannedActivityDisplayInCatalog": true,
  "gradingMode" : 0,
  "customFields": {
    "Champ1": "Snow",
    "Test": ""
  }
}

Description des champs

Nom	Obligatoire	Commentaires/description
id		Il s’agit de l’identifiant unique. Ce paramètre doit être vide en création, mais obligatoire en édition. (Type string)
workspaceId		Identifiant du workspace auquel la session est liée (Type string)
websiteId		Identifiant dans l'interface (Type string)
name		Nom de la session (Type string)
startDate		Date de début de la session. Important pour l’auto inscription et la visibilité au catalogue. (String YYYY-MM-DDTHH:MM:SSZ)
endDate		Date de fin de la session. Important pour l’auto inscription et la visibilité au catalogue. (String YYYY-MM-DDTHH:MM:SSZ)
maxParticipants		Ce paramètre vous permet de déterminer le nombre maximum de participants pour votre session. (Type Number)
minParticipants		Ce paramètre vous permet de déterminer le nombre minimum de participants pour votre session. (Type Number)
isOverBookingSubscription		Booléen permettant d’activer ou non la file d’attente pour votre session.
nbUsersSubbed		Valeur seulement disponible en GET permettant d’obtenir le nombre d'utilisateurs inscrits pour la session (Type Number)
nbUsersQueue		Valeur seulement disponible en GET permettant d’obtenir le nombre d'utilisateurs en file d'attente pour la session (Type Number)
creationDate		Valeur seulement disponible en GET permettant d’obtenir la date de création de la session. (String YYYY-MM-DDTHH:MM:SSZ)
daysAvailable		Détermine le nombre de jours après l’inscription d’un utilisateur où ce dernier a accès au contenu.
daysToComplete		Détermine le nombre de jours maximal après l’inscription d’un utilisateur où ce dernier doit avoir complété le contenu.
isHidden		Booléen permettant d’indiquer si la session est en mode « Cacher du catalogue » Valeur par défaut : false
status		Statut de la session. 0 = Actif 1 = Annulé 2 = Supprimé (Type Number)
IsFormula		Détermine si le mode « À la carte » est activé.
locationId		Identifiant de l’emplacement où se passe la session. Les activités en présences créées par le LMS utiliseront par défaut cet emplacement.
createdByUserID		Valeur en lecture seulement
lastModificationDate		Date de la dernière modification de la session Ne peut être modifié. Disponible sur get et getlist.
customFields		Champs sur mesure reliés à la formation/événement.
taxEnabled		Indique si les taxes sont activées sur la formation/événement. (Type Boolean)
taxCountryId		Chiffre indiquant le pays de la formation/événement. Type Number (Voir Annexe 3 : Pays et États/Provinces)
taxStateId		Chiffre indiquant l'état de la formation/événement. Type Number (Voir Annexe 3 : Pays et États/Provinces)
gradingMode		Mode de notation de la session 0 = Sur la session 1 = Sur les ressources (Type Number)
isPlannedActivityDisplayInCatalog		Permet d'afficher les activités planifiées ou non dans le catalogue sur la session.

Sessions : workspaceinstance/getlist

https://www.domaine.com/lmsapi/workspaceinstance/getlist

/workspaceinstance/getlist (request) - Requête de la liste des sessions d'une formation ou événement

{
  "id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
  "filterDate": "YYYY-MM-DDTHH:MM:SSZ",
  "filterEditDate": "YYYY-MM-DDTHH:MM:SSZ",
  "filterIncludeDisabled : true
}

ATTENTION : Le paramètre de filtre id est optionnel et représente l’identifiant de la formation de laquelle retourner les sessions.

Le paramètre de filtre filterDate est optionnel et correspond à la date de création de l’élément. La méthode retourne la liste des objets qui ont été créés après la date passée comme filtre.

(Date de création minimale) -String (YYYY-MM-DDTHH:MM:SSZ)

Le paramètre optionnel de filtre filterEditDate quant à lui, correspond à la date de dernière modification de l’élément. La méthode retourne la liste des objets qui ont été modifiés après la date passée comme filtre.

Une modification apportée à une session peut correspondre à :

Modification des paramètres administratifs de la session;

(Date de dernière modification) -String (YYYY-MM-DDTHH:MM:SSZ)

Les paramètres de filtre filterDate et filterEditDate peuvent être combinés afin d'obtenir autant les sessions créées ou modifiées depuis des dates précises.

Le paramètre filterIncludeDisabled est optionnel. Par défaut les sessions annulées ne sont pas incluses dans le retour de cet appel. La valeur true de ce paramètre permet d'inclure les sessions annulées.

/workspaceinstance/getlist (response) - Retourne une liste d'objets représentant chacune des sessions d’une formation ou événement

Sessions : workspaceinstance/getuserlist

https://www.domaine.com/lmsapi/workspaceinstance/getuserlist

/workspaceinstance/getuserlist (request) - Requête de la liste des utilisateurs inscrits à une session d’une formation ou événement

{
  "id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
  "filterDate": "YYYY-MM-DDTHH:MM:SSZ",
   "filterIncludeDisabled" : false
}

ATTENTION : Le paramètre de filtre par date est optionnel et correspond à la date de création de l’élément. La méthode retourne la liste des objets qui ont été créés après la date passée comme filtre.

Id = d’une session d’une formation ou événement (pas obligatoire) String
Filterdate = (pas obligatoire) (Date de création minimale) -String (YYYY-MM-DDTHH:MM:SSZ)

FilterIncludeDisabled = est optionnel.

Lorsque le paramètre n'est pas fourni, toutes les inscriptions dans une session active, et même les inscriptions annulées ("Désinscrit" et "Désactivé" ) sont incluses dans le retour de cet appel.
La valeur true permet d'avoir toutes les inscriptions dans une session même si elle est annulée.
La valeur false de ce paramètre permet d'exclure les inscriptions au statut "Désinscrit" et "Désactivé" seulement dans une session active

/workspaceinstance/getuserlist (response) - Retourne une liste d'objets représentant chacune des inscriptions d’une session d’une formation ou événement

[
  {
    "userId": "Jv3rHIZqqtZrVY0PIPSrlQ%3d%3d",
    "firstName": "John",
    "lastName": "Smith",
    "billingId": "FYDTzsHATli%2fHQ2O8Jsi7g%3d%3d",
    "status": 1,
    "creationDate": "2020-03-04T10:45:39.82",
    "subscriptionDate": "2020-03-04T10:45:39.82",
    "roleId": "O%2f9dsKKECyJSUWkOK37D8g%3d%3d",
    "provenance": 3
  },
  {
    "userId": "C4i4iN558zEjSMd61%2fo8qA%3d%3d",
    "firstName": "Peter",
    "lastName": "Jackman",
    "billingId": "kV2Jp00zjTFP7fG8ntfqCA%3d%3d",
    "status": 1,
    "creationDate": "2020-03-04T10:45:39.863",
    "subscriptionDate": "2020-03-04T10:45:39.863",
    "roleId": "O%2f9dsKKECyJSUWkOK37D8g%3d%3d",
    "provenance": 3
  },
  {
    "userId": "tA3yMUqx02%2b%2b%2fZcDHHR0tg%3d%3d",
    "firstName": "Joe",
    "lastName": "Johnson",
    "billingId": "l0zjIxBuxsjuZCHqTdbCmA%3d%3d",
    "status": 1,
    "creationDate": "2020-03-04T10:45:39.89",
    "subscriptionDate": "2020-03-04T10:45:39.89",
    "roleId": "O%2f9dsKKECyJSUWkOK37D8g%3d%3d",
    "provenance": 3
  }
]

Description des champs

Nom	Obligatoire	Commentaires/description
userId		Identifiant unique de l’utilisateur inscrit (Type string)
firstName		Prénom de l’utilisateur inscrit (Type string)
lastName		Nom de l’utilisateur inscrit (Type string)
billingId		Identifiant unique de la facturation d’inscription à la session. (Type string)
status		Statut de l’inscription 0 = Inactive 1 = Inscrit 2 = En attente 3 = Désinscrit 4 = Désactivé 5 = Transféré 6 = Expiré 7 = Non confirmé 8 = Expiré avec accès (Type Number)
creationDate		Date à laquelle l’inscription a été effectuée. (String YYYY-MM-DDTHH:MM:SSZ)
subscriptionDate		Date à laquelle l’inscription a été confirmée ou acceptée. (String YYYY-MM-DDTHH:MM:SSZ)
roleId		Identifiant du rôle de l’utilisateur inscrit. (Type String)
provenance		Provenance de l'inscription de l'utilisateur 0 = GroupSubscription 1 = BranchSubscription 2 = ManualSubscription 3 = SelfSubscription 4 = LotPurchaseSubscription 5 = ProgramSubscription 6 = AutoResubscription (Type Number)

Sessions : workspaceinstance/create

https://www.domaine.com/lmsapi/workspaceinstance/create

/workspaceinstance/create (request) - Requête de création d’une session

{
  "workspaceId": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d" 
  "name": "Ma formation", 
  "maxParticipants": 0, 
  "minParticipants": 0,
  "startDate": "0001-01-01T00:00:00", 
  "endDate": "0001-01-01T00:00:00", 
  "isOverBookingSubscription": false,   
  "isHidden": false,
  "locationId": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d"
  "customFields": {
    "Champ1": "Snow",
    "Test": ""
  }
}

/workspaceinstance/create (response) - Retourne l'identifiant de la session créée

{
  "id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d"
}

Sessions : workspaceinstance/edit

https://www.domaine.com/lmsapi/workspaceinstance/edit

/workspaceinstance/edit (request) - Requête d’édition d'une session

{
   "id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d", 
  "name": "Ma formation",
  "startDate": "0001-01-01T00:00:00", 
  "endDate": "0001-01-01T00:00:00", 
  "minParticipants": 0, 
  "maxParticipants": 0, 
  "isOverBookingSubscription": false,
  "daysAvailable", 365,
  "daysToComplete", 180,  
  "isHidden": false,
  “isFormula”: false,
  "locationId": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d"
  "customFields": {
    "Champ1": "Snow",
    "Test": ""
  }
}

ATTENTION : Seule la valeur id est obligatoires, les valeurs qui ne sont pas envoyées lors de l’édition ne sont simplement pas mises à jour.

/workspaceinstance/edit (response) - Retourne l'identifiant de la session modifiée

{
  "id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d"
}

Sessions : workspaceinstance/delete

https://www.domaine.com/lmsapi/workspaceinstance/delete

/workspaceinstance/delete (request) - Requête de suppression d'une session

{
  "id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d" 
}

/workspaceinstance/delete (response) - Retourne l'identifiant de la session supprimée

{
  "id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d"
}

Sessions : workspaceinstance/subscribeusers

https://www.domaine.com/lmsapi/workspaceinstance/subscribeusers

/workspaceinstance/subscribeusers (request) – Inscrire des utilisateurs dans une session

Un champ optionnel subscriptionDate existe lorsqu'on veut spécifier une date d'inscription en particulier. Si aucune n'est spécifiée (null), la date et l'heure actuelle va être utilisé.

{
  "id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
  "userIds": ["5G5hg343fggalp4JQ%3d%3d","7Z9345EWRTm7TQjdlQ%3d%3d"] ,
  "subscriptionDate": "2023-02-22T09:30:00.000"
}

/workspaceinstance/subscribeusers (response) - Retourne l'identifiant de la session dans laquelle l’utilisateur a été inscrit

{
  "id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d"
}

Sessions : workspaceinstance/subscribeuser

https://www.domaine.com/lmsapi/workspaceinstance/subscribeuser

/workspaceinstance/subscribeuser (request) – Inscrire un utilisateur dans une session

Un champ optionnel subscriptionDate existe lorsqu'on veut spécifier une date d'inscription en particulier. Si aucune n'est spécifiée (null), la date et l'heure actuelle va être utilisé.

{
  "id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
  "userId": "5G5hg343fggalp4JQ%3d%3d",
  "subscriptionDate": "2023-02-22T09:30:00.000" 
}

/workspaceinstance/subscribeuser (response) - Retourne l'identifiant d’inscription de l’utilisateur inscrit

{
  "id": "nlnugd98r7ge89gudh%3d%3d"
}

Sessions : workspaceinstance/getuserresourcecompletionlist

https://www.domaine.com/lmsapi/workspaceinstance/getuserresourcecompletionlist

/workspaceinstance/getuserresourcecompletionlist (request) – Requête la liste des détails de complétion des ressources d’une session de formation pour une inscription.

{
  "id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
  "workspaceInstanceId": "VJRRva0G1SLnlhn3vs7rQA%3d%3d"
}

ATTENTION : Seuls les détails sur les utilisateurs actifs sont retournés par l'API.

id = Identifiant d’une inscription d’un utilisateur (String)

workspaceInstanceId = Identifiant d’une session de formation (pas obligatoire). À utiliser lorsque le même identifiant d’inscription correspond à plus d’une session. Cela peut arriver lorsqu’une inscription est transférée à une autre session.

/workspaceinstance/getuserresourcecompletionlist (response) - Obtient la liste des détails de complétion des ressources d’une session de formation pour une inscriptions spécifique

[
    {
        "resourceId": "I8sAL3jQfx%2fuIAl%2bUCYFCw%3d%3d",
        "parentResourceId": null,
        "title": "Module_1",
        "resourceType": 6,
        "credits": 0.00,
        "categoryId": null,
        "adminCode": "",
        "creationDate": "2024-08-07T13:48:36.307",
        "dateCondition": null,
        "dateEndCondition": null,
        "minParticipants": 0,
        "maxParticipants": 0,
        "completionDate": "2024-08-16T17:42:46.497",
        "isCompleted": true,
        "isSuccess": true,
        "certificateID": null,
        "completionPoints": 8,
        "obtainedPoints": 8,
        "duration": 60,
        "sectionPosition": 1,
        "resourcePosition": 2,
        "sectionTitle": "Section par défaut",
        "moduleResources": [
            {
                "completionDate": "2024-08-16T17:42:57.703",
                "isCompleted": true,
                "obtainedPoints": 0,
                "duration": 20,
                "resourceId": "XM%2b%2fYiItTx0KO4UKfxu6yw%3d%3d",
                "title": "Module1_ress1",
                "resourceType": 1,
                "completionPoints": 0
            },
            {
                "isCompleted": false,
                "obtainedPoints": 0,
                "duration": 10,
                "resourceId": "6y%2f%2fxDcGBZzlKu5Z16grRQ%3d%3d",
                "title": "Module1_ress2",
                "resourceType": 1,
                "completionPoints": 0
            },
            {
                "completionDate": "2024-08-16T17:43:18.39",
                "isCompleted": true,
                "obtainedPoints": 0,
                "duration": 10,
                "resourceId": "YUwxqkTk7isY8AuE6JU9Vg%3d%3d",
                "title": "aaaa",
                "resourceType": 5,
                "completionPoints": 0
            },
            {
                "completionDate": "2024-08-16T17:43:25.37",
                "isCompleted": true,
                "obtainedPoints": 0,
                "duration": 10,
                "resourceId": "oRUSmxbMkPWLH5geOPdZDg%3d%3d",
                "title": "aqwer",
                "resourceType": 11,
                "completionPoints": 4
            },
            {
                "completionDate": "2024-08-16T17:45:17.757",
                "isCompleted": true,
                "obtainedPoints": 0,
                "duration": 10,
                "resourceId": "M0cWdYzMEWN63AdbRUBLYg%3d%3d",
                "title": "FORMATI F1",
                "resourceType": 11,
                "completionPoints": 123
            }
        ]
    },
    {
        "resourceId": "swtEd%2bKK9LodkzrX9xZy0Q%3d%3d",
        "parentResourceId": null,
        "title": "Module_2",
        "resourceType": 6,
        "credits": 0.00,
        "categoryId": null,
        "adminCode": "",
        "creationDate": "2024-08-08T12:30:40.633",
        "dateCondition": null,
        "dateEndCondition": null,
        "minParticipants": 0,
        "maxParticipants": 0,
        "completionDate": null,
        "isCompleted": false,
        "isSuccess": null,
        "certificateID": "Y0D0Wfz93PjzpVlnREnthg%3d%3d",
        "completionPoints": 0,
        "obtainedPoints": 0,
        "duration": 60,
        "sectionPosition": 1,
        "resourcePosition": 3,
        "sectionTitle": "Section par défaut",
        "moduleResources": [
            {
                "isCompleted": false,
                "obtainedPoints": 0,
                "duration": 20,
                "resourceId": "2QEH7NEzUYWjNC7yzCmklA%3d%3d",
                "title": "ress1_mod2",
                "resourceType": 11,
                "completionPoints": 0
            },
            {
                "isCompleted": false,
                "obtainedPoints": 0,
                "duration": 20,
                "resourceId": "QZVPmGCAY1UrEAHdR7SRvg%3d%3d",
                "title": "ress2",
                "resourceType": 1,
                "completionPoints": 0
            },
            {
                "isCompleted": false,
                "obtainedPoints": 6,
                "duration": 20,
                "resourceId": "Rz2PbnX0fb5e814CSBap2A%3d%3d",
                "title": "Capture d’écran 2024-06-05 161442FICHI",
                "resourceType": 1,
                "completionPoints": 8
            }
        ]
    },
    {
        "resourceId": "UQGnEhW0yJqMcfuEE8dgbQ%3d%3d",
        "parentResourceId": null,
        "title": "dépot1",
        "resourceType": 12,
        "credits": 0.00,
        "categoryId": null,
        "adminCode": "",
        "creationDate": "2024-08-08T12:32:08.543",
        "dateCondition": null,
        "dateEndCondition": null,
        "minParticipants": 0,
        "maxParticipants": 0,
        "completionDate": "2024-09-05T14:27:30.337",
        "isCompleted": true,
        "isSuccess": true,
        "certificateID": null,
        "completionPoints": 16,
        "obtainedPoints": 9,
        "duration": 20,
        "sectionPosition": 2,
        "resourcePosition": 1,
        "sectionTitle": "SECTIONDEUX"
    }
]

Description des champs

Nom	Commentaires/description
resourceId	Identifiant de la ressource (Type : String)
parentResourceId	Identifiant de la ressource parent de celle-ci Nulle si elle n’a pas de ressource parent. (Type : String)
resourceType	Type de la ressource 1 = Document (Word, Excel, PowerPoint, Vidéo, etc.) 2 = Activité Via HTML, Zoom ou Zoom Webinaire 3 = Activité en présence 4 = N.A. 5 = Sondage 6 = Module 7 = N.A. 8 = Objet SCORM 9 = Bloc de texte (aucune complétion possible) 10 = Questionnaire 11 = Questionnaire formatif 12 = Dépôt de travail 13 = Objet Moodle (Type : Number)
credits	Nombre de crédits obtenus par la complétion de cette ressource par l’inscrit (Type : Number)
adminCode	Code administratif de la ressource. (Type : String)
creationDate	Date de création de cette ressource. (String YYYY-MM-DDTHH:MM:SSZ)
dateCondition	Date à partir de laquelle la ressource est disponible. Nulle si non-définie. (String YYYY-MM-DDTHH:MM:SSZ)
dateEndCondition	Date à laquelle la ressource n’est plus disponible. Nulle si non-définie. (String YYYY-MM-DDTHH:MM:SSZ)
categoryId	Identifiant de la catégorie associé à cette ressource. (Type : String)
certificateId	Identifiant de la certification associé à cette ressource. (Type : String)
minParticipants	Nombre minimum de participants requis pour cette ressource ou activité. (Type : Integer)
maxParticipants	Nombre maximum de participants pour cette ressource ou activité. (Type : Integer)
completionDate	Date de complétion de cette ressource par l’inscrit. Nulle si la ressource n’est pas complétée. (String YYYY-MM-DDTHH:MM:SSZ)
isCompleted	Indique si la ressource est complétée. (Type : Boolean)
isSuccess	Indique si l’utilisateur a complété la ressource avec succès ou non. Nulle si non applicable pour ce type de ressource. (Type : Boolean)
completionPoints	Nombre de points à obtenir par la complétion de cette ressource par l'inscrit (Type : Number)
obtainedPoints	Nombre de points obtenus par l'inscrit pour cette ressource (Type : Integer)
duration	Nombre de temps en secondes que l'inscrit a été dans cette ressource (Type : Integer)
sectionPosition	Position de la section qui contient cette ressource (Type : Integer)
resourcePosition	resourcePosition Position de la ressource dans le contenu de la session (Type : Integer)
sectionTitle	Titre de la section de la ressource (Type : Integer)
moduleResources	Liste contenant les ressources contenues dans une ressource de type Module (Type : Liste)
moduleResources .completionDate	Date de complétion de la ressource dans le module par l’inscrit. N'est pas affichée si la ressource n’est pas complétée. (String YYYY-MM-DDTHH:MM:SSZ)
moduleResources .isCompleted	Indique si la ressource dans le module est complétée. (Type : Boolean)
moduleResources.resourceId	Identifiant unique de la ressource contenue dans le module (Type : String)
moduleResources.title	Titre de la ressource contenue dans le module (Type : String)
moduleResources.resourceType	Type de la ressource contenue dans le module (Type : String)
moduleResources.completionPoints	Points de complétion de la ressource contenue dans le module (Type : Number)
moduleResources.obtainedPoints	Nombre de points obtenus par l'inscrit pour cette ressource dans le module (Type : Integer)

Sessions : workspaceinstance/getresourcelist

https://www.domaine.com/lmsapi/workspaceinstance/getresourcelist

/workspaceinstance/getresourcelist (request) – Requête la liste des détails des ressources d’une session de formation

{
  "id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d"
}

/workspaceinstance/getresourcelist (response) - Obtient la liste des détails des ressources d’une session de formation

[
    {
        "resourceId": "jnKQkzdIDj6/4Ww+nspwPA==",
      "parentResourceId": "",
        "title": "Questionnaire noté",
        "resourceType": 10,
        "credits": 5.00,
        "adminCode": "",
        "creationDate": "2020-07-07T20:27:12.303",
        "dateCondition": null,
        "dateEndCondition": null,
        "categoryId" : null,
        "certificateId": null,
        "minParticipants": 0,
        "maxParticipants": 0,
        "completionPoints": 0,
        "sectionPosition": 1,
        "resourcePosition": 1,
        "sectionTitle": "Default section",
        "usersCompletion": [
         {
          "userId": 3mCrRAsA6ZEonpg234234xqc2VQA%3d%3d,
          "billingId": j9XoGU3mn7fvb45b5K7vuvsg9LQ%3d%3d,
          "isCompleted": false,
          "isSuccess": null
        },
        {
          "userId": PFjUV2AbVTMG3Ksdf56456EiPb1CkQ%3d%3d,
          "billingId": x9XNzlzm6b7w55h67s4idU%2f7NSOiew%3d%3d,
          "isCompleted": true,
          "isSuccess": true
        } 
      ]
    },
    {
        "resourceId": "Cjfode5wCmSAxDBPmxUH4w==",
      "parentResourceId": "",
        "title": "Classe virtuelle",
        "resourceType": 2,
        "credits": 3.00,
        "adminCode": "",
        "creationDate": "2020-05-06T19:29:04.76",
        "dateCondition": null,
        "dateEndCondition": null,
        "categoryId" : null,
        "minParticipants": 0,
        "maxParticipants": 0,
        "completionDate": "2020-07-07T20:21:28.113",
        "completionPoints": 0,
        "sectionPosition": 1,
        "resourcePosition": 2,
        "sectionTitle": "Default section",
        "usersCompletion": [
        {
          "userId": 3mCrRAsA6ZEonpg234234xqc2VQA%3d%3d,
          "billingId": j9XoGU3mn7fvb45b5K7vuvsg9LQ%3d%3d,
          "isCompleted": true,
          "isSuccess": true,
          "credits": 2.5
        },
        {
          "userId": PFjUV2AbVTMG3Ksdf56456EiPb1CkQ%3d%3d,
          "billingId": x9XNzlzm6b7w55h67s4idU%2f7NSOiew%3d%3d,
          "isCompleted": false,
          "isSuccess": null,
          "credits": 0
        } 
      ]
    },
    {
        "resourceId": "cbOYWAa343b5n4nvgnhb81aWrXptOTPwyEQ==",
      "parentResourceId": "",
        "title": "Module",
        "resourceType": 6,
        "credits": 3.00,
        "adminCode": "",
        "creationDate": "2020-05-06T19:28:12.707",
        "dateCondition": null,
        "dateEndCondition": null,
        "categoryId" : null,
        "minParticipants": 0,
        "maxParticipants": 0,
        "completionDate": null,
        "completionPoints": 0,
        "sectionPosition": 1,
        "resourcePosition": 3,
        "sectionTitle": "Default section",
        "usersCompletion": [],
         "moduleResources": [
            {
                "resourceId": "Q0dwYTCoGM5%2f6WtMIOSFSw%3d%3d",
                "title": "tom fencer",
                "resourceType": 1,
                "completionPoints": 0
            },
            {
                "resourceId": "xr%2bRMKQDAFtu0cUDzu%2bZvQ%3d%3d",
                "title": "hjkhjkhjk",
                "resourceType": 11,
                "completionPoints": 0
            }
        ]
    },
    {
        "resourceId": "hqoiLDqEj2UANHVVkVTkGg%3d%3d",
      "parentResourceId": "cbOYWAa343b5n4nvgnhb81aWrXptOTPwyEQ==",
        "title": "Sondage",
        "resourceType": 5,
        "credits": 3.00,
        "adminCode": "",
        "creationDate": "2020-05-06T19:28:12.707",
        "dateCondition": null,
        "dateEndCondition": null,
        "categoryId" : null,
        "minParticipants": 0,
        "maxParticipants": 0,
        "completionDate": null,
        "completionPoints": 0,
        "sectionPosition": 1,
        "resourcePosition": 4,
        "sectionTitle": "Default section",
        "usersCompletion": []
    }
]

Description des champs

Nom	Commentaires/description
resourceId	Identifiant de la ressource. (Type : String)
parentResourceId	Identifiant de la ressource parent de celle-ci. (Type : String)
resourceType	Type de la ressource 1 = Document (Word, Excel, PowerPoint, Vidéo, etc.) 2 = Activité Via HTML, Zoom ou Zoom Webinaire 3 = Activité en présence 4 = N.A. 5 = Sondage 6 = Module 7 = N.A. 8 = Objet SCORM 9 = Bloc de texte (aucune complétion possible) 10 = Questionnaire 11 = Questionnaire formatif 12 = Dépôt de travail 13 = Objet Moodle (Type : Number)
credits	Nombre de crédits obtenus par la complétion de cette ressource par l’inscrit. (Type : Number)
adminCode	Code administratif de la ressource. (Type : String)
creationDate	Date de création de cette ressource. (String YYYY-MM-DDTHH:MM:SSZ)
dateCondition	Date à partir de laquelle la ressource est disponible. Nulle si non-définie. (String YYYY-MM-DDTHH:MM:SSZ)
dateEndCondition	Date à laquelle la ressource n’est plus disponible. Nulle si non-définie. (String YYYY-MM-DDTHH:MM:SSZ)
minParticipants	Nombre minimum de participants requis pour cette ressource ou activité. (Type : Integer)
maxParticipants	Nombre maximum de participants pour cette ressource ou activité. (Type : Integer)
completionPoints	Nombre de points à obtenir par la complétion de cette ressource par l'inscrit (Type : Number)
sectionPosition	Position de la section qui contient cette ressource (Type : Integer)
resourcePosition	Position de la ressource dans le contenu de la session (Type : Integer)
sectionTitle	Titre de la section de la ressource (Type : Integer)
usersCompletion	Liste contenant la liste des utilisateurs qui ont accès a cette ressource ainsi que les informations de complétion sur celle-ci. (Type : Liste)
usersCompletion.userId	Identifiant unique de l’utilisateur. (Type : String)
usersCompletion.billingId	Identifiant unique de l’inscription de l’utilisateur. (Type : String)
usersCompletion.isCompleted	Indique si la ressource est complétée pour cet utilisateur. (Type : Boolean)
usersCompletion.isSuccess	Indique si l’utilisateur a complété la ressource avec succès ou non. Nulle si non applicable pour ce type de ressource. (Type : Boolean)
usersCompletion.credits	Nombre de crédits obtenus par l'utilisateur pour cette ressource (Type Number)
moduleResources	Liste contenant les ressources contenues dans une ressource de type Module (Type : Liste)
moduleResources.resourceId	Identifiant unique de la ressource (Type : String)
moduleResources.title	Titre de la ressource (Type : String)
moduleResources.resourceType	Type de la ressource (Type : Integer)
moduleResources.completionPoints	Points de completion de la ressource (Type : Number)

Sessions : workspaceinstance/getcompletion

https://www.domaine.com/lmsapi/workspaceinstance/getcompletion

/workspaceinstance/getcompletion (request) - Requête les détails de complétion d’une session de formation pour une inscription spécifique

{
  "id": "7Zi3zYvuHTZ7YsdfsdLK7TQjdlQ%3d%3d"
}

ATTENTION :

id = Identifiant d’une inscription d’un utilisateur (String)

/workspaceinstance/getcompletion (response) - Obtient les détails de complétion d’une session de formation pour une inscription spécifique

{
    "workspaceInstanceId": "svfshXWaAIeuJVsdfsdf92cr5fng%3d%3d",
    "userId": "S6QQM%2bgPrrasdasdkaqeKRgTudmQ%3d%3d",
    "billingId": "7Zi3zYvuHTZ7YsdfsdLK7TQjdlQ%3d%3d ",
    "completionDate": "2021-02-17T15:04:06.687",
    "manualCompletionDate": "2021-02-17T15:04:06.687",
    "modificationDate": "2021-02-17T15:04:06.687",
    "modifiedByUserId": "DR7sYn48%2asdasdfuzi3b4fTGZ1nQ%3d%3d",
    "isCompleted": true,
    "isSuccess": true,
    "certificateId": "",
    "progressionPercent": 100,
    "creditsObtained": 1.00
}

Description des champs

Nom	Commentaires/description
workspaceInstanceId	Identifiant de la session. (Type : String)
userId	Identifiant de l’utilisateur. (Type : String)
billingId	Identifiant de l’inscription de l’utilisateur. (Type : String)
completionDate	Date de completion de l’inscription. (String YYYY-MM-DDTHH:MM:SSZ)
manualCompletionDate	Date à laquel la complétion s’est effectué manuellement par un administrateur. Vide si complété autrement. (String YYYY-MM-DDTHH:MM:SSZ)
modificationDate	Dernière date de modification de la complétion. (String YYYY-MM-DDTHH:MM:SSZ)
modifiedByUserId	Identifiant de l’utilisateur ayant modifié la complétion manuellement. (Type : String)
isCompleted	Indique si la complétion de la session par l’utilisateur est faite. (Type : Boolean)
isSuccess	Indique si la complétion de la session par l’utilisateur est complétée avec echec ou succès. (Type : Boolean)
certificateId	Identifiant de certificat associé à la completion de l’inscription. (Type : String)
progressionPercent	Indique la progression de l’inscription dans la session. (Type : Number)
creditsObtained	Indique le nombre de crédits obtenus par l’utilisateur (Type Number)

Sessions : workspaceinstance/setcompletion

https://www.domaine.com/lmsapi/workspaceinstance/setcompletion

/workspaceinstance/setcompletion (request) - Modifie les détails de complétion d’une session de formation pour une inscription spécifique

{
  "id": "7Zi3zYvuHTZ7YsdfsddfgLK7TQjdlQ%3d%3d"
  "isCompleted": true,
  "isSuccess": true,
  "completionDate": "2021-02-17T15:04:06.687"
}

ATTENTION :
id : Identifiant d’une inscription d’un utilisateur (String)
IsCompleted : Indique si la complétion est faite. (Boolean)
IsSuccess (optionnel) : Indique si la complétion est avec succès ou echec, sinon avec succès est pris par défaut. (Boolean)
completionDate (optionnel) : Pour mettre une date spécifique de complétion sinon le moment où ça été fait sera utilisé

(Date)

/workspaceinstance/setcompletion (response) – Reçoit les détails de complétion suite à la modification

{
  "id": "7Zi3zYvuHTZ7YsdfsddfgLK7TQjdlQ%3d%3d"
  "isCompleted": true,
  "isSuccess": true,
  "completionDate": "2021-02-17T15:04:06.687"
}

Sessions : workspaceinstance/getcompletionlist

https://www.domaine.com/lmsapi/workspaceinstance/getcompletionlist

/workspaceinstance/getcompletionlist (request) - Obtenir la liste de complétion

{
    "filterId": "HHjmOri6Olr%2fCPfwPL9RYA%3d%3d",
    "filterDate" : "2020-06-23",
    "filterIndex": 1
}

Le paramètre de filtre par id "filterId" est optionnel et correspond à l’identifiant d’une session dont on veut obtenir la liste de complétions.

Le paramètre de filtre par date "filterDate" est optionnel et correspond à la dernière date de modification sur la complétion. La méthode retourne la liste des objets dont cette date est après la date passée comme filtre.

Le paramètre de filtre par index "filterIndex" est optionnel et correspond à une pagination de 200 complétions. La méthode retourne la liste de 200 objets selon l’index passé comme filtre.

Un filtre par index de 1 retourne les complétions 1 à 200 et un filtre par index de 2 retourne les inscriptions de 201 à 400.

Si le paramètre de filtre par index "filterIndex" n’est pas utilisé, le retour de cet appel ne contiendra qu’au maximum 100 éléments.

/workspaceinstance /getcompletionlist (response) – Retourne la liste de complétions

[
    {
        "workspaceInstanceId": "HHjmOri6Olr%2fCPfwPL9RYA%3d%3d",
        "userId": "fXUahxX%2fIwT8ZY2xvyYAIA%3d%3d",
        "billingId": "e0nKeBcWqr5855xBTXG5PQ%3d%3d",
        "completionDate": "2024-05-06T17:25:49.683",
        "manualCompletionDate": "2024-05-06T17:25:49.683",
        "modificationDate": "2024-05-06T17:25:49.72",
        "modifiedByUserId": "p8V%2fzu0l1%2f5NDo%2ftHpCEkQ%3d%3d",
        "isCompleted": true,
        "isSuccess": true,
        "certificateId": "",
        "progressionPercent": 0,
        "creditsObtained": 0.00
    },
    {
        "workspaceInstanceId": "HHjmOri6Olr%2fCPfwPL9RYA%3d%3d",
        "userId": "0UMoqf3eneEOXbfkyGXtcQ%3d%3d",
        "billingId": "CulZe4L%2bCfTGXKC2KdtdUg%3d%3d",
        "completionDate": "2024-05-03T09:45:54.913",
        "manualCompletionDate": "2024-05-03T09:45:54.913",
        "modificationDate": "2024-05-03T09:45:55.223",
        "modifiedByUserId": "p8V%2fzu0l1%2f5NDo%2ftHpCEkQ%3d%3d",
        "isCompleted": true,
        "isSuccess": true,
        "certificateId": "",
        "progressionPercent": 0,
        "creditsObtained": 0.00
    }
]

Description des codes d’erreurs des sessions de formation

Numéro	Message	Commentaires/description
500	Required id	Vous devez fournir un identifiant pour la formation et événement.
501	Invalid id	L’identifiant fourni pour la formation et événement est invalide.
502	Required type	Vous devez fournir un identifiant pour le type de la formation et événement.
503	Invalid type	L’identifiant fourni pour le type de la formation et événement n’est pas valide.
504	Required name	Vous devez fournir un nom pour la formation et événement.
505	Invalid name length	Le nom fourni pour la formation et événement doit contenir entre 5 à 250 caractères inclusivement.
506	Required minParticipants	Vous devez fournir une quantité minimum de participant.
507	Invalid minParticipants	La quantité minimum de participant fourni doit être supérieure ou égale à 0.
508	Required maxParticipants	Vous devez fournir une quantité maximum de participant.
509	Invalid maxParticipants	La quantité maximum de participant fourni doit être supérieure ou égale à 0.
510	Required subscriptionType	Vous devez fournir le type d’inscription.
511	Required isOverBookingSubscription	Vous devez fournir "True" ou "False".
512	Required authorizationType	Vous devez fournir le type d’autorisation des inscriptions.
513	Required visibilityType	Vous devez fournir le type de visibilité de la formation.
514	Required showAvailableSubscriptions	Vous devez fournir "True" ou "False".
515	Required accreditationNumber	Si l’autodéclaration est activée, vous devez fournir un numéro d’accréditation.
516	Invalid accreditationNumber length	Le numéro d’accréditation fourni est invalide.
517	Invalid userId	L’identifiant unique de l’utilisateur est invalide.
518	Required BillingID	L’identifiant d’inscription est requis pour l’appel à /workspaceinstance/getuserresourcecompletionlist.
519	Invalid BillingID	L’identifiant d’inscription fourni est invalide.
520	Invalid website id	L’identifiant de site web fourni est invalide.
521	Required isCompleted	Le paramètre indiquant la completion à assigner à l’inscription est requis.
522	Invalid gradingMode	La valeur fourni pour le mode de notation de la session est invalide.
523	Cannot edit gradingMode	Lorsqu'il y a des inscriptions sur la session, il est impossible de modifier cette valeur

French

SESSION DES FORMATIONS ET ÉVÉNEMENTS

Sessions : workspaceinstance/get

Sessions : workspaceinstance/getlist

Sessions : workspaceinstance/getuserlist

Sessions : workspaceinstance/create

Sessions : workspaceinstance/edit

Sessions : workspaceinstance/delete

Sessions : workspaceinstance/subscribeusers

Sessions : workspaceinstance/subscribeuser

Sessions : workspaceinstance/getuserresourcecompletionlist

Sessions : workspaceinstance/getresourcelist

Sessions : workspaceinstance/getcompletion

Sessions : workspaceinstance/setcompletion

Sessions : workspaceinstance/getcompletionlist

Description des codes d’erreurs des sessions de formation

Related Articles