Cohortes (Lära)

Table des matières

COHORTES
    Cohortes  : cohort/get
    Cohortes : cohort/getlist
    Cohortes : cohort/getuserlist
    Cohortes : cohort/edit
    Cohortes : cohort/subscribeuser
    Cohortes : cohort/unsubscribeusers
    Cohortes : cohort/getuserdetailedprogress
    Cohortes : cohort/linksubscriptiontoblock
    Cohortes : cohort/unlinksubscriptionfromblock
    Cohortes : cohort/transfersubscriptiontoblock
    Cohortes : cohort/getcompletion
    Cohortes : cohorte/setcompletion
    Description des codes d’erreurs de cohortes

COHORTES

Cohortes  : cohort/get

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

/cohort/get (request) - Requête d'une cohorte par identifiant

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

/cohort/get (response) - Retourne un objet représentant une cohorte

{
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
"programId": "uprlbtvuqNuwmncYPu1ljg%3d%3d",
"name": "Cohorte de test",
"startDate": "0001-01-01T00:00:00",
"endDate": "0001-01-01T00:00:00",
"minParticipants": 0,
"maxParticipants": 50,
"creationDate": "2018-11-19T14:01:20.39",
"isHidden": false,
"status": 0,
"daysAvailable": 0,
"expirationType": 1,
"daysToComplete": 30,
"dateToComplete": "0001-01-01T00:00:00",
"isSinglePayment": false,
"nbUsersSubbed": 3,
"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)

programId

 

Identifiant du programme de formation auquel la cohorte est liée.

(Type string)

name

 

Nom de la cohorte.

(Type string)

startDate

 

 

 

Date de début de la cohorte. Important pour l’auto inscription et la visibilité au catalogue. 

(String YYYY-MM-DDTHH:MM:SSZ)

endDate

               

 

               

 

Date de fin de la cohorte. Important pour l’auto inscription et la visibilité au catalogue.

(String YYYY-MM-DDTHH:MM:SSZ)

minParticipants

               

 

 

Ce paramètre vous permet de déterminer le nombre minimum de participants pour votre cohorte. 

(Type Number)

maxParticipants

               

 

 

Ce paramètre vous permet de déterminer le nombre maximum de participants pour votre cohorte. 

(Type Number)

creationDate

 

Valeur seulement disponible en GET permettant d’obtenir la date de création de la cohorte. 

(String YYYY-MM-DDTHH:MM:SSZ)

isHidden

 

Booléen permettant d’indiquer si la cohorte est caché du catalogue.

Valeur par défaut : false

status

 

Statut de la cohorte.

  • 0 = Actif 
  • 1 = Annulé
  • 2 = Supprimé

(Type Number)

daysAvailable

 

Détermine le nombre de jours après l’inscription d’un utilisateur où ce dernier a accès au contenu.

expirationType

 

Type d’expiration pour les inscriptions de la cohorte. 

  • 0 = Aucune expiration
  • 1 = Nombre de jours après la l’inscription
  • 2 = Date limite

(Type Number)

daysToComplete

 

Nombre de jours après l’inscription pour effectuer l’expiration de celle-ci.

(Type Number)

dateToComplete

 

Date limite pour effectuer l’expiration des inscriptions de la cohorte.

(Type Number)

isSinglePayment

 

Indique si le paiement est effectué au niveau de la cohorte.

(Type Boolean)

nbUsersSubbed

 

Valeur seulement disponible en GET permettant d’obtenir le nombre d'utilisateurs inscrits dans la cohorte.

(Type Number)

lastModificationDate

 

Date de la dernière modification de la cohorte

Ne peut être modifié. Disponible sur get et getlist.

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)

excProgramId

 

Identifiant du programme d’où des crédits excédentaires peuvent être reconnus dans la cohorte. 

(Type String)

excBlockId

 

Identifiant du bloc de la cohorte dans lequel les crédits excédentaires dans le programme excProgramId sont ajoutés. 

(Type String)

excMaximumCredits

 

Le nombre de crédits maximum pouvant être reconnus provenant des crédits excédentaires du programme identifié par excProgramId

