
SESSION DES FORMATIONS ET ÉVÉNEMENTS
Une « session » est une occurrence datée d'une formation ou d'un événement, à laquelle les utilisateurs s'inscrivent et dont la complétion est suivie. Une session dans l'API est nommée « workspaceinstance ». | ![]() |
Sessions : workspaceinstance/get
https://www.domaine.com/lmsapi/workspaceinstance/get
![]() | Retourne un objet représentant une session d'une formation ou événement. |
Requête
Exemple de contenu d'appel de requête des informations pour une session :
{
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d"
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| id | X | Identifiant unique de la session. (Type string) |
Réponse
Exemple de contenu d'appel de réponse des informations pour une session :
{
"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 | Commentaires/description |
| id | Il s’agit de l’identifiant unique de la session. (Type string) |
| workspaceId | Identifiant du workspace auquel la session est liée. (Type string) |
| websiteId | Identifiant dans l'interface. (Type string) |
| creationDate | Valeur seulement disponible en GET permettant d’obtenir la date de création de la session. (String YYYY-MM-DDTHH:MM:SSZ) |
| 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) |
| minParticipants | Nombre minimum de participants pour votre session. (Type Number) |
| maxParticipants | Nombre maximum de participants pour votre session. (Type Number) |
| isOverBookingSubscription | Booléen permettant d’activer ou non la file d’attente pour votre session. (Type Boolean) |
| 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) |
| daysAvailable | Détermine le nombre de jours après l’inscription d’un utilisateur où ce dernier a accès au contenu. (Type Number) |
| daysToComplete | Détermine le nombre de jours maximal après l’inscription d’un utilisateur où ce dernier doit avoir complété le contenu. (Type Number) |
| isHidden | Booléen permettant d’indiquer si la session est en mode « Cacher du catalogue ». Valeur par défaut : false (Type Boolean) |
| status | Statut de la session.
|
| isFormula | Détermine si le mode « À la carte » est activé. (Type Boolean) |
| locationId | Identifiant de l’emplacement où se passe la session. Les activités en présence créées par le LMS utiliseront par défaut cet emplacement. (Type string) |
| createdByUserID | Identifiant de l’utilisateur ayant créé la session. Valeur en lecture seulement. (Type string) |
| lastModificationDate | Date de la dernière modification de la session. Ne peut être modifié. Disponible sur get et getlist. (String YYYY-MM-DDTHH:MM:SSZ) |
| 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) |
| isPlannedActivityDisplayInCatalog | Permet d'afficher les activités planifiées ou non dans le catalogue sur la session. (Type Boolean) |
| gradingMode | Mode de notation de la session.
|
| customFields | Champs sur mesure reliés à la formation/événement. |
Sessions : workspaceinstance/getlist
https://www.domaine.com/lmsapi/workspaceinstance/getlist
![]() | Retourne la liste des sessions d'une formation ou événement. |
Requête
Exemple de contenu d'appel de requête de la liste des sessions :
{
"id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
"filterDate": "YYYY-MM-DDTHH:MM:SSZ",
"filterEditDate": "YYYY-MM-DDTHH:MM:SSZ",
"filterIncludeDisabled": true
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| id | Paramètre optionnel représentant l’identifiant de la formation de laquelle retourner les sessions. (Type string) | |
| filterDate | Paramètre optionnel correspondant à 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. (String YYYY-MM-DDTHH:MM:SSZ) | |
| filterEditDate | Paramètre optionnel correspondant à la date de dernière modification de l’élément. Une modification apportée à une session peut correspondre à :
(String YYYY-MM-DDTHH:MM:SSZ) | |
| filterIncludeDisabled | Paramètre optionnel. Par défaut les sessions annulées ne sont pas incluses dans le retour de cet appel. La valeur true permet d'inclure les sessions annulées. (Type Boolean) |
Réponse
Exemple de contenu d'appel de réponse de la liste des sessions :
[
{
"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",
"gradingMode": 0
}
]Description des champs
| Nom | Commentaires/description |
| id | Il s’agit de l’identifiant unique de la session. (Type string) |
| workspaceId | Identifiant du workspace auquel la session est liée. (Type string) |
| websiteId | Identifiant dans l'interface. (Type string) |
| creationDate | Valeur seulement disponible en GET permettant d’obtenir la date de création de la session. (String YYYY-MM-DDTHH:MM:SSZ) |
| 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) |
| minParticipants | Nombre minimum de participants pour votre session. (Type Number) |
| maxParticipants | Nombre maximum de participants pour votre session. (Type Number) |
| isOverBookingSubscription | Booléen permettant d’activer ou non la file d’attente pour votre session. (Type Boolean) |
| 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) |
| daysAvailable | Détermine le nombre de jours après l’inscription d’un utilisateur où ce dernier a accès au contenu. (Type Number) |
| daysToComplete | Détermine le nombre de jours maximal après l’inscription d’un utilisateur où ce dernier doit avoir complété le contenu. (Type Number) |
| isHidden | Booléen permettant d’indiquer si la session est en mode « Cacher du catalogue ». Valeur par défaut : false (Type Boolean) |
| status | Statut de la session.
|
| isFormula | Détermine si le mode « À la carte » est activé. (Type Boolean) |
| locationId | Identifiant de l’emplacement où se passe la session. Les activités en présence créées par le LMS utiliseront par défaut cet emplacement. (Type string) |
| createdByUserID | Identifiant de l’utilisateur ayant créé la session. Valeur en lecture seulement. (Type string) |
| lastModificationDate | Date de la dernière modification de la session. Ne peut être modifié. Disponible sur get et getlist. (String YYYY-MM-DDTHH:MM:SSZ) |
| 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) |
| isPlannedActivityDisplayInCatalog | Permet d'afficher les activités planifiées ou non dans le catalogue sur la session. (Type Boolean) |
| gradingMode | Mode de notation de la session.
|
| customFields | Champs sur mesure reliés à la formation/événement. |
Sessions : workspaceinstance/getuserlist
https://www.domaine.com/lmsapi/workspaceinstance/getuserlist
![]() | Retourne la liste des utilisateurs inscrits à une session d'une formation ou événement. |
Requête
Exemple de contenu d'appel de requête de la liste des utilisateurs inscrits à une session :
{
"id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
"filterDate": "YYYY-MM-DDTHH:MM:SSZ",
"filterIncludeDisabled" : false
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| id | Identifiant d’une session d’une formation ou événement. (Type string) | |
| filterDate | Paramètre optionnel correspondant à 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. (String YYYY-MM-DDTHH:MM:SSZ) | |
| filterIncludeDisabled | Paramètre optionnel.
|
Réponse
Exemple de contenu d'appel de réponse de la liste des utilisateurs inscrits à une session :
[
{
"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 | 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
(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
|
Sessions : workspaceinstance/create
https://www.domaine.com/lmsapi/workspaceinstance/create
![]() | Permet de créer une session pour une formation ou un événement. |
Requête
Exemple de contenu d'appel de 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": ""
}
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| workspaceId | X | Identifiant du workspace auquel la session est liée. (Type string) |
| name | X | Nom de la session. (Type string) |
| maxParticipants | X | Nombre maximum de participants pour votre session. (Type Number) |
| minParticipants | X | Nombre minimum de participants pour votre session. (Type Number) |
| startDate | Date de début de la session. (String YYYY-MM-DDTHH:MM:SSZ) | |
| endDate | Date de fin de la session. (String YYYY-MM-DDTHH:MM:SSZ) | |
| isOverBookingSubscription | Booléen permettant d’activer ou non la file d’attente. (Type Boolean) | |
| daysAvailable | Nombre de jours après l’inscription où l’utilisateur a accès au contenu. (Type Number) | |
| daysToComplete | Nombre de jours maximal après l’inscription pour compléter le contenu. (Type Number) | |
| isHidden | Indique si la session est cachée du catalogue. (Type Boolean) | |
| isFormula | Détermine si le mode « À la carte » est activé. (Type Boolean) | |
| locationId | Identifiant de l’emplacement où se passe la session. (Type string) | |
| gradingMode | Mode de notation de la session.
| |
| customFields | Champs sur mesure reliés à la session. |
Réponse
Exemple de contenu d'appel de réponse de création d'une session :
Description des champs
| Nom | Commentaires/description |
| id | Identifiant unique de la session créée. (Type string) |
Sessions : workspaceinstance/edit
https://www.domaine.com/lmsapi/workspaceinstance/edit
![]() | Permet de modifier une session existante. |
Requête
Exemple de contenu d'appel de 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 obligatoire, les valeurs qui ne sont pas envoyées lors de l’édition ne sont simplement pas mises à jour.
Description des champs
| Nom | Obligatoire | Commentaires/description |
| id | X | Identifiant unique de la session à modifier. (Type string) |
| name | Nom de la session. (Type string) | |
| maxParticipants | Nombre maximum de participants pour votre session. (Type Number) | |
| minParticipants | Nombre minimum de participants pour votre session. (Type Number) | |
| startDate | Date de début de la session. (String YYYY-MM-DDTHH:MM:SSZ) | |
| endDate | Date de fin de la session. (String YYYY-MM-DDTHH:MM:SSZ) | |
| isOverBookingSubscription | Booléen permettant d’activer ou non la file d’attente. (Type Boolean) | |
| daysAvailable | Nombre de jours après l’inscription où l’utilisateur a accès au contenu. (Type Number) | |
| daysToComplete | Nombre de jours maximal après l’inscription pour compléter le contenu. (Type Number) | |
| isHidden | Indique si la session est cachée du catalogue. (Type Boolean) | |
| isFormula | Détermine si le mode « À la carte » est activé. (Type Boolean) | |
| locationId | Identifiant de l’emplacement où se passe la session. (Type string) | |
| gradingMode | Mode de notation de la session.
| |
| customFields | Champs sur mesure reliés à la session. |
Réponse
Exemple de contenu d'appel de réponse d'édition d'une session :
{
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d"
}Description des champs
| Nom | Commentaires/description |
| id | Identifiant unique de la session modifiée. (Type string) |
Sessions : workspaceinstance/delete
https://www.domaine.com/lmsapi/workspaceinstance/delete
![]() | Permet de supprimer une session existante. |
Requête
Exemple de contenu d'appel de requête de suppression d'une session :
{
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d"
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| id | X | Identifiant unique de la session. (Type string) |
Réponse
Exemple de contenu d'appel de réponse de suppression d'une session :
{
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d"
}Description des champs
| Nom | Commentaires/description |
| id | Identifiant unique de la session supprimée. (Type string) |
Sessions : workspaceinstance/subscribeusers
https://www.domaine.com/lmsapi/workspaceinstance/subscribeusers
![]() | Permet d'inscrire plusieurs utilisateurs dans une session. |
Requête
Exemple de contenu d'appel de requête d'inscription d'utilisateurs dans une session :
{
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
"userIds": ["5G5hg343fggalp4JQ%3d%3d","7Z9345EWRTm7TQjdlQ%3d%3d"] ,
"subscriptionDate": "2023-02-22T09:30:00.000"
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| id | X | Identifiant unique de la session. (Type string) |
| userIds | X | Liste des identifiants uniques des utilisateurs à inscrire. (Type liste de string) |
| subscriptionDate | 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 actuelles seront utilisées. (String YYYY-MM-DDTHH:MM:SSZ) |
Réponse
Exemple de contenu d'appel de réponse d'inscription d'utilisateurs dans une session :
{
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d"
}Description des champs
| Nom | Commentaires/description |
| id | Identifiant unique de la session dans laquelle les utilisateurs ont été inscrits. (Type string) |
Sessions : workspaceinstance/subscribeuser
https://www.domaine.com/lmsapi/workspaceinstance/subscribeuser
![]() | Permet d'inscrire un utilisateur dans une session. |
Requête
Exemple de contenu d'appel de requête d'inscription d'un utilisateur dans une session :
{
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
"userId": "5G5hg343fggalp4JQ%3d%3d",
"subscriptionDate": "2023-02-22T09:30:00.000"
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| id | X | Identifiant unique de la session. (Type string) |
| userId | X | Identifiant unique de l'utilisateur à inscrire. (Type string) |
| subscriptionDate | 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 actuelles seront utilisées. (String YYYY-MM-DDTHH:MM:SSZ) |
Réponse
Exemple de contenu d'appel de réponse d'inscription d'un utilisateur dans une session :
{
"id": "nlnugd98r7ge89gudh%3d%3d"
}Description des champs
| Nom | Commentaires/description |
| id | Identifiant d’inscription de l’utilisateur inscrit. (Type string) |
Sessions : workspaceinstance/getuserresourcecompletionlist
https://www.domaine.com/lmsapi/workspaceinstance/getuserresourcecompletionlist
![]() | Retourne la liste des détails de complétion des ressources d’une session de formation pour une inscription. |
Requête
Exemple de contenu d'appel de requête de la liste des complétions de ressources pour une inscription :
{
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
"workspaceInstanceId": "VJRRva0G1SLnlhn3vs7rQA%3d%3d"
}Description des champs
ATTENTION : Seuls les détails sur les utilisateurs actifs sont retournés par l'API.
| Nom | Obligatoire | Commentaires/description |
| id | X | Identifiant d’une inscription d’un utilisateur. (Type string) |
| workspaceInstanceId | Identifiant d’une session de formation. À 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. (Type string) |
Réponse
Exemple de contenu d'appel de réponse de la liste des complétions de ressources pour une inscription :
[
{
"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",
"sessionId": "5xq1pmToL2W34EmS3sAElg%3d%3d",
"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,
"sessionId": "EeAj0XPFV%2fZGONobGc3Xmg%3d%3d"
},
{
"isCompleted": false,
"obtainedPoints": 0,
"duration": 10,
"resourceId": "6y%2f%2fxDcGBZzlKu5Z16grRQ%3d%3d",
"title": "Module1_ress2",
"resourceType": 1,
"completionPoints": 0,
"sessionId": null
},
{
"completionDate": "2024-08-16T17:43:18.39",
"isCompleted": true,
"obtainedPoints": 0,
"duration": 10,
"resourceId": "YUwxqkTk7isY8AuE6JU9Vg%3d%3d",
"title": "aaaa",
"resourceType": 5,
"completionPoints": 0,
"sessionId": null
},
{
"completionDate": "2024-08-16T17:43:25.37",
"isCompleted": true,
"obtainedPoints": 0,
"duration": 10,
"resourceId": "oRUSmxbMkPWLH5geOPdZDg%3d%3d",
"title": "aqwer",
"resourceType": 11,
"completionPoints": 4,
"sessionId": null
},
{
"completionDate": "2024-08-16T17:45:17.757",
"isCompleted": true,
"obtainedPoints": 0,
"duration": 10,
"resourceId": "M0cWdYzMEWN63AdbRUBLYg%3d%3d",
"title": "FORMATI F1",
"resourceType": 11,
"completionPoints": 123,
"sessionId": "2o4ZlGvtB9%2feOAae6rVDqA%3d%3d"
}
]
},
{
"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",
"sessionId": "alCXA7t%2bHaESdG0BY9jZ9Q%3d%3d",
"moduleResources": [
{
"isCompleted": false,
"obtainedPoints": 0,
"duration": 20,
"resourceId": "2QEH7NEzUYWjNC7yzCmklA%3d%3d",
"title": "ress1_mod2",
"resourceType": 11,
"completionPoints": 0,
"sessionId": null
},
{
"isCompleted": false,
"obtainedPoints": 0,
"duration": 20,
"resourceId": "QZVPmGCAY1UrEAHdR7SRvg%3d%3d",
"title": "ress2",
"resourceType": 1,
"completionPoints": 0,
"sessionId": null
},
{
"isCompleted": false,
"obtainedPoints": 6,
"duration": 20,
"resourceId": "Rz2PbnX0fb5e814CSBap2A%3d%3d",
"title": "Capture d’écran 2024-06-05 161442FICHI",
"resourceType": 1,
"completionPoints": 8,
"sessionId": null
}
]
},
{
"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",
"sessionId": null
}
]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
(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ée à cette ressource. (Type : String) |
| certificateId | Identifiant de la certification associée à 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 | 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 | Position de la ressource dans le contenu de la session (Type : Integer) |
| sectionTitle | Titre de la section de la ressource (Type : Integer) |
| sessionId | Identifiant de la session associée à cette ressource (Type : String) |
| 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
![]() | Retourne la liste des détails des ressources d’une session de formation. |
Requête
Exemple de contenu d'appel de requête de la liste des ressources d'une session :
{
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d"
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| id | X | Identifiant unique de la session. (Type string) |
Réponse
Exemple de contenu d'appel de réponse de la liste des ressources d'une session :
[
{
"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
(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 : String) |
usersCompletion | Liste contenant la liste des utilisateurs qui ont accès à 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 complétion de la ressource (Type : Number) |
Sessions : workspaceinstance/getcompletion
https://www.domaine.com/lmsapi/workspaceinstance/getcompletion
![]() | Retourne les détails de complétion d’une session de formation pour une inscription spécifique. |
Requête
Exemple de contenu d'appel de requête des détails de complétion pour une inscription :
{
"id": "7Zi3zYvuHTZ7YsdfsdLK7TQjdlQ%3d%3d"
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| id | X | Identifiant d’une inscription d’un utilisateur. (Type string) |
Réponse
Exemple de contenu d'appel de réponse des détails de complétion pour une inscription :
{
"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 complétion de l’inscription. (String YYYY-MM-DDTHH:MM:SSZ) |
manualCompletionDate | Date à laquelle la complétion s’est effectuée 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 échec ou succès. (Type : Boolean) |
certificateId | Identifiant de certificat associé à la complétion 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
![]() | Modifie les détails de complétion d’une session de formation pour une inscription spécifique. |
Requête
Exemple de contenu d'appel de requête de modification des détails de complétion :
{
"id": "7Zi3zYvuHTZ7YsdfsddfgLK7TQjdlQ%3d%3d",
"isCompleted": true,
"isSuccess": true,
"completionDate": "2021-02-17T15:04:06.687"
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| id | X | Identifiant d’une inscription d’un utilisateur. (Type string) |
| isCompleted | X | Indique si la complétion est faite. (Type Boolean) |
| isSuccess | Indique si la complétion est avec succès ou échec. Si non fourni, succès est pris par défaut. (Type Boolean) | |
| completionDate | Pour mettre une date spécifique de complétion. Sinon le moment où l'appel a été fait sera utilisé. (String YYYY-MM-DDTHH:MM:SSZ) |
Réponse
Exemple de contenu d'appel de réponse de modification des détails de complétion :
{
"id": "7Zi3zYvuHTZ7YsdfsddfgLK7TQjdlQ%3d%3d",
"isCompleted": true,
"isSuccess": true,
"completionDate": "2021-02-17T15:04:06.687"
}Description des champs
| Nom | Commentaires/description |
| id | Identifiant d’une inscription d’un utilisateur. (Type string) |
| isCompleted | Indique si la complétion est faite. (Type Boolean) |
| isSuccess | Indique si la complétion est avec succès ou échec. (Type Boolean) |
| completionDate | Date de complétion de l’inscription. (String YYYY-MM-DDTHH:MM:SSZ) |
Sessions : workspaceinstance/getcompletionlist
https://www.domaine.com/lmsapi/workspaceinstance/getcompletionlist
![]() | Retourne la liste des complétions des inscriptions d'une session. |
Requête
Exemple de contenu d'appel de requête de la liste des complétions :
{
"filterId": "HHjmOri6Olr%2fCPfwPL9RYA%3d%3d",
"filterDate" : "2020-06-23",
"filterIndex": 1
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| filterId | Paramètre optionnel correspondant à l’identifiant d’une session dont on veut obtenir la liste de complétions. (Type string) | |
| filterDate | Paramètre optionnel correspondant à 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. (String YYYY-MM-DDTHH:MM:SSZ) | |
| filterIndex | Paramètre optionnel correspondant à une pagination de 200 complétions. Un filtre par index de 1 retourne les complétions 1 à 200 et un filtre par index de 2 retourne les complétions de 201 à 400. Si ce paramètre n’est pas utilisé, le retour de cet appel ne contiendra qu’au maximum 100 éléments. (Type Number) |
Réponse
Exemple de contenu d'appel de réponse de la liste des 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 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 complétion de l’inscription. (String YYYY-MM-DDTHH:MM:SSZ) |
| manualCompletionDate | Date à laquelle la complétion s’est effectuée manuellement par un administrateur. Vide si complétée 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 est terminée avec échec ou succès. (Type Boolean) |
| certificateId | Identifiant de certificat associé à la complétion 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) |
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 complétion à assigner à l’inscription est requis. |
| 522 | Invalid gradingMode | La valeur fournie 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 |
| 524 | Can't delete workspaceInstance | Lorsque la session est liée à un connecteur externe, il est impossible de la supprimer. |


