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

Table des matières

SESSION DES FORMATIONS ET ÉVÉNEMENTS
    Sessions : workspaceinstance/get
    Sessions : workspaceinstance/getlist
    Sessions : workspaceinstance/getuserlist
    Sessions : workspaceinstance/create
    Sessions : workspaceinstance/delete
    Sessions : workspaceinstance/subscribeusers
    Sessions : workspaceinstance/subscribeuser
    Sessions : workspaceinstance/getuserresourcecompletionlist
    Sessions : workspaceinstance/getresourcelist
    Sessions : workspaceinstance/getcompletion
    Sessions : workspaceinstance/setcompletion
    Description des codes d’erreurs des sessions de formation

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",
"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,
“isFormula” : false,
"locationId": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
"createdByUserID": "%2fUtsC30QAPbKKJCD7cUkJA%3d%3d",
"lastModificationDate": "0001-01-01T00:00:00",
"taxEnabled": true,
"taxCountryId": 123,
"taxStateId": 321
"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)

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

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)

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"
}

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)
/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"
}

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)

/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"
},
{
"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"
},
{
"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"
}
]

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)

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

{
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
"userIds": ["5G5hg343fggalp4JQ%3d%3d","7Z9345EWRTm7TQjdlQ%3d%3d"]
}

/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

{
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
"userId": "5G5hg343fggalp4JQ%3d%3d"
}

/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 inscriptions spécifique

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

ATTENTION : 

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": "jnKQkzdIDj6/4Ww+nspwPA==",
"parentResourceId": null,
"title": "Questionnaire noté",
"resourceType": 10,
"credits": 5.00,
"adminCode": "",
"creationDate": "2020-07-07T20:27:12.303",
"dateCondition": null,
"dateEndCondition": null,
"minParticipants": 0,
"maxParticipants": 0,
"completionDate": null,
"isCompleted": false,
"isSuccess": null
},
{
"resourceId": "Cjfode5wCmSAxDBPmxUH4w==",
"parentResourceId": null,
"title": "Classe virtuelle",
"resourceType": 2,
"credits": 3.00,
"adminCode": "",
"creationDate": "2020-05-06T19:29:04.76",
"dateCondition": null,
"dateEndCondition": null,
"minParticipants": 0,
"maxParticipants": 0,
"completionDate": "2020-07-07T20:21:28.113",
"isCompleted": true,
"isSuccess": null
},
{
"resourceId": "cbOYWAa81aWrXptOTPwyEQ==",
"parentResourceId": null,
"title": "Sondage",
"resourceType": 5,
"credits": 3.00,
"adminCode": "",
"creationDate": "2020-05-06T19:28:12.707",
"dateCondition": null,
"dateEndCondition": null,
"minParticipants": 0,
"maxParticipants": 0,
"completionDate": "2020-07-07T20:25:59.123",
"isCompleted": true,
"isSuccess": 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

  • 0 = Ressource par défaut
  • 1 = Document
  • 2 = Activité
  • 3 = Activité en présence
  • 4 = Vidéo
  • 5 = Sondage
  • 6 = Module
  • 7 = Couriel
  • 8 = Objet SCORM
  • 9 = Présentation
  • 10 = Questionnaire
  • 11 = Questionnaire formatif
  • 12 = Dépôt de document
  • 13 = Objet Moodle

(Type : Integer)

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)

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)

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,
"minParticipants": 0,
"maxParticipants": 0,
"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,
"minParticipants": 0,
"maxParticipants": 0,
"completionDate": "2020-07-07T20:21:28.113",
"usersCompletion": [
{
"userId": 3mCrRAsA6ZEonpg234234xqc2VQA%3d%3d,
"billingId": j9XoGU3mn7fvb45b5K7vuvsg9LQ%3d%3d,
"isCompleted": true,
"isSuccess": false
},
{
"userId": PFjUV2AbVTMG3Ksdf56456EiPb1CkQ%3d%3d,
"billingId": x9XNzlzm6b7w55h67s4idU%2f7NSOiew%3d%3d,
"isCompleted": false,
"isSuccess": null
}
]
},
{
"resourceId": "cbOYWAa343b5n4nvgnhb81aWrXptOTPwyEQ==",
"parentResourceId": "",
"title": "Module",
"resourceType": 6,
"credits": 3.00,
"adminCode": "",
"creationDate": "2020-05-06T19:28:12.707",
"dateCondition": null,
"dateEndCondition": null,
"minParticipants": 0,
"maxParticipants": 0,
"completionDate": null,
"usersCompletion": []
},
{
"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,
"minParticipants": 0,
"maxParticipants": 0,
"completionDate": null,
"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

  • 0 = Ressource par défaut
  • 1 = Document
  • 2 = Activité
  • 3 = Activité en présence
  • 4 = Vidéo
  • 5 = Sondage
  • 6 = Module
  • 7 = Couriel
  • 8 = Objet SCORM
  • 9 = Présentation
  • 10 = Questionnaire
  • 11 = Questionnaire formatif
  • 12 = Dépôt de document
  • 13 = Objet Moodle

(Type : Integer)

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)

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 : Boolean)

usersCompletion.billingId

Identifiant unique de l’inscription de l’utilisateur.

(Type : Boolean)

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)

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,
}

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)

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"
}

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.

Cette réponse a-t-elle été utile ? Oui Non

Envoyer vos commentaires
Nous sommes désolés de ne pas avoir pu répondre à votre question. Aidez-nous à améliorer cet article grâce à vos commentaires.