(Type Number)

customFields

 

Champs sur mesure reliés à la cohorte

Cohortes : cohort/getlist

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

/cohort/getlist (request) - Requête de la liste des cohortes d'un programme de formation

{
"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 du programme de formation duquel retourner les cohortes.

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 cohorte peut correspondre à :

  • Modification des paramètres administratifs de la formation; 

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

/cohort/getlist (response) - Retourne une liste d'objets représentant chacune des cohortes d’un programme de formation.

Cohortes : cohort/getuserlist

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

/cohort/getuserlist (request) - Requête de la liste des utilisateurs inscrits à la cohorte d'un programme de formation

{
"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 cohorte de programme de formations (pas obligatoire)  String

Filterdate = (pas obligatoire) (Date de création minimale) -String (YYYY-MM-DDTHH:MM:SSZ)

/cohort/getuserlist (response) - Retourne une liste d'objets représentant chacune des inscriptions d’une cohorte d’un programme de formation

[
{
"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 cohorte. 

(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)

Cohortes : cohort/edit

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

/cohort/edit (request) - Requête de modification d'une cohorte

ATTENTION : La méthode nécessite uniquement la valeur ‘’id’’ comme obligatoire. Les champs passés sont mis à jour, les champs qui ne sont pas renseignés ne sont simplement pas mis à jour.

{
"id": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}

/cohort/edit (response) - Retourne l'identifiant de la cohorte modifiée

{
"id": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d"
}
Cohortes : cohort/subscribeusers

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

/cohort/subscribeusers (request)  – Inscrire des utilisateurs dans une cohorte de programme de formation

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

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

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

Cohortes : cohort/subscribeuser

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

/cohort/subscribeuser (request)  – Inscrire un utilisateur dans une cohorte de programme de formation

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

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

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

Cohortes : cohort/unsubscribeusers

https://www.domaine.com/lmsapi/cohort/unsubscribeusers

/cohort/unsubscribeusers (request)  – Désinscrire des utilisateurs d’une cohorte de programme de formation

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

/cohort/unsubscribeusers (response) - Retourne l'identifiant de la cohorte dans laquelle les utilisateurs ont été désinscrits

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

Cohortes : cohort/getuserdetailedprogress

https://www.domaine.com/lmsapi/cohort/getuserdetailedprogress

/cohort/getuserdetailedprogress (request) - Requête de la progression détaillée d’un utilisateur d’une cohorte de programme de formation

{
"id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
"billingId": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d"
}

ATTENTION : 

id = d’une cohorte de programme de formations (String)

billingId = identifiant d’inscription d’un utilisateur à la cohorte de programme de formation. (String)

/cohort/getuserdetailedprogress(response) - Retourne un objet représentant la progression détaillée d’un utilisateur d’une cohorte de programme de formation

{
"id": "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d",
"billingId": "xEN29J7ON5HaVuxG3076JA%3d%3d",
"userId": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d",
"commitmentId": "DR7sYn48asda%2asfduaszdif3sgb4dfgfsTdffGhZ1nQ%3d%3d",
"progressPercent": 33,
"isCompleted": true,
"isSuccess": true,
"completionDate": "2021-02-22T08:39:35.617",
"manualCompletionDate": "2021-02-22T08:39:35.617",
"modifiedByUserId": "DR7sYn48%2fuzi3b4fTGZ1nQ%3d%3d",
"certificateId": "",
"blocks": [{
"id": "TRXbb9r1WIhbXuvpujVt0Q%3d%3d",
"name": "bloc 1",
"amountRequired": 10.00,
"amountObtained": 9.55,
"progressPercent": 95,
"workspaces": [{
"id": "l6Cu6xppc7CcaSEfC38sPw%3d%3d",
"workspaceInstanceId": "ysK6Zneh46rHStA0fAW34A%3d%3d",
"billingId": "dWSVQtK7g%2fscn9WVxXmoAg%3d%3d",
"commitmentId": "DR3465g7ssas3dfv35ghj",
"name": "#JG",
"credits": 9.55,
"creditsObtained": 9.55,
"progressPercent": 100,
"isCompleted": true,
"isSuccess": true,
"isRequired": true
}
]
}, {
"id": "uprlbtvuqNuwmncYPu1ljg%3d%3d",
"name": "Bloc 2",
"amountRequired": 5.00,
"amountObtained": 0,
"progressPercent": 0,
"workspaces": [{
"id": "5EJOaP8xOZr0tq%2fLtdU3Og%3d%3d",
"workspaceInstanceId": "",
"billingId": "",
"name": "#jg'2 (",
"credits": 5.00,
"creditsObtained": 0,
"progressPercent": 0,
"isCompleted": false,
"isSuccess": false,
"isRequired": true
}
]
}, {
"id": "VXVTs0R3Vz8hHLbQ9MsCHQ%3d%3d",
"name": "bloc de programme",
"amountRequired": 5.00,
"amountObtained": 0.00,
"progressPercent": 0,
"workspaces": [{
"id": "KZYQXl9ud%2bgHA7lefzjQzA%3d%3d",
"workspaceInstanceId": "ysK6Zneh46rHStA0fAW34A%3d%3d",
"billingId": "dWSVQtK7g%2fscn9WVxXmoAg%3d%3d",
"name": "workspace name test",
"credits": 9.55,
"creditsObtained": 0.0,
"progressPercent": 100,
"isCompleted": true,
"isSuccess": true,
"isRequired": true
}, {
"id": "oqJ4%2bCp2dAhtoR3IJfpi8g%3d%3d",
"workspaceInstanceId": "O7Ruw8bvCEkOh6%2b113xgGA%3d%3d",
"billingId": "PXCvDjOtb5UAUwuUp870tA%3d%3d",
"name": "Formation de test",
"credits": 3.00,
"creditsObtained": 0.0,
"progressPercent": 100,
"isCompleted": true,
"isSuccess": false,
"isRequired": true
}
]
}
]
}

Description des champs

Nom 

Obligatoire

Commentaires/description

id

 

Identifiant unique de la cohorte. (Type String)

billingId

 

Identifiant unique de l’inscription à la cohorte.

(Type String)

userId

 

Identifiant unique de l’utilisateur.

 (Type String)

commitmentId

 

Identifiant unique de l’engagement.

 (Type String)

progressPercent

 

 

 

Progression de l’utilisateur sur la cohorte.

(Type Number)

excAccCredits

 

Nombre de crédits excédentaires accumulés par l’utilisateur dans la cohorte. Tant que la cohorte n’est pas complétée avec succès, cette valeur restera à zéro.

(Type Number)

isCompleted

               

 

               

 

État de complétion de la cohorte de l’inscription. 

 

(Type Boolean)

isSuccess

               

 

 

Type de succès de la complétion.

(Type Boolean)

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)

certificateId          

 

 

Identifiant de certificat associé à la completion de l’inscription.

(Type : String)

blocks

               

 

 

Liste de progression détaillée des blocs de la cohorte. 

(Type List)

blocks.id

 

Identifiant unique du bloc de la cohorte.

(Type String)

blocks.name

 

Nom du bloc.

(Type String)

blocks.amountRequired

 

Nombre de formations ou crédits requis pour la complétion du bloc.

(Type Number)

blocks.amountObtained

 

Nombre de formations ou crédits obtenu pour la complétion du bloc.

(Type Number)

blocks.progressPercent

 

Progression de l’utilisateur sur le bloc.

(Type Number)

blocks.workspaces

 

Liste de progression détaillée des formations auxquels l’utilisateur est inscrit dans le bloc.

(Type List)

blocks.workspaces.id

 

Identifiant unique de la formation.

(Type String)

blocks.workspaces.workspaceInstanceId

 

Identifiant unique de la session auquel l’utilisateur est inscrit.

(Type String)

blocks.workspaces.billingId

 

Identifiant unique de l’inscription de l’utilisateur à la session.

(Type String)

Blocks.workspaces.commitmentId

 

Identifiant unique de l’engagement.

 (Type String)

blocks.workspaces.name

 

Nom de la formation.

(Type String)

blocks.workspaces.credits

 

Nombre de crédit associé à la réussite de cette formation. 

(Type Number)

blocks.workspaces.creditsObtained

 

Nombre de crédit obtenu suite à la réussite de cette formation.

(Type Number)

blocks.workspaces.progressPercent

 

Progression de l’utilisateur sur la session.

(Type Number)

blocks.workspaces.isCompleted

 

État de complétion de la session de l’inscription.

(Type Boolean)

blocks.workspaces.isSuccess

 

Type de succès de la complétion.

(Type Boolean)

blocks.workspaces.isRequired

 

Indique si la complétion de cette formation est requise pour le bloc.

(Type Boolean)

Cohortes : cohort/linksubscriptiontoblock

https://www.domaine.com/lmsapi/cohort/linksubscriptiontoblock

/cohort/linksubscriptiontoblock (request)  – Requête pour lier une inscription existante à une formation dans le bloc d’une cohorte

{
"billingId": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
"workspaceBillingId": "%2bcSfyhuuFvha809UcfbkJw%3d%3d",
"targetBlockId": "TRXbb9r1WIhbXuvpujVt0Q%3d%3d"
}

/cohort/linksubscriptiontoblock (response) – Retourne l’identifiant de l’inscription de la formation liée

{
"id": "%2bcSfyhuuFvha809UcfbkJw%3d%3d"
}

Description des champs

Nom 

Obligatoire

Commentaires/description

billingId

Identifiant unique de l’inscription à la cohorte.

(Type String)

workspaceBillingId

Identifiant unique de l’inscription à la formation concernée.

 (Type String)

targetBlockId

 

 

Identifiant unique du bloc de la cohorte dans lequel lier l’inscription à la formation.

 (Type String)

Cohortes : cohort/unlinksubscriptionfromblock

https://www.domaine.com/lmsapi/cohort/unlinksubscriptionfromblock

/cohort/unlinksubscriptionfromblock (request)  – Requête pour retirer l’inscription à une formation dans un bloc d’un cohorte

{
"billingId": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
"workspaceBillingId": "%2bcSfyhuuFvha809UcfbkJw%3d%3d"
}

/cohort/unlinksubscriptionfromblock (response) – Retourne l’identifiant de l’inscription de la formation retirée

{
"id": "%2bcSfyhuuFvha809UcfbkJw%3d%3d"
}

Description des champs

Nom 

Obligatoire

Commentaires/description

billingId

Identifiant unique de l’inscription à la cohorte.

(Type String)

workspaceBillingId

Identifiant unique de l’inscription à la formation concernée.

 (Type String)

Cohortes : cohort/transfersubscriptiontoblock

https://www.domaine.com/lmsapi/cohort/transfersubscriptiontoblock

/cohort/transfersubscriptiontoblock (request)  – Requête pour déplacer la liaison d’un inscription à une formation d’un bloc d’une cohorte à un autre bloc de la même ou d’une autre cohorte

{
"billingId": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
"workspaceBillingId": "%2bcSfyhuuFvha809UcfbkJw%3d%3d",
"targetBlockId": "TRXbb9r1WIhbXuvpujVt0Q%3d%3d",
"targetBillingId": "7kGFIIstMwCbP4W3td0G5w%3d%3d"
}

/cohort/transfersubscriptiontoblock (response) – Retourne l’identifiant de l’inscription de la formation déplacé

{
"id": "%2bcSfyhuuFvha809UcfbkJw%3d%3d"
}

Description des champs

Nom 

Obligatoire

Commentaires/description

billingId

Identifiant unique de l’inscription à la cohorte.

(Type String)

workspaceBillingId

Identifiant unique de l’inscription à la formation concernée.

 (Type String)

targetBlockId

 

 

Identifiant unique du bloc de la cohorte dans lequel lier l’inscription à la formation.

 (Type String)

targetBillingId

 

 

 

Identifiant unique de l’inscription à la cohorte dans laquelle lier l’inscription à la formation.

 (Type String)

Cohortes : cohort/getcompletion

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

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

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

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

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

{
"id": "vrj0IrWe0HasdFg%2bK9OKGpDFdfg5A%3d%3d",
"billingId": "7Zi3zYvuHTZ7YsdfsdLK7TQjdlQ%3d%3d ",
"userId": "%2bgdfgGMWE4uzG6RLeasdKzgpoz%2bLQ%3d%3d",
"progressPercent": 0,
"isCompleted": true,
"isSuccess": true,
"completionDate": "2021-02-22T08:39:35.617",
"manualCompletionDate": "2021-02-22T08:39:35.617",
"modifiedByUserId": "DR7sYn48%2fuasdgfzi3b4fTGZ1nQdf%3d%3d",
"certificateId": ""
}

Description des champs

Nom 

Commentaires/description

id

Identifiant de la cohorte.

(Type : String)

billingId

Identifiant de l’inscription de l’utilisateur.

(Type : String)

userId

Identifiant de l’utilisateur.

(Type : String)

progressionPercent

Indique la progression de l’inscription dans la session.

(Type : Number)

excAccCredits

Nombre de crédits excédentaires accumulés par l’utilisateur dans la cohorte. Tant que la cohorte n’est pas complétée avec succès, cette valeur restera à zéro.

(Type Number)

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)

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)

certificateId

Identifiant de certificat associé à la completion de l’inscription.

(Type : String)

Cohortes : cohorte/setcompletion

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

/cohort/setcompletion (request) - Modifie les détails de complétion d’une cohorte 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)

