PROGRAMMES DE FORMATION
Un « programme de formation » regroupe plusieurs formations en un parcours structuré auquel les utilisateurs s'inscrivent par cohortes. Il est représenté par une tuile au catalogue et peut émettre une attestation lorsqu'il est complété. Un programme de formation dans l'API est nommé « program ». |  |
Programmes de formation : program/get
https://www.domaine.com/lmsapi/program/get
 | Retourne un objet représentant un programme de formation de votre environnement. |
Requête
Exemple de contenu d'appel de requête des informations pour un programme de formation :
{
"id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d"
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| id | X | Identifiant unique du programme de formation. (Type string) |
Réponse
Exemple de contenu d'appel de réponse des informations pour un programme de formation :
{
"id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
"creationDate": "2018-11-20T09:30:19.417",
"name": "Programme de Test",
"minParticipants": 4,
"maxParticipants": 0,
"description": "",
"coverId": "",
"subscriptionType": 0,
"enrolmentType": 0,
"authorizationType": 0,
"needAdminApproval": true,
"visibilityType": 0,
"startDate": "0001-01-01T00:00:00",
"endDate": "0001-01-01T00:00:00",
"showAvailableSubscriptions": true,
"providerId": "eYlMGw7Dsq7EEUb%2f7tbtNg%3d%3d",
"certificateId": "",
"categoryId": "eWAFhEFBmzdeDcziVz93Ag%3d%3d",
"credits": 0.00,
"keywords": "",
"createdByUserID": "4zwet3FOX5xXfHX7YFuR8w%3d%3d",
"shortDescription": "",
"status": 0,
"language": 1,
"externalLink": "",
"taxEnabled": true,
"isSinglePayment": true,
"expirationType": 0,
"daysToComplete": 0,
"dateToComplete": "0001-01-01T00:00:00",
"catalogLink": "UrlToPublicCatalog",
"lastModificationDate": "0001-01-01T00:00:00",
"taxCountryId": 123,
"taxStateId": 321,
"customFields": {
"Champ1": "Snow",
"Test": ""
}
}Description des champs
Nom | Commentaires/description |
id | Il s’agit de l’identifiant unique de la base de données. (Type string) |
creationDate | Date de création du programme de formation. (seulement en get) type string (YYYY-MM-DDTHH:MM:SSZ) |
name | Nom du programme de formation tel qu’affiché dans le portail. (Type string entre 5 et 250 caractères)
|
minParticipants | Nombre minimal d’utilisateurs inscrits pour que le programme de formation ait lieu. (Type Number) Valeur 0 correspond à aucun minimum |
maxParticipants | Nombre maximal d’utilisateurs qui peuvent s’inscrire (si la file d’attente n’est pas activée) (Type Number) Valeur 0 correspond à aucun maximum |
description | Description du programme de formation, ceci sera affiché dans le catalogue et dans le programme de formation. (Type string) |
coverId | L’identifiant du visuel de votre programme de formation. Votre item ne peut être associé qu’à un seul visuel (Type String). |
subscriptionType | Détermine si le programme de formation accepte les inscriptions :
|
enrolmentType | Types d’inscriptions acceptées :
|
authorizationType | Types d’autorisations acceptées :
|
| needAdminApproval | Booléen - Par défaut cette valeur est à « false ». Cette valeur définit si la formation nécessite de définir un approbateur lors de l'inscription |
visibilityType | Type de visibilité dans les catalogues
(Type Number) |
startDate
| Cette valeur est obligatoire si le SubscriptionType spécifique (2) est sélectionné. Il détermine la plage de début d’acceptation des inscriptions. (Type date YYYY-MM-DDTHH:MM:SSZ) |
endDate | Cette valeur est obligatoire si le SubscriptionType spécifique (2) est sélectionné. Il détermine la plage de fin de l’acceptation des inscriptions. (Type date YYYY-MM-DDTHH:MM:SSZ) |
showAvailableSubscriptions | Par défaut cette valeur est à « false ». Affiche le nombre de places disponibles et totales dans le catalogue lorsque les utilisateurs s’inscrivent. (Type Booléen) |
providerId | L’identifiant du fournisseur de service auquel votre programme de formation est associé. Votre item ne peut être associé qu’à un seul fournisseur de service (Type String). |
certificateId
| Identifiant du certificat associé au programme de formation. Il est décerné automatiquement selon les critères de complétion du programme de formation. (Type String) |
categoryId | L’identifiant de la catégorie à laquelle votre programme de formation est associé. Votre item ne peut être associé qu’à une seule catégorie (Type String). |
credits | Nombre de crédits associé à la réussite de ce programme de formation. (Type Number) |
keywords | Mots clefs de recherche de programme de formation. Maximum 250 caractères. |
createdByUserID | L’identifiant de l’utilisateur qui a créé le programme de formation. (Type String). |
shortDescription | Courte description du programme de formation, ceci sera affiché dans le catalogue. (Type string) |
status | Statut du programme de formation.
(Type Number) |
language | Langue du programme de formation.
(Type Number) |
externalLink | URL de redirection appliquée sur le lien « m’inscrire » pour rediriger l’utilisateur vers un site externe pour l’inscription. Maximum 250 caractères. |
taxEnabled | Indique si les taxes sont activées sur le programme de formation. (Type Boolean) |
taxCountryId | Chiffre indiquant le pays du programme de formation
Type Number (Voir Annexe 3 : Pays et États/Provinces) |
taxStateId | Chiffre indiquant l'état du programme de formation
Type Number (Voir Annexe 3 : Pays et États/Provinces) |
isSinglePayment | Indique si le paiement est effectué au niveau du programme de formation. (Type Boolean) |
expirationType | Type d’expiration pour les inscriptions des cohortes du programme de formation.
(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 de toutes les inscriptions du programme de formation. (Type Number) |
catalogLink | URL vers la page du catalogue public pour ce programme de formation. L’url donnée pointe sur le portail par défaut.
(Seulement en get) |
lastModificationDate | Date de la dernière modification du programme de formation Ne peut être modifié. Disponible sur get et getlist. |
| customFields | Champs sur mesure reliés au programme. |
Programmes de formation : program/getlist
https://www.domaine.com/lmsapi/program/getlist
| Retourne la liste de l’ensemble des programmes de formation de votre environnement. |
Requête
Exemple de contenu d'appel de requête de la liste des programmes de formation :
{
"filterDate": "YYYY-MM-DDTHH:MM:SSZ",
"filterEditDate": "YYYY-MM-DDTHH:MM:SSZ"
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| 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. Type : String (YYYY-MM-DDTHH:MM:SSZ) | |
| filterEditDate | Paramètre optionnel correspondant à 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 à un programme de formation peut correspondre à :
|
Réponse
Exemple de contenu d'appel de réponse de la liste des programmes de formation :
[
{
"id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
"creationDate": "2018-11-20T09:30:19.417",
"name": "Programme de Test",
"minParticipants": 4,
"maxParticipants": 0,
"description": "",
"coverId": "",
"subscriptionType": 0,
"enrolmentType": 0,
"authorizationType": 0,
"needAdminApproval": true,
"visibilityType": 0,
"startDate": "0001-01-01T00:00:00",
"endDate": "0001-01-01T00:00:00",
"showAvailableSubscriptions": true,
"providerId": "eYlMGw7Dsq7EEUb%2f7tbtNg%3d%3d",
"certificateId": "",
"categoryId": "eWAFhEFBmzdeDcziVz93Ag%3d%3d",
"credits": 0.00,
"keywords": "",
"createdByUserID": "4zwet3FOX5xXfHX7YFuR8w%3d%3d",
"shortDescription": "",
"status": 0,
"language": 1,
"externalLink": "",
"isSinglePayment": true,
"expirationType": 0,
"daysToComplete": 0,
"dateToComplete": "0001-01-01T00:00:00",
"catalogLink": "UrlToPublicCatalog",
"lastModificationDate": "0001-01-01T00:00:00",
"taxEnabled": true,
"taxCountryId": 123,
"taxStateId": 321,
"customFields": {
"Champ1": "Snow",
"Test": ""
}
}
]Description des champs
Nom | Commentaires/description |
id | Il s’agit de l’identifiant unique de la base de données. (Type string) |
creationDate | Date de création du programme de formation. (seulement en get) type string (YYYY-MM-DDTHH:MM:SSZ) |
name | Nom du programme de formation tel qu’affiché dans le portail. (Type string entre 5 et 250 caractères)
|
minParticipants | Nombre minimal d’utilisateurs inscrits pour que le programme de formation ait lieu. (Type Number) Valeur 0 correspond à aucun minimum |
maxParticipants | Nombre maximal d’utilisateurs qui peuvent s’inscrire (si la file d’attente n’est pas activée) (Type Number) Valeur 0 correspond à aucun maximum |
description | Description du programme de formation, ceci sera affiché dans le catalogue et dans le programme de formation. (Type string) |
coverId | L’identifiant du visuel de votre programme de formation. Votre item ne peut être associé qu’à un seul visuel (Type String). |
subscriptionType | Détermine si le programme de formation accepte les inscriptions :
|
enrolmentType | Types d’inscriptions acceptées :
|
authorizationType | Types d’autorisations acceptées :
|
| needAdminApproval | Booléen - Par défaut cette valeur est à « false ». Cette valeur définit si la formation nécessite de définir un approbateur lors de l'inscription |
visibilityType | Type de visibilité dans les catalogues
(Type Number) |
startDate
| Cette valeur est obligatoire si le SubscriptionType spécifique (2) est sélectionné. Il détermine la plage de début d’acceptation des inscriptions. (Type date YYYY-MM-DDTHH:MM:SSZ) |
endDate | Cette valeur est obligatoire si le SubscriptionType spécifique (2) est sélectionné. Il détermine la plage de fin de l’acceptation des inscriptions. (Type date YYYY-MM-DDTHH:MM:SSZ) |
showAvailableSubscriptions | Par défaut cette valeur est à « false ». Affiche le nombre de places disponibles et totales dans le catalogue lorsque les utilisateurs s’inscrivent. (Type Booléen) |
providerId | L’identifiant du fournisseur de service auquel votre programme de formation est associé. Votre item ne peut être associé qu’à un seul fournisseur de service (Type String). |
certificateId
| Identifiant du certificat associé au programme de formation. Il est décerné automatiquement selon les critères de complétion du programme de formation. (Type String) |
categoryId | L’identifiant de la catégorie à laquelle votre programme de formation est associé. Votre item ne peut être associé qu’à une seule catégorie (Type String). |
credits | Nombre de crédits associé à la réussite de ce programme de formation. (Type Number) |
keywords | Mots clefs de recherche de programme de formation. Maximum 250 caractères. |
createdByUserID | L’identifiant de l’utilisateur qui a créé le programme de formation. (Type String). |
shortDescription | Courte description du programme de formation, ceci sera affiché dans le catalogue. (Type string) |
status | Statut du programme de formation.
(Type Number) |
language | Langue du programme de formation.
(Type Number) |
externalLink | URL de redirection appliquée sur le lien « m’inscrire » pour rediriger l’utilisateur vers un site externe pour l’inscription. Maximum 250 caractères. |
taxEnabled | Indique si les taxes sont activées sur le programme de formation. (Type Boolean) |
taxCountryId | Chiffre indiquant le pays du programme de formation
Type Number (Voir Annexe 3 : Pays et États/Provinces) |
taxStateId | Chiffre indiquant l'état du programme de formation
Type Number (Voir Annexe 3 : Pays et États/Provinces) |
isSinglePayment | Indique si le paiement est effectué au niveau du programme de formation. (Type Boolean) |
expirationType | Type d’expiration pour les inscriptions des cohortes du programme de formation.
(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 de toutes les inscriptions du programme de formation. (Type Number) |
catalogLink | URL vers la page du catalogue public pour ce programme de formation. L’url donnée pointe sur le portail par défaut.
(Seulement en get) |
lastModificationDate | Date de la dernière modification du programme de formation Ne peut être modifié. Disponible sur get et getlist. |
| customFields | Champs sur mesure reliés au programme. |
Programmes de formation : program/geturl
https://www.domaine.com/lmsapi/program/geturl
| Retourne la liste des url de catalogue public pour ce programme de formation. |
Requête
Exemple de contenu d'appel de requête de la liste des url de catalogue public pour un programme de formation :
{
"id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
"filterId" : "aoflemrnQ2A8DFaNy22zA%3d%3d"
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| id | X | Identifiant unique du programme de formation. (Type string) |
| filterId | Identifiant de portail permettant de ne recevoir que l’url de ce programme de formation pour ce portail spécifique. (Type string) |
Réponse
Exemple de contenu d'appel de réponse de la liste des url de catalogue public pour un programme de formation :
[
{
"portalId": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
"url": "UrlPourLePortail"
},
{
"portalId": "h89s6rd8hVQ2A8DFaNy22zA%3d%3d",
"url": "UrlPourLePortail"
}
]Description des champs
| Nom | Commentaires/description |
| portalId | Identifiant unique du portail pour lequel l’url est retournée. (Type string) |
| url | URL vers la page du catalogue public de ce programme de formation pour le portail correspondant. (Type string) |
Programmes de formation : program/getadminbranches
https://www.domaine.com/lmsapi/program/getadminbranches
| Retourne la liste des branches administratives associées à un programme de formation. |
Requête
Exemple de contenu d'appel de requête de la liste des branches administratives associées à un programme de formation :
{
"id": "68a9Y6p%2bhVsJJBRcIMOo0w%3d%3d"
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| id | X | Identifiant unique du programme de formation. (Type string) |
Réponse
Exemple de contenu d'appel de réponse de la liste des branches administratives associées à un programme de formation :
[
"vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d",
"6d7yavtJwLemtOAO2HF5BQ%3d%3d"
]Description des champs
| Nom | Commentaires/description |
| branches | Liste des identifiants uniques des branches administratives associées au programme de formation. (Type liste de string) |
Programmes de formation : program/addadminbranches
https://www.domaine.com/lmsapi/program/addadminbranches
| Permet d'ajouter des branches administratives à un programme de formation. |
Requête
Exemple de contenu d'appel de requête d'ajout de branches administratives à un programme de formation :
{
"id": "68a9Y6p%2bhVsJJBRcIMOo0w%3d%3d",
"branches": [
"vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d",
"6d7yavtJwLemtOAO2HF5BQ%3d%3d"
]
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| id | X | Identifiant unique du programme de formation. (Type string) |
| branches | X | Liste des identifiants uniques des branches administratives. (Type liste de string) |
Réponse
Exemple de contenu d'appel de réponse d'ajout de branches administratives à un programme de formation :
{
"id": "68a9Y6p%2bhVsJJBRcIMOo0w%3d%3d"
}Description des champs
| Nom | Commentaires/description |
| id | Identifiant unique du programme de formation auquel les branches ont été ajoutées. (Type string) |
Programmes de formation : program/removeadminbranches
https://www.domaine.com/lmsapi/program/removeadminbranches
| Permet d'enlever des branches administratives d'un programme de formation. |
Requête
Exemple de contenu d'appel de requête de retrait de branches administratives d'un programme de formation :
{
"id": "68a9Y6p%2bhVsJJBRcIMOo0w%3d%3d",
"branches": [
"vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d",
"6d7yavtJwLemtOAO2HF5BQ%3d%3d"
]
}Description des champs
| Nom | Obligatoire | Commentaires/description |
| id | X | Identifiant unique du programme de formation. (Type string) |
| branches | X | Liste des identifiants uniques des branches administratives. (Type liste de string) |
Réponse
Exemple de contenu d'appel de réponse de retrait de branches administratives d'un programme de formation :
{
"id": "68a9Y6p%2bhVsJJBRcIMOo0w%3d%3d"
}Description des champs
| Nom | Commentaires/description |
| id | Identifiant unique du programme de formation auquel les branches ont été enlevées. (Type string) |
Description des codes d’erreurs de programme de formation
Numéro | Message | Commentaires/description |
1400 | Required id | Vous devez fournir un identifiant pour le programme de formation. |
1401 | Invalid id | L’identifiant fourni pour le programme de formation est invalide. |
1402 | Invalid filterId | L’identifiant donné pour effectuer le filtre est invalide. |
| 1405 | Invalid name length | Le nom du programme de formation fourni doit contenir entre 3 et 250 caractères inclusivement. |
1432 | Missing required branches | Le paramètre « branches » est obligatoire. |
1433 | Invalid branchId | Un identifiant de branche est invalide. |
1434 | Cannot remove all branches | Impossible de supprimer toutes les branches administratives d’un programme. |
| 1435 | Cannot add branches | Impossible d'ajouter les branches administratives à un programme, car il y a des branches déjà ajoutées. |
| 1436 | Cannot remove branches | Impossible de supprimer les branches administratives d'un programme, car il y a des branches qui ne sont pas associées. |
| 1437 | Invalid language | La valeur fournie pour la langue est invalide. |
| 1438 | Invalid authorizationType | La valeur fournie pour le type d'autorisation ne concorde pas avec les renseignements fournis |