Cohortes
Les « cohortes » sont des occurrences des programmes de formation. Elles sont l'équivalent d'une session pour la formation. Elle sont nommées « cohort » dans l'API. |
Cohort/get
Permet d'obtenir des informations sur une cohorte de votre environnement. |
Requête
Exemple de contenu d'appel de requête des informations d'une cohorte :
{
"id": "7IoopVM73nHZMhUaQ3JvWw%3d%3d"
}
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique de la cohorte. |
Réponse
Exemple du contenu d'appel de réponse de requête des informations d'une cohorte :
{
"id": "qUdyCbBEIdpfoVPrKETcjA%3d%3d",
"programId": "v79AV9j3B3OV8Ay%2fHmKiOQ%3d%3d",
"name": "Formation entretien 2",
"startDate": "0001-01-01T00:00:00",
"endDate": "0001-01-01T00:00:00",
"minParticipants": 0,
"maxParticipants": 20,
"creationDate": "2019-08-02T14:09:29.677",
"isHidden": false,
"status": 0,
"daysAvailable": 0,
"expirationType": 1,
"daysToComplete": 1,
"dateToComplete": "0001-01-01T00:00:00",
"taxEnabled": true,
"taxCountryId": 37,
"taxStateId": 11,
"isSinglePayment": true,
"nbUsersSubbed": 22,
"lastModificationDate": "2024-03-06T14:34:57.823",
"excProgramId": "9R%2btVNekvkoq1dRDux9GKA%3d%3d",
"excBlockId": "wCFBy4FYTaXktjmxqN7E5g%3d%3d",
"excMaximumCredits": 10.00,
"customFields": {
"cohortNum": "12"
}
}
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique de la cohorte. (Type String) | |
programId | Identifiant unique du programme de formation. (Type String) | |
name | Nom de la cohorte. (Type String) | |
startDate | Date de début de la cohorte. (String YYYY-MM-DDTHH:MM:SSZ) | |
endDate | Date de fin de la cohorte. (String YYYY-MM-DDTHH:MM:SSZ) | |
minParticipants | Nombre minimum de participants requis pour lancer la cohorte. (Type Number) | |
maxParticipants | Nombre maximum de participants requis pour lancer la cohorte. (Type Number) | |
creationDate | Date de création de la cohorte. (String YYYY-MM-DDTHH:MM:SSZ) | |
isHidden | Indique si la cohorte est affichée et disponible pour l'inscription ou non dans le catalogue. La valeur par défaut est False. (Type Booléen) | |
status | Indique le statut de la cohorte dans le système.
| |
expirationType | Type d’expiration pour les inscriptions de la cohorte.
| |
daysToComplete | Nombre de jours dont l'utilisateur dispose après son inscription pour compléter la cohorte. (Type Number) | |
dateToComplete | Date spécifique à laquelle l'utilisateur soit avoir complété la cohorte. (String YYYY-MM-DDTHH:MM:SSZ) | |
taxEnabled | Indique si les taxes sont activées lors d'une transaction de paiement pour un inscription au niveau de la cohorte ("isSinglePayment": true) (Type Booléen) | |
taxCountryId | Identifiant unique du pays où est réputée se tenir la cohorte. Veuillez consulter l'Annexe 3 : Pays et États/Provinces. (Type Number) | |
taxStateId | Identifiant unique de la province ou de l'état où est réputée se tenir la cohorte. Veuillez consulter l'Annexe 3 : Pays et États/Provinces. (Type Number) | |
taxEnabled | Indique si les taxes sont activées ou non sur les paiements reçus pour les inscriptions à la cohorte. (Type Booléen) | |
isSinglePayment | Indique si le paiement est fait au niveau de la cohorte ou des formations qu'elle contient.
| |
nbUsersSubbed | Indique le nombre d'utilisateurs présentement inscrits à la cohorte. (Type Number) | |
lastModificationDate | Date de la dernière modification des paramètres administratifs de la cohorte par un administrateur. (String YYYY-MM-DDTHH:MM:SSZ) | |
excProgramId | Identifiant unique du programme d’où des crédits excédentaires peuvent être reconnus dans la cohorte. (Type String) | |
excBlockId | Identifiant unique 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 personnalisé liés à la cohorte. |
Cohort/getlist
Permet d'obtenir des informations sur une liste de cohortes de votre environnement. |
Requête
Exemple de contenu d'appel de requête des informations d'une liste de cohortes. Les champs sont optionnels, mais au moins un doit être fourni :
{
"id": "7IoopVM73nHZMhUaQ3JvWw%3d%3d",
"filterDate": "YYYY-MM-DDTHH:MM:SSZ",
"filterEditDate": "YYYY-MM-DDTHH:MM:SSZ",
"filterIncludeDisabled" : true
}
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique du programme de formation. | |
filterDate | Date de création de la cohorte. 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 | Date de la dernière modification des paramètres administratifs de la cohorte. La méthode retourne la liste des objets qui ont été modifiés après la date passée comme filtre. (String YYYY-MM-DDTHH:MM:SSZ) | |
filterIncludeDisabled | Filtre permettant d'inclure les cohortes qui ont été annulées.
|
Réponse
Exemple du contenu d'appel de réponse de requête des informations d'une liste de cohortes :
[
{
"id": "qUdyCbBEIdpfoVPrKETcjA%3d%3d",
"programId": "v79AV9j3B3OV8Ay%2fHmKiOQ%3d%3d",
"name": "Formation entretien 2",
"startDate": "0001-01-01T00:00:00",
"endDate": "0001-01-01T00:00:00",
"minParticipants": 0,
"maxParticipants": 20,
"creationDate": "2019-08-02T14:09:29.677",
"isHidden": false,
"status": 0,
"daysAvailable": 0,
"expirationType": 1,
"daysToComplete": 1,
"dateToComplete": "0001-01-01T00:00:00",
"taxEnabled": true,
"taxCountryId": 37,
"taxStateId": 11,
"isSinglePayment": true,
"nbUsersSubbed": 22,
"lastModificationDate": "2024-03-06T14:34:57.823",
"excProgramId": "9R%2btVNekvkoq1dRDux9GKA%3d%3d",
"excBlockId": "wCFBy4FYTaXktjmxqN7E5g%3d%3d",
"excMaximumCredits": 10.00,
"customFields": {
"cohortNum": "12"
}
},
{
"id": "ask7rmhCGDQnv4pZ02WZlQ%3d%3d",
"programId": "v79AV9j3B3OV8Ay%2fHmKiOQ%3d%3d",
"name": "Formation entretien 1 - Copie",
"startDate": "0001-01-01T00:00:00",
"endDate": "0001-01-01T00:00:00",
"minParticipants": 0,
"maxParticipants": 20,
"creationDate": "2020-09-23T10:02:46.05",
"isHidden": false,
"status": 0,
"daysAvailable": 0,
"expirationType": 0,
"daysToComplete": 0,
"dateToComplete": "0001-01-01T00:00:00",
"taxEnabled": true,
"isSinglePayment": true,
"nbUsersSubbed": 0,
"lastModificationDate": "2020-09-23T10:08:41.453",
"customFields": {
"cohortNum": ""
}
}
}
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique de la cohorte. (Type String) | |
programId | Identifiant unique du programme de formation. (Type String) | |
name | Nom de la cohorte. (Type String) | |
startDate | Date de début de la cohorte. (String YYYY-MM-DDTHH:MM:SSZ) | |
endDate | Date de fin de la cohorte. (String YYYY-MM-DDTHH:MM:SSZ) | |
minParticipants | Nombre minimum de participants requis pour lancer la cohorte. (Type Number) | |
maxParticipants | Nombre maximum de participants requis pour lancer la cohorte. (Type Number) | |
creationDate | Date de création de la cohorte. (String YYYY-MM-DDTHH:MM:SSZ) | |
isHidden | Indique si la cohorte est affichée et disponible pour l'inscription ou non dans le catalogue. La valeur par défaut est False. (Type Booléen) | |
status | Indique le statut de la cohorte dans le système.
| |
expirationType | Type d’expiration pour les inscriptions de la cohorte.
| |
daysToComplete | Nombre de jours dont l'utilisateur dispose après son inscription pour compléter la cohorte. (Type Number) | |
dateToComplete | Date spécifique à laquelle l'utilisateur soit avoir complété la cohorte. (String YYYY-MM-DDTHH:MM:SSZ) | |
taxEnabled | Indique si les taxes sont activées lors d'une transaction de paiement pour un inscription au niveau de la cohorte ("isSinglePayment": true) (Type Booléen) | |
taxCountryId | Identifiant unique du pays où est réputée se tenir la cohorte. Veuillez consulter l'Annexe 3 : Pays et États/Provinces. (Type Number) | |
taxStateId | Identifiant unique de la province ou de l'état où est réputée se tenir la cohorte. Veuillez consulter l'Annexe 3 : Pays et États/Provinces. (Type Number) | |
taxEnabled | Indique si les taxes sont activées ou non sur les paiements reçus pour les inscriptions à la cohorte. (Type Booléen) | |
isSinglePayment | Indique si le paiement est fait au niveau de la cohorte ou des formations qu'elle contient.
| |
nbUsersSubbed | Indique le nombre d'utilisateurs présentement inscrits à la cohorte. (Type Number) | |
lastModificationDate | Date de la dernière modification des paramètres administratifs de la cohorte par un administrateur. (String YYYY-MM-DDTHH:MM:SSZ) | |
excProgramId | Identifiant unique du programme d’où des crédits excédentaires peuvent être reconnus dans la cohorte. (Type String) | |
excBlockId | Identifiant unique 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 personnalisé liés à la cohorte. |
Cohort/create
Permet de créer une cohorte dans un programme de formations votre environnement. |
Requête
Exemple de contenu d'appel de requête de création d'une cohorte :
{
"programId": "v79AV9j3B3OV8Ay%2fHmKiOQ%3d%3d",
"name": "Formation entretien 2",
"startDate": "0001-01-01T00:00:00",
"endDate": "0001-01-01T00:00:00",
"minParticipants": 0,
"maxParticipants": 20,
"creationDate": "2019-08-02T14:09:29.677",
"isHidden": false,
"status": 0,
"daysAvailable": 0,
"expirationType": 1,
"daysToComplete": 1,
"dateToComplete": "0001-01-01T00:00:00",
"taxEnabled": true,
"taxCountryId": 37,
"taxStateId": 11,
"isSinglePayment": true,
"nbUsersSubbed": 22,
"lastModificationDate": "2024-03-06T14:34:57.823",
"excProgramId": "9R%2btVNekvkoq1dRDux9GKA%3d%3d",
"excBlockId": "wCFBy4FYTaXktjmxqN7E5g%3d%3d",
"excMaximumCredits": 10.00,
"customFields": {
"cohortNum": "12"
}
}
Description des champs
Nom | Obligatoire | Commentaires/description |
programId | X | Identifiant unique du programme de formation. (Type String) |
name | X | Nom de la cohorte. (Type String) |
startDate | Date de début de la cohorte. (String YYYY-MM-DDTHH:MM:SSZ) | |
endDate | Date de fin de la cohorte. (String YYYY-MM-DDTHH:MM:SSZ) | |
minParticipants | X | Nombre minimum de participants requis pour lancer la cohorte. (Type Number) |
maxParticipants | X | Nombre maximum de participants requis pour lancer la cohorte. (Type Number) |
isHidden | Indique si la cohorte est affichée et disponible pour l'inscription ou non dans le catalogue. La valeur par défaut est False. (Type Booléen) | |
status | Indique le statut de la cohorte dans le système.
| |
expirationType | Type d’expiration pour les inscriptions de la cohorte.
| |
daysToComplete | Nombre de jours dont l'utilisateur dispose après son inscription pour compléter la cohorte. (Type Number) | |
dateToComplete | Date spécifique à laquelle l'utilisateur soit avoir complété la cohorte. (String YYYY-MM-DDTHH:MM:SSZ) | |
taxEnabled | Indique si les taxes sont activées lors d'une transaction de paiement pour un inscription au niveau de la cohorte ("isSinglePayment": true) (Type Booléen) | |
taxCountryId | Identifiant unique du pays où est réputée se tenir la cohorte. Veuillez consulter l'Annexe 3 : Pays et États/Provinces. (Type Number) | |
taxStateId | Identifiant unique de la province ou de l'état où est réputée se tenir la cohorte. Veuillez consulter l'Annexe 3 : Pays et États/Provinces. (Type Number) | |
taxEnabled | Indique si les taxes sont activées ou non sur les paiements reçus pour les inscriptions à la cohorte. (Type Booléen) | |
isSinglePayment | Indique si le paiement est fait au niveau de la cohorte ou des formations qu'elle contient.
| |
nbUsersSubbed | Indique le nombre d'utilisateurs présentement inscrits à la cohorte. (Type Number) | |
lastModificationDate | Date de la dernière modification des paramètres administratifs de la cohorte par un administrateur. (String YYYY-MM-DDTHH:MM:SSZ) | |
excProgramId | Identifiant unique du programme d’où des crédits excédentaires peuvent être reconnus dans la cohorte. (Type String) | |
excBlockId | Identifiant unique 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 personnalisé liés à la cohorte. |
Réponse
Exemple de contenu d'appel de réponse de requête de création d'une cohorte :
{
"id": "7IoopVM73nHZMhUaQ3JvWw%3d%3d"
}
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique de la cohorte. |
Cohort/edit
Permet de modifier une cohorte d'un programme de formations votre environnement. |
Requête
Exemple de contenu d'appel de requête de modification d'une cohorte :
{
"id": "2WYVweCCZqYONzOvft3LZQ%3d%3d",
"name": "Formation entretien 2",
"startDate": "0001-01-01T00:00:00",
"endDate": "0001-01-01T00:00:00",
"minParticipants": 0,
"maxParticipants": 20,
"creationDate": "2019-08-02T14:09:29.677",
"isHidden": false,
"status": 0,
"daysAvailable": 0,
"expirationType": 1,
"daysToComplete": 1,
"dateToComplete": "0001-01-01T00:00:00",
"taxEnabled": true,
"taxCountryId": 37,
"taxStateId": 11,
"isSinglePayment": true,
"nbUsersSubbed": 22,
"lastModificationDate": "2024-03-06T14:34:57.823",
"excProgramId": "9R%2btVNekvkoq1dRDux9GKA%3d%3d",
"excBlockId": "wCFBy4FYTaXktjmxqN7E5g%3d%3d",
"excMaximumCredits": 10.00,
"customFields": {
"cohortNum": "12"
}
}
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique de la cohorte. (Type String) |
name | Nom de la cohorte. (Type String) | |
startDate | Date de début de la cohorte. (String YYYY-MM-DDTHH:MM:SSZ) | |
endDate | Date de fin de la cohorte. (String YYYY-MM-DDTHH:MM:SSZ) | |
minParticipants | Nombre minimum de participants requis pour lancer la cohorte. (Type Number) | |
maxParticipants | Nombre maximum de participants requis pour lancer la cohorte. (Type Number) | |
isHidden | Indique si la cohorte est affichée et disponible pour l'inscription ou non dans le catalogue. La valeur par défaut est False. (Type Booléen) | |
status | Indique le statut de la cohorte dans le système.
| |
expirationType | Type d’expiration pour les inscriptions de la cohorte.
| |
daysToComplete | Nombre de jours dont l'utilisateur dispose après son inscription pour compléter la cohorte. (Type Number) | |
dateToComplete | Date spécifique à laquelle l'utilisateur soit avoir complété la cohorte. (String YYYY-MM-DDTHH:MM:SSZ) | |
taxEnabled | Indique si les taxes sont activées lors d'une transaction de paiement pour un inscription au niveau de la cohorte ("isSinglePayment": true) (Type Booléen) | |
taxCountryId | Identifiant unique du pays où est réputée se tenir la cohorte. Veuillez consulter l'Annexe 3 : Pays et États/Provinces. (Type Number) | |
taxStateId | Identifiant unique de la province ou de l'état où est réputée se tenir la cohorte. Veuillez consulter l'Annexe 3 : Pays et États/Provinces. (Type Number) | |
taxEnabled | Indique si les taxes sont activées ou non sur les paiements reçus pour les inscriptions à la cohorte. (Type Booléen) | |
isSinglePayment | Indique si le paiement est fait au niveau de la cohorte ou des formations qu'elle contient.
| |
nbUsersSubbed | Indique le nombre d'utilisateurs présentement inscrits à la cohorte. (Type Number) | |
lastModificationDate | Date de la dernière modification des paramètres administratifs de la cohorte par un administrateur. (String YYYY-MM-DDTHH:MM:SSZ) | |
excProgramId | Identifiant unique du programme d’où des crédits excédentaires peuvent être reconnus dans la cohorte. (Type String) | |
excBlockId | Identifiant unique 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 personnalisé liés à la cohorte. |
Réponse
Exemple de contenu d'appel de réponse de requête de modification d'une cohorte :
{
"id": "2WYVweCCZqYONzOvft3LZQ%3d%3d"
}
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique de la cohorte. |
Cohort/getuserlist
Permet d'obtenir des informations sur une liste d'utilisateurs inscrits à une cohorte de votre environnement. |
Requête
Exemple de contenu d'appel de requête des informations d'une liste d'utilisateurs inscrits à une cohorte. Les champs sont optionnels, mais au moins un doit être fourni :
{
"id": "7IoopVM73nHZMhUaQ3JvWw%3d%3d",
"filterDate": "YYYY-MM-DDTHH:MM:SSZ",
"filterIncludeDisabled" : true
}
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique du programme de formation. | |
filterDate | Date d'inscription de l'utilisateur. La méthode retourne la liste des inscriptions effectuées après la date passée comme filtre. (String YYYY-MM-DDTHH:MM:SSZ) | |
filterIncludeDisabled | Filtre permettant d'inclure les inscriptions les utilisateurs qui ont été désinscrits.
|
Réponse
Exemple du contenu d'appel de réponse de requête des informations liste d'utilisateurs inscrits à une cohorte :
[
{
"userId": "LGKfjxcqN18BWQ9HM%2fYBMQ%3d%3d",
"firstName": "Jacques",
"lastName": "Bonaventure",
"billingId": "GHJfC4VuX1cYpJdrd7xzrA%3d%3d",
"status": 1,
"creationDate": "2024-03-06T13:51:45.983",
"subscriptionDate": "2024-03-06T13:51:45.983",
"roleId": "n8%2fYjDQpXpCCzeBXIJuS7w%3d%3d"
},
{
"userId": "LGKfjxcqN18BWQ9HM%2fYBMQ%3d%3d",
"firstName": "Maryse",
"lastName": "Laframboise",
"billingId": "JyA5JpRh35MX83rrun7sfw%3d%3d",
"status": 1,
"creationDate": "2024-02-06T08:36:30.617",
"subscriptionDate": "2024-02-06T08:36:30.617",
"roleId": "n8%2fYjDQpXpCCzeBXIJuS7w%3d%3d"
}
]
Description des champs
Nom | Obligatoire | Commentaires/description |
userId | Identifiant unique de l'utilisateur. (Type String) | |
firstName | Prénom de l'utilisateur inscrit. (Type String) | |
lastName | Nom de famille de l'utilisateur inscrit. (Type String) | |
billingId | Identifiant unique de l'inscription de l'utilisateur. (Type String) | |
status | Statut de l’inscription
(Type Number) | |
creationDate | Date d'inscription de l'utilisateur, date de l'inscription initiale. (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 unique du rôle de l’utilisateur inscrit. (Type String) |
Cohort/subscribeuser
Permet d'inscrire un utilisateur à une cohorte de votre environnement. |
Requête
Exemple de contenu d'appel de requête d'inscription d'un utilisateur à une cohorte.
{
"id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
"userId": "5G5hg343fggalp4JQ%3d%3d",
"subscriptionDate": "2021-02-22T09:30:00.000"
}
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique de la cohorte. |
userId | X | Identifiant unique de l'utilisateur. (Type String) |
subscriptionDate | Permet de spécifier une date d'inscription. Si aucune n'est spécifiée, la date et l'heure de l'appel vont être utilisés. Si vous changez la date avec le même appel, la date d'inscription sera mise à jour. (String YYYY-MM-DDTHH:MM:SSZ) |
Réponse
Exemple du contenu d'appel de réponse de requête d'inscription d'un utilisateur à une cohorte :
{
"id": "06tCdKtg%2bvnVpQYJOWhXAQ%3d%3d"
}
Description des champs
Nom | Obligatoire | Commentaires/description |
Id | Identifiant unique de la cohorte. (Type String) |
Cohort/subscribeusers
Permet d'inscrire des utilisateurs à une cohorte de votre environnement. |
Requête
Exemple de contenu d'appel de requête d'inscription d'utilisateurs à une cohorte.
{
"id" : "2WYVweCCZqYONzOvft3LZQ%3d%3d",
"userIds" : [
"32hdyyJ%2brWlI5nnr1IoncQ%3d%3d",
"l8Lf1hYHzqpK4x%2fVfaDfRw%3d%3d"
],
"subscriptionDate": "2021-02-22T09:30:00.000"
}
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique de la cohorte. |
userIds | X | Identifiants uniques des utilisateurs. (Type String) |
subscriptionDate | Permet de spécifier une date d'inscription. Si aucune n'est spécifiée, la date et l'heure de l'appel vont être utilisés. Si vous changez la date avec le même appel, la date d'inscription sera mise à jour. (String YYYY-MM-DDTHH:MM:SSZ) |
Réponse
Exemple du contenu d'appel de réponse de requête d'inscription d'utilisateurs à une cohorte :
{
"id" : "2WYVweCCZqYONzOvft3LZQ%3d%3d"
}
Description des champs
Nom | Obligatoire | Commentaires/description |
Id | Identifiant unique de la cohorte. (Type String) |
Cohort/unsubscribeusers
Permet de désinscrire des utilisateurs d'une cohorte de votre environnement. |
Requête
Exemple de contenu d'appel de requête de désinscription d'utilisateurs d'une cohorte.
{
"id" : "2WYVweCCZqYONzOvft3LZQ%3d%3d",
"userIds" : [
"32hdyyJ%2brWlI5nnr1IoncQ%3d%3d",
"l8Lf1hYHzqpK4x%2fVfaDfRw%3d%3d"
]
}
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique de la cohorte. |
userIds | X | Identifiants uniques des utilisateurs. (Type String) |
Réponse
Exemple du contenu d'appel de réponse de requête de désinscription d'utilisateurs d'une cohorte :
{
"id" : "2WYVweCCZqYONzOvft3LZQ%3d%3d"
}
Description des champs
Nom | Obligatoire | Commentaires/description |
Id | Identifiant unique de la cohorte. (Type String) |
Cohort/getuserdetailedprogress
Permet d'obtenir les détails d'inscription et de progression d'un utilisateur inscrit à une cohorte de votre environnement. |
Requête
Exemple de contenu d'appel de requête des détails d'inscription et de progression d'un utilisateur inscrit à une cohorte de votre environnement :
{
"id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
"billingId": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d"
}
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique de la cohorte. |
billingId | X | Identifiant unique de l'inscription. (Type String) |
Réponse
Exemple du contenu d'appel de réponse de requête des détails d'inscription et de progression d'un utilisateur inscrit à une cohorte de votre environnement :
{
"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",
"autodeclarationId": "",
"billingId": "dWSVQtK7g%2fscn9WVxXmoAg%3d%3d",
"commitmentId": "DR3465g7ssas3dfv35ghj",
"name": "#JG",
"credits": 9.55,
"creditsObtained": 9.55,
"progressPercent": 100,
"isCompleted": true,
"isSuccess": true,
"isRequired": true
}, {
"id": "8VEjbODj%2fMTeWWFKtYI58Q%3d%3d",
"workspaceInstanceId": "",
"autodeclarationId": "3xYFzaDYQsqn0YTlFjAeFw%3d%3d",
"billingId": "",
"commitmentId": null,
"name": "formation 2",
"credits": 3.00,
"creditsObtained": 3.00,
"progressPercent": 100,
"isCompleted": true,
"isSuccess": true,
"isRequired": false
}]
}, {
"id": "uprlbtvuqNuwmncYPu1ljg%3d%3d",
"name": "Bloc 2",
"amountRequired": 5.00,
"amountObtained": 0,
"progressPercent": 0,
"workspaces": [{
"id": "5EJOaP8xOZr0tq%2fLtdU3Og%3d%3d",
"workspaceInstanceId": "",
"autodeclarationId": "",
"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",
"autodeclarationId": "",
"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",
"autodeclarationId": "",
"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. |
billingId |
| Identifiant unique de l’inscription à la cohorte. |
userId |
| Identifiant unique de l’utilisateur. |
commitmentId |
| Identifiant unique de l’engagement relié à la cohorte. |
progressPercent |
| Pourcentage de progression de l’utilisateur à la cohorte. |
excAccCredits |
| Nombre de crédits excédentaires cumulé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. |
isCompleted |
| État de complétion de la cohorte de l’inscription.
|
isSuccess |
| Indique si la cohorte a été complétée avec succès.
(Type Boolean) |
completionDate |
| Date de completion. |
manualCompletionDate |
| Date à laquel la complétion s’est effectué manuellement par un administrateur. Vide si complété autrement. |
modificationDate |
| Dernière date de modification de la complétion. |
modifiedByUserId |
| Identifiant unique de l’utilisateur ayant modifié la complétion manuellement. |
certificateId |
| Identifiant unique de l'attestation associée à la completion. |
blocks |
| Liste de progression détaillée des blocs de la cohorte. |
blocks.id |
| Identifiant unique du bloc de la cohorte. |
blocks.name |
| Nom du bloc. |
blocks.amountRequired |
| Nombre de formations ou de crédits requis pour la complétion du bloc. |
blocks.amountObtained |
| Nombre de formations ou de crédits obtenu pour la complétion du bloc. |
blocks.progressPercent |
| Progression de l’utilisateur dans le bloc. |
blocks.workspaces |
| Liste de progression détaillée des formations auxquelles l’utilisateur est inscrit dans le bloc. |
blocks.workspaces.id |
| Identifiant unique de la formation. |
blocks.workspaces.workspaceInstanceId |
| Identifiant unique de la session à laquelle l’utilisateur est inscrit. |
blocks.workspaces.autodeclarationId | Identifiant unique de l'autodéclaration faite par l'utilisateur dans le bloc. | |
blocks.workspaces.billingId |
| Identifiant unique de l’inscription de l’utilisateur à la session. |
blocks.workspaces.commitmentId |
| Identifiant unique de l’engagement associé à la formation. |
blocks.workspaces.name |
| Nom de la formation. |
blocks.workspaces.credits |
| Nombre de crédits associés à la réussite de cette formation. |
blocks.workspaces.creditsObtained |
| Nombre de crédits obtenus à la suite de la réussite de cette formation. |
blocks.workspaces.progressPercent |
| Pourcentage de progression de l’utilisateur dans la session. |
blocks.workspaces.isCompleted |
| État de complétion de la session.
|
blocks.workspaces.isSuccess |
| Type de succès de la complétion de la session.
(Type Boolean) |
blocks.workspaces.isRequired |
| Indique si la complétion de cette formation est requise pour le bloc.
(Type Boolean) |
Cohort/linksubscriptiontoblock
Permet d'associer une inscription existante à un bloc d'une cohorte de votre environnement. Cet appel sert à des cas spécifiques lorsqu'une inscription n'est pas reconnue dans un contexte de programme pour un utilisateur. |
Requête
Exemple de contenu d'appel de requête de liaison d'une inscription dans un bloc d'une cohorte :
{ "billingId": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d", "workspaceBillingId": "%2bcSfyhuuFvha809UcfbkJw%3d%3d", "targetBlockId": "TRXbb9r1WIhbXuvpujVt0Q%3d%3d" }
Description des champs
Nom | Obligatoire | Commentaires/description |
billingId | X | Identifiant unique de l'inscription de l'utilisateur à la cohorte. |
workspaceBillingId | X | Identifiant unique de l'inscription à la session à lier au bloc. (Type String) |
targetBlockId | X | Identifiant unique du bloc auquel associer l'inscription à la session. (Type String) |
Réponse
Exemple du contenu d'appel de réponse de requête de liaison d'une inscription dans un bloc d'une cohorte :
{ "id" : "%2bcSfyhuuFvha809UcfbkJw%3d%3d" }
Description des champs
Nom | Obligatoire | Commentaires/description |
Id | Identifiant unique de l'inscription. (Type String) |
Cohort/unlinksubscriptionfromblock
Permet de dissocier une inscription existante d'un bloc d'une cohorte de votre environnement. Cet appel sert à des cas spécifiques lorsqu'une inscription ne doit pas être reconnue dans un contexte de programme pour un utilisateur. |
Requête
Exemple de contenu d'appel de requête de déliaison d'une inscription d'un bloc d'une cohorte :
{ "billingId": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d", "workspaceBillingId": "%2bcSfyhuuFvha809UcfbkJw%3d%3d" }
Description des champs
Nom | Obligatoire | Commentaires/description |
billingId | X | Identifiant unique de l'inscription de l'utilisateur à la cohorte. |
workspaceBillingId | X | Identifiant unique de l'inscription à la session à délier du bloc. (Type String) |
Réponse
Exemple du contenu d'appel de réponse de requête de déliaison d'une inscription d'un bloc d'une cohorte :
{ "id" : "%2bcSfyhuuFvha809UcfbkJw%3d%3d" }
Description des champs
Nom | Obligatoire | Commentaires/description |
Id | Identifiant unique de l'inscription déliée. (Type String) |
Cohort/transfersubscriptiontoblock
Permet de transférer une inscription existante d'un bloc d'une cohorte de votre environnement vers un autre bloc. Cet appel sert à des cas spécifiques lorsqu'une inscription ne doit pas être reconnue dans un bloc de programme pour un utilisateur, mais bien dans un autre. |
Requête
Exemple de contenu d'appel de requête de transfert d'une inscription d'un bloc d'une cohorte vers un autre bloc :
{ "billingId": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d", "workspaceBillingId": "%2bcSfyhuuFvha809UcfbkJw%3d%3d", "targetBlockId": "TRXbb9r1WIhbXuvpujVt0Q%3d%3d", "targetBillingId": "7kGFIIstMwCbP4W3td0G5w%3d%3d" }
Description des champs
Nom | Obligatoire | Commentaires/description |
billingId | X | Identifiant unique de l'inscription de l'utilisateur à la cohorte. |
workspaceBillingId | X | Identifiant unique de l'inscription à la session à transférer. (Type String) |
targetBlockId | X | Identifiant unique du bloc de la cohorte auquel lier l’inscription. |
targetBillingId | Identifiant unique de l’inscription à la cohorte vers laquelle transférer l’inscription à la formation. |
Réponse
Exemple du contenu d'appel de réponse de requête de transfert d'une inscription d'un bloc d'une cohorte vers un autre bloc :
{ "id": "%2bcSfyhuuFvha809UcfbkJw%3d%3d" }
Description des champs
Nom | Obligatoire | Commentaires/description |
Id | Identifiant unique de l'inscription transférée. (Type String) |
Cohort/getcompletion
Permet d'obtenir des informations sur la complétion d'un utilisateur à une cohorte de votre environnement. |
Requête
Exemple de contenu d'appel de requête des informations sur la complétion d'un utilisateur à une cohorte de votre environnement :
{ "id": "7Zi3zYvuHTZ7YsdfsdLK7TQjdlQ%3d%3d" }
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique de l'inscription de l'utilisateur à la cohorte. |
Réponse
Exemple du contenu d'appel de réponse de requête des informations sur la complétion d'un utilisateur à une cohorte de votre environnement :
{ "id": "vrj0IrWe0HasdFg%2bK9OKGpDFdfg5A%3d%3d", "billingId": "7Zi3zYvuHTZ7YsdfsdLK7TQjdlQ%3d%3d ", "userId": "%2bgdfgGMWE4uzG6RLeasdKzgpoz%2bLQ%3d%3d", "progressPercent": 0, "isCompleted": true, "isSuccess": true, "completionDate": "2024-02-22T08:39:35.617", "manualCompletionDate": "2021-02-22T08:39:35.617", "modifiedByUserId": "DR7sYn48%2fuasdgfzi3b4fTGZ1nQdf%3d%3d", "modificationDate": "2024-03-27T14:23:39.38", "certificateId": "gQ7xp1ryuU4Z88utY825mQj2Qha" }
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique de la cohorte. (Type String) | |
billingId | Identifiant unique de l’inscription de l’utilisateur. | |
userId | Identifiant unique de l’utilisateur. (Type String) | |
progressPercent | Indique le taux de complétion de l’utilisateur dans la cohorte. | |
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 demeurera à zéro. (Type Number) | |
isCompleted | Indique si l'utilisateur a complété la cohorte.
(Type Booléen) | |
isSucces | Indique si l'utilisateur a complété avec succès la cohorte, si complété.
(Type Booléen) | |
completionDate | Date de completion de la cohorte par l’utilisateur. (String YYYY-MM-DDTHH:MM:SSZ) | |
manualCompletionDate | Date à laquel la complétion a été modifiée manuellement par un administrateur. La valeur sera absente si la complétion s'est effectuée autrement. (String YYYY-MM-DDTHH:MM:SSZ) | |
modificationDate | Date de la dernière modification de la complétion. | |
modifiedByUserId | Identifiant unique de l’utilisateur ayant modifié la complétion manuellement. | |
certificateId | Identifiant unique de l'attestation émise lors de la complétion de la cohorte. (Type String) |
Cohort/setcompletion
Permet de définir les informations sur la complétion d'un utilisateur à une cohorte de votre environnement. |
Requête
Exemple de contenu d'appel de requête de modification des informations sur la complétion d'un utilisateur à une cohorte de votre environnement :
{ "id": "7Zi3zYvuHTZ7YsdfsddfgLK7TQjdlQ%3d%3d" "isCompleted": true, "isSuccess": true, "completionDate": "2024-02-17T15:04:06.687" }
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique de l'inscription de l'utilisateur à la cohorte. |
isCompleted | X | Indique si l'utilisateur a complété la cohorte.
(Type Booléen) |
isSuccess | Indique si l'utilisateur a complété avec succès la cohorte, si complété.
(Type Booléen) | |
CompletionDate | Date de completion de la cohorte par l’utilisateur. (String YYYY-MM-DDTHH:MM:SSZ) |
Réponse
Exemple du contenu d'appel de réponse de requête de modification des informations sur la complétion d'un utilisateur à une cohorte de votre environnement :
{ "id": "3%2b7WR6GktOVVXe7EEsy%2b4g%3d%3d", "isCompleted": true, "isSuccess": true }
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique de la cohorte. (Type String) | |
isCompleted | Indique si l'utilisateur a complété la cohorte.
(Type Booléen) | |
isSucces | Indique si l'utilisateur a complété avec succès la cohorte, si complété.
(Type Booléen) |
Cohort/getusersubscriptions
Permet d'obtenir la liste d'inscriptions à des cohortes d'un utilisateur de votre environnement. |
Requête
Exemple de contenu d'appel de requête de la liste d'inscriptions à des cohortes d'un utilisateur de votre environnement :
{ "id" : "X4xXx3cmb%2bIghRgDqzFWjg%3d%3d" }
Description des champs
Nom | Obligatoire | Commentaires/description |
id | X | Identifiant unique de l'utilisateur. |
Réponse
Exemple du contenu d'appel de réponse de requête de la liste d'inscriptions à des cohortes d'un utilisateur de votre environnement :
[ { "id": "nhballNGFCIDULtrCj9vqg%3d%3d", "billingId": "6Z4N%2btR63WqvFjxH%2bZ1fkA%3d%3d", "subscriptionDate": "2022-10-10T00:00:00" }, { "id": "Pf09tOl0SkMVF%2bXe%2bO9sDA%3d%3d", "billingId": "l2hplw8e7%2fZzyGbVqtJUEQ%3d%3d", "subscriptionDate": "2023-06-12T13:41:02.767" } ]
Description des champs
Nom | Obligatoire | Commentaires/description |
id | Identifiant unique de la cohorte. (Type String) | |
bilingId | Identifiant unique de l'inscription à la cohorte. | |
subscriptionDate | Date d'inscription |
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. |