/cohort/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 de cohortes

Numéro

Message

Commentaires/description

1500

Required id

Vous devez fournir un identifiant pour la cohorte.

1501

Invalid id

L’identifiant fourni pour la cohorte est invalide.

1502

At least 1 of the parameters needs to be filled

Au moins un des deux paramètres de recherche doit être envoyé.

1503

Invalid Program id

L’identifiant fourni pour le programme de formation est invalide.

1504

Required User Ids

Vous devez fournir une liste d’identifiants d’utilisateurs.

1505

Invalid User Ids

Un ou plusieurs identifiants d’utilisateurs sont invalides.

1506

Required Billing Ids

Vous devez fournir une liste d’identifiants de facturation d’inscription.

1507

Invalid Billing Ids

Un ou plusieurs identifiants de facturation d’inscription sont invalides.

1508

Cancel Subscription Failure

Une erreur est survenue lors de la désinscription.

1509

Required Cohort Id

L’identifiant de la cohorte est requis.

1510

Invalid Cohort Id

L’identifiant de la cohorte est invalide.

1511

Group Already In Wsi

(Non implémenté)

1512

Required Cohort Name

Vous devez fournir le nom de la cohorte.

1513

Invalid Cohort Name Length

Le nom de la cohorte doit avoir au moins 3 et ne doit pas dépasser 150 caractères.

1514

Required Program Id

L’identifiant du programme est requis.

1515

Required Min Participant

Vous devez fournir le nombre minimum de participants.

1516

Invalid Min Participant

Le nombre minimum de participants est invalide.

1517

Required Max Participant

Vous devez fournir le nombre maximum de participants.

1518

Invalid Max Participant

Le nombre maximum de participants est invalide.

1519

Invalid Days Available

Le nombre de jours disponible est invalide.

1520

Invalid Days To Complete

Le nombre de jours maximum pour compléter la cohorte est invalide.

1521

Required Billing Id

L’identifiant d’inscription à la cohorte est requis.

1522

Invalid Billing Id

L’identifiant d’inscription à la cohorte est invalide.

1523

Required Block Id

L’identifiant du bloc de la cohorte est requis.

1524

Invalid Block Id

L’identifiant du bloc de la cohorte est invalide.

1525

Required Workspace Billing Id

L’identifiant d’inscription à la formation est requis.

1526

Invalid Workspace Billing Id

L’identifiant d’inscription à la formation est invalide.

1527

Already Subscribed

La formation dans le bloc de la cohorte est déjà liée à une inscription.

1528

Target Not Subscribed

Aucune inscription à la cohorte ciblée par l’appel.

1529

Invalid Target BillingId

L’identifiant d’inscription à la cohorte ciblée est invalide.

1530

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.