Formations et événements (Lära)

Créé par Miro Lagueux, Modifié le Mer, 26 Août à 1:08 H par Miro Lagueux

Formations et événements

Une « Formation » ou un « Événement » sont représentés par des tuiles au catalogue et peuvent émettre une attestation lorsqu'une de leur sessions est complétée. Elles sont nommées « workspace » dans l'API.

Formations et événements : Workspace/get

Permet d'obtenir des informations sur une formation existante.
Adresse de l'appel API : https://.../lmsapi/workspace/get

Requête

Exemple de contenu d'appel de requête des informations sur une formation :

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

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de la formation. (Type string)

Réponse

Exemple du contenu d'appel de réponse de requête des informations sur une formation :

 {
  "id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
  "websiteId": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
  "creationDate": "2016-11-16T14:52:27.353",
  "name": "Ma formation",
  "categoryId": "",
  "coverId": "",
  "visibilityType": 0,
  "maxParticipants": 0,
  "minParticipants": 0,
  "type": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
   "providerId" : "Mw1VQ2A8DFaNy22zA%3d%3d",
  "language": 1,
  "description": "",
  "shortDescription": "",
  "subscriptionType": 0,
  "startDate": "0001-01-01T00:00:00",
  "endDate": "0001-01-01T00:00:00",
  "isOverBookingSubscription": true,
  "authorizationType": 0,
  "needAdminApproval": true,
  "enrolmentType": 0,
  "externalLink": "monURL",
  "catalogLink": "UrlToPublicCatalog",
  "keywords": "mot,clef,formation",
  "showAvailableSubscriptions": true,
  "certificateId": "",
  "credits": 0.0,
  "nbUsersSubbed": -1,
  "nbUsersQueue": -1,
  "instanceDaysAvailable": 365,
  "instanceDaysToComplete": 180,
  "isAutodeclaration": true,
  "accreditationNumber": "12345-e",
  "autodeclarationStartDate": "0001-01-01T00:00:00",
  "autodeclarationEndDate": "0001-01-01T00:00:00",
  "autodeclarationOrganization": "",
  "autodeclarationApprovalRequired": true,
  "autodeclarationProofUpload": true,
  "autodeclarationProofRequired": true,
  "autodeclarationWorkspaceAndOrganizationEditable": false,
  "autodeclarationSolemnDeclaration": true,
  "autodeclarationPrice": 15.5,
  "lastModificationDate": "0001-01-01T00:00:00",
  "taxEnabled": true,  
  "taxCountryId": 123,  
  "taxStateId": 321,
  "isPlannedActivityDisplayInCatalog": true,
  "isCreditCategorySplitManually": false,
  "canDeclareMultipleTimes": false,
  "autodeclarationPresenceActivitiesRequired": true,
  "customFields": {
    "Champ1": "Snow",
    "Test": ""
  }

}

Description des champs

Nom	Commentaires/description
id	Il s’agit de l’identifiant unique de la base de données. Ce paramètre doit être vide lorsque la méthode WorkspaceCreate est utilisée, mais obligatoire pour appeler WorkspaceEdit. (Type string)
websiteId	Il s’agit de l’identifiant unique utilisé lors de l’accès aux pages du portail.
creationDate	Date de création du workspace, (seulement en get) type string (YYYY-MM-DDTHH:MM:SSZ)
type	Identifiant unique du type de la formation ou de l’événement. Référez-vous à la page d’édition du type désiré pour récupérer cet identifiant ou à workspace/gettypes
name	Nom de la formation/événement tel qu’affiché dans le portail (Type string entre 5 et 250 caractères)
language	Langue de la formation ou de l’événement 1 = Français (Canada) 2 = Anglais 3 = Français (France) 4 = Espagnol (Type Number)
categoryId	L’identifiant de la catégorie à laquelle votre item formation ou événement est associé. Si plusieurs catégories sont déjà définies, celles-ci seront effacées pour ne conserver que cette catégorie. Retourne l'identifiant de la première catégorie associée. (Type String).
coverId	L’identifiant du visuel de votre formation. Votre item ne peut être associé qu’à un seul visuel (Type String).
providerId	L’identifiant du fournisseur de service auquel votre item formation ou événement est associé. Votre item ne peut être associé qu’à un seul fournisseur de service (Type String). En create, le fournisseur de service par défaut est considéré.
visibilityType	Type de visibilité dans les catalogues 0 = PublicVisibility = public, visiteurs non authentifiés 1 = AuthenticatedVisibility = utilisateurs authentifiés 2 = SubscribedVisibility = utilisateurs inscrits seulement 3 = MaskedVisibility = masqué (Type Number)
maxParticipants	Nombre maximal d’utilisateurs qui peuvent d’inscrire (si la file d’attente n’est pas activée) (Type Number) Valeur 0 correspond à aucun maximum
minParticipants	Nombre minimal d’utilisateurs inscrit pour que la formation ait lieu. (Type Number) Valeur 0 correspond à aucun minimum
description	Description de la formation, ceci sera affiché dans le catalogue et dans la formation. (Type string)
shortDescription	Courte description de la formation, ceci sera affiché dans le catalogue. (Type string)
subscriptionType	Détermine si l’événement ou la formation acceptent les inscriptions : 0 = Ouvert aux inscriptions (valeur par défaut) 1 = Fermé 2 = Ouvert aux inscriptions pour une période spécifique
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)
isOverBookingSubscription	Booléen - ceci active la file d’attente. La valeur par défaut est à false.
authorizationType	Types d’autorisations acceptées : 0 = Approbation par un administrateur 1 = Automatique
needAdminApproval	Booléen - Par défaut cette valeur est à « false ». Cette valeur definie si la formation nécessite de définir un approbateur lors de l'inscription.
enrolmentType	Types d’inscriptions acceptées : 0 = Auto-inscription 1 = Manuelle (administrative) 2 = Externe
externalLink	URL de redirection appliqué sur le lien « m’inscrire » pour rediriger l’utilisateur vers un site externe pour l’inscription. Maximum 250 caractères.
catalogLink	URL vers la page du catalogue public pour cette formation. Le URL donné pointe sur le portail par défaut. (Seulement en get)
keywords	Mots clefs de recherche de formation. Maximum 250 caractères.
showAvailableSubscriptions	Booléen - Par défaut cette valeur est à « false ». Affiche le nombre de places disponibles et totales dans le catalogue lorsque les utilisateurs s’inscrivent.
certificateId	Identifiant du certificat associé à la formation où l’événement. Il est décerné automatiquement selon les critères de complétion du workspace. (Type String)
credits	Nombre de crédit associé à la réussite de cette formation. Ne peut pas être spécifié si la formation ou l'événement possède déjà plusieurs catégories. Type Number
nbUsersSubbed	Valeur seulement disponible en GET permettant d’obtenir le nombre d’utilisateurs inscrits pour l’ensemble des sessions de la formation ou de l’événement Type Number
nbUsersQueue	Valeur seulement disponible en GET permettant d’obtenir le nombre d’utilisateurs en file d’attente pour l’ensemble des sessions de la formation ou de l’événement Type Number
instanceDaysAvailable	Détermine le nombre de jours après l’inscription d’un utilisateur où ce dernier a accès au contenu. Cette valeur peut être redéfinie pour chaque session. Valeur 0 correspond à toujours accessible
instanceDaysToComplete	Détermine le nombre de jours maximal après l’inscription d’un utilisateur où ce dernier doit avoir complété le contenu. Cette valeur peut être redéfinie pour chaque session. Valeur 0 correspond à aucune date limite de complétion
isAutodeclaration	Détermine si le Workspace peut servir de modèle pour autodéclarer une accréditation. Type Boolean
accreditationNumber	Détermine le numéro d’accréditation lors d’une Autodéclaration Obligatoire si isAutodeclaration* est à True seulement*
autodeclarationStartDate	Détermine la date limite inférieure pour autodéclarer ce workspace comme une accréditation. (Type date YYYY-MM-DDTHH:MM:SSZ)
autodeclarationEndDate	Détermine la date limite supérieure pour autodéclarer ce workspace comme une accréditation. (Type date YYYY-MM-DDTHH:MM:SSZ)
autodeclarationOrganization	Détermine le nom de l’organisation par défaut à afficher lors d’une nouvelle autodéclaration.
autodeclarationApprovalRequired	Détermine si l’autodéclaration doit être approuvée par un administrateur
autodeclarationProofUpload	Détermine si l’autodéclaration permet le téléversement de pièces justificatives
autodeclarationProofRequired	Détermine si l’autodéclaration exige le téléversement de pièces justificatives
autodeclarationSolemnDeclaration	Détermine si l’autodéclaration exige une déclaration solennelle de la part de l’utilisateur avant d’être soumise
autodeclarationPrice	Indique le prix de l'autodéclaration. Laisser vide si l'autodéclaration est désactivée ou gratuite. Type : décimal
catalogId	Seulement à la création de formation/événement. Identifiant du catalogue auquel on veut ajouter cette formation/événement.
lastModificationDate	Date de la dernière modification de la formation 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)
isPlannedActivityDisplayInCatalog	Permet d'afficher les activités planifiées ou non dans le catalogue.
categories	Liste des catégories pouvant catégoriser la formation ou l'événement. Le nombre de crédits que vaut la formation ou l'événement peut être défini pour chaque catégories associées.
isCreditCategorySplitManually	Détermine si la répartition des crédits dans les différentes catégories est gérée manuellement ou pas
canDeclareMultipleTimes	Détermine si la formation peut être autodéclarée plusieurs fois par le même utilisateur (Dans un contexte de programme ou de règlement)
autodeclarationPresenceActivitiesRequired	Détermine si l’autodéclaration exige la saisie d'activités ou d'ateliers. Par défaut cette valeur est à « true» lorsque le champ isAutodeclaration est à « true». (Type Boolean)
autodeclarationWorkspaceAndOrganizationEditable	Détermine si l'autodéclaration exige que l'utilisateur entre manuellement le titre de la formation et le nom de l'organisation. Par défaut cette valeur est à « false» lorsque le champ isAutodeclaration est à « true». (Type Boolean)
isRecognizedInCycle	Détermine si la formation est reconnue dans les règlements. Par défaut cette valeur est à « true» lors de la création. (Type Boolean)

Formations et événements : workspace/getlist

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

Permet d'obtenir la liste de l’ensemble des formations et événements.
Adresse de l'appel API : https://.../lmsapi/workspace/getlist

Requête

Exemple de contenu d'appel de requête des informations sur une liste de formation :

{
  "filterDate": “YYYY-MM-DDTHH:MM:SSZ”,
  "filterEditDate": “YYYY-MM-DDTHH:MM:SSZ”
}

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.

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

Modification des paramètres administratifs de la formation;
Ajout, retrait de catalogues;
Ajout, retrait d’équivalences;

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

Note: Au moment de la création, la date de modification sera aussi mise à jour au même moment.

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. Type: String (YYYY-MM-DDTHH:MM:SSZ)

Réponse

Exemple de contenu d'appel de réponse des informations sur une liste de formation :

[
    {
        "id": "U81AT3R55%2bykP3AsmHqhXw%3d%3d",
        "websiteId": "d4cRnrPVqw1M7s6vlDo%2bCw%3d%3d",
        "creationDate": "2019-07-31T09:59:29.033",
        "type": "cifkD36ecwRFOjpZouBG9w%3d%3d",
        "name": "Conférence annuelle",
        "active": false,
        "language": 1,
        "categoryId": "zPX7k7Km0Do8l2VO6H0fHQ%3d%3d",
        "categories": [
            {
                "id": "zPX7k7Km0Do8l2VO6H0fHQ%3d%3d",
                "credits": 18.0
            }
        ],
        "isCreditCategorySplitManually": false,
        "providerId": "BjUWWGtm6EWiymvxCSL%2bbg%3d%3d",
        "visibilityType": 0,
        "maxParticipants": 150,
        "minParticipants": 0,
        "description": "",
        "shortDescription": "",
        "subscriptionType": 1,
        "startDate": "0001-01-01T00:00:00",
        "endDate": "0001-01-01T00:00:00",
        "isOverBookingSubscription": true,
        "authorizationType": 1,
        "needAdminApproval": false,
        "enrolmentType": 0,
        "keywords": "Conférence 2019",
        "showAvailableSubscriptions": false,
        "certificateId": "lXbTj07FzAnfUsMA9h91HQ%3d%3d",
        "credits": 18.000,
        "coverId": "j9XoGU3mn7f5K7vuvsg9LQ%3d%3d",
        "nbUsersSubbed": 0,
        "nbUsersQueue": 2,
        "isAutodeclaration": false,
        "accreditationNumber": "",
        "autodeclarationStartDate": "0001-01-01T00:00:00",
        "autodeclarationEndDate": "0001-01-01T00:00:00",
        "autodeclarationOrganization": "",
        "autodeclarationApprovalRequired": false,
        "autodeclarationProofUpload": false,
        "autodeclarationProofRequired": false,
        "autodeclarationWorkspaceAndOrganizationEditable": false,
        "autodeclarationSolemnDeclaration": false,
        "autodeclarationPrice": 0.0,
        "instanceDaysAvailable": 0,
        "instanceDaysToComplete": 0,
        "createdByUserID": "xDRTdsQdpthWlNm1CX8H%2bg%3d%3d",
        "taxEnabled": true,
        "customFields": {
            "trainingInstructor": ""
        },
        "isCatalogLinkPublic": true,
        "isPlannedActivityDisplayInCatalog": true,
        "catalogLink": "https://laralms.sviesolutions.com/Web/MyCatalog/ViewP?id=d4cRnrPVqw1M7s6vlDo%2bCw%3d%3d&pid=9tmgrGZzfp8dSpE0tz3tgQ%3d%3d",
        "lastModificationDate": "2023-10-19T09:41:54.893",
        "canDeclareMultipleTimes": false,
        "autodeclarationPresenceActivitiesRequired": false,
        "IsRecognizedInCycle": true
    },
...

Description des champs

Nom	Commentaires/description
id	Il s’agit de l’identifiant unique de la base de données. Ce paramètre doit être vide lorsque la méthode WorkspaceCreate est utilisée, mais obligatoire pour appeler WorkspaceEdit. (Type string)
websiteId	Il s’agit de l’identifiant unique utilisé lors de l’accès aux pages du portail.
creationDate	Date de création du workspace, (seulement en get) type string (YYYY-MM-DDTHH:MM:SSZ)
type	Identifiant unique du type de la formation ou de l’événement. Référez-vous à la page d’édition du type désiré pour récupérer cet identifiant ou à workspace/gettypes
name	Nom de la formation/événement tel qu’affiché dans le portail (Type string entre 5 et 250 caractères)
language	Langue de la formation ou de l’événement 1 = Français (Canada) 2 = Anglais 3 = Français (France) 4 = Espagnol (Type Number)
categoryId	L’identifiant de la catégorie à laquelle votre item formation ou événement est associé. Si plusieurs catégories sont déjà définies, celles-ci seront effacées pour ne conserver que cette catégorie. Retourne l'identifiant de la première catégorie associée. (Type String).
coverId	L’identifiant du visuel de votre formation. Votre item ne peut être associé qu’à un seul visuel (Type String).
providerId	L’identifiant du fournisseur de service auquel votre item formation ou événement est associé. Votre item ne peut être associé qu’à un seul fournisseur de service (Type String). En create, le fournisseur de service par défaut est considéré.
visibilityType	Type de visibilité dans les catalogues 0 = PublicVisibility = public, visiteurs non authentifiés 1 = AuthenticatedVisibility = utilisateurs authentifiés 2 = SubscribedVisibility = utilisateurs inscrits seulement 3 = MaskedVisibility = masqué (Type Number)
maxParticipants	Nombre maximal d’utilisateurs qui peuvent d’inscrire (si la file d’attente n’est pas activée) (Type Number) Valeur 0 correspond à aucun maximum
minParticipants	Nombre minimal d’utilisateurs inscrit pour que la formation ait lieu. (Type Number) Valeur 0 correspond à aucun minimum
description	Description de la formation, ceci sera affiché dans le catalogue et dans la formation. (Type string)
shortDescription	Courte description de la formation, ceci sera affiché dans le catalogue. (Type string)
subscriptionType	Détermine si l’événement ou la formation acceptent les inscriptions : 0 = Ouvert aux inscriptions (valeur par défaut) 1 = Fermé 2 = Ouvert aux inscriptions pour une période spécifique
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)
isOverBookingSubscription	Booléen - ceci active la file d’attente. La valeur par défaut est à false.
authorizationType	Types d’autorisations acceptées : 0 = Approbation par un administrateur 1 = Automatique
needAdminApproval	Booléen - Par défaut cette valeur est à « false ». Cette valeur definie si la formation nécessite de définir un approbateur lors de l'inscription.
enrolmentType	Types d’inscriptions acceptées : 0 = Auto-inscription 1 = Manuelle (administrative) 2 = Externe
externalLink	URL de redirection appliqué sur le lien « m’inscrire » pour rediriger l’utilisateur vers un site externe pour l’inscription. Maximum 250 caractères.
catalogLink	URL vers la page du catalogue public pour cette formation. Le URL donné pointe sur le portail par défaut. (Seulement en get)
keywords	Mots clefs de recherche de formation. Maximum 250 caractères.
showAvailableSubscriptions	Booléen - Par défaut cette valeur est à « false ». Affiche le nombre de places disponibles et totales dans le catalogue lorsque les utilisateurs s’inscrivent.
certificateId	Identifiant du certificat associé à la formation où l’événement. Il est décerné automatiquement selon les critères de complétion du workspace. (Type String)
credits	Nombre de crédit associé à la réussite de cette formation. Ne peut pas être spécifié si la formation ou l'événement possède déjà plusieurs catégories. Type Number
nbUsersSubbed	Valeur seulement disponible en GET permettant d’obtenir le nombre d’utilisateurs inscrits pour l’ensemble des sessions de la formation ou de l’événement Type Number
nbUsersQueue	Valeur seulement disponible en GET permettant d’obtenir le nombre d’utilisateurs en file d’attente pour l’ensemble des sessions de la formation ou de l’événement Type Number
instanceDaysAvailable	Détermine le nombre de jours après l’inscription d’un utilisateur où ce dernier a accès au contenu. Cette valeur peut être redéfinie pour chaque session. Valeur 0 correspond à toujours accessible
instanceDaysToComplete	Détermine le nombre de jours maximal après l’inscription d’un utilisateur où ce dernier doit avoir complété le contenu. Cette valeur peut être redéfinie pour chaque session. Valeur 0 correspond à aucune date limite de complétion
isAutodeclaration	Détermine si le Workspace peut servir de modèle pour autodéclarer une accréditation. Type Boolean
accreditationNumber	Détermine le numéro d’accréditation lors d’une Autodéclaration Obligatoire si isAutodeclaration* est à True seulement*
autodeclarationStartDate	Détermine la date limite inférieure pour autodéclarer ce workspace comme une accréditation. (Type date YYYY-MM-DDTHH:MM:SSZ)
autodeclarationEndDate	Détermine la date limite supérieure pour autodéclarer ce workspace comme une accréditation. (Type date YYYY-MM-DDTHH:MM:SSZ)
autodeclarationOrganization	Détermine le nom de l’organisation par défaut à afficher lors d’une nouvelle autodéclaration.
autodeclarationApprovalRequired	Détermine si l’autodéclaration doit être approuvée par un administrateur
autodeclarationProofUpload	Détermine si l’autodéclaration permet le téléversement de pièces justificatives
autodeclarationProofRequired	Détermine si l’autodéclaration exige le téléversement de pièces justificatives
autodeclarationSolemnDeclaration	Détermine si l’autodéclaration exige une déclaration solennelle de la part de l’utilisateur avant d’être soumise
autodeclarationPrice	Indique le prix de l'autodéclaration. Laisser vide si l'autodéclaration est désactivée ou gratuite. Type : décimal
catalogId	Seulement à la création de formation/événement. Identifiant du catalogue auquel on veut ajouter cette formation/événement.
lastModificationDate	Date de la dernière modification de la formation 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)
isPlannedActivityDisplayInCatalog	Permet d'afficher les activités planifiées ou non dans le catalogue.
categories	Liste des catégories pouvant catégoriser la formation ou l'événement. Le nombre de crédits que vaut la formation ou l'événement peut être défini pour chaque catégories associées.
isCreditCategorySplitManually	Détermine si la répartition des crédits dans les différentes catégories est gérée manuellement ou pas
canDeclareMultipleTimes	Détermine si la formation peut être autodéclarée plusieurs fois par le même utilisateur (Dans un contexte de programme ou de règlement)
autodeclarationPresenceActivitiesRequired	Détermine si l’autodéclaration exige la saisie d'activités ou d'ateliers. Par défaut cette valeur est à « true» lorsque le champ isAutodeclaration est à « true». (Type Boolean)
autodeclarationWorkspaceAndOrganizationEditable	Détermine si l'autodéclaration exige que l'utilisateur entre manuellement le titre de la formation et le nom de l'organisation. Par défaut cette valeur est à « false» lorsque le champ isAutodeclaration est à « true». (Type Boolean)
isRecognizedInCycle	Détermine si la formation est reconnue dans les règlements. Par défaut cette valeur est à « true» lors de la création. (Type Boolean)

Formations et événements : workspace/search

https://www.domaine.com/lmsapi/workspace/search

Permet de rechercher une formation ou un événement par un ou plusieurs champs.
Adresse de l'appel API : https://.../lmsapi/workspace/search

Requête

Exemple de contenu d'appel de requête de recherche de formation :

{
  "websiteId": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d"
}

ATTENTION : les valeurs de recherches sont cumulées. Par exemple, si l’on cherche un nom et un type, il retournera uniquement les enregistrements correspondants aux deux critères (« AND »).

Description des champs

Nom	Obligatoire	Commentaires/description
websiteId	(X)	Identifiant unique utilisé lors de l’accès aux pages du portail. (Type string)
id	(X)	Identifiant unique de la base de données de la formation ou de l’événement. (Type string)
name	(X)	Nom de la formation/événement tel qu’affiché dans le portail. (Type string)
type	(X)	Identifiant unique du type de la formation ou de l’événement. Référez-vous à workspace/gettypes. (Type string)

Réponse

Exemple de contenu d'appel de réponse de recherche de formation :

{
  "id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
  "websiteId": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
  "creationDate": "2016-11-16T14:52:27.353",
  "name": "Ma formation",
  "categoryId": "",
  "coverId": "",
  "visibilityType": 0,
  "maxParticipants": 0,
  "minParticipants": 0,
  "type": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
   "providerId" : "Mw1VQ2A8DFaNy22zA%3d%3d",
  "language": 1,
  "description": "",
  "shortDescription": "",
  "subscriptionType": 0,
  "startDate": "0001-01-01T00:00:00",
  "endDate": "0001-01-01T00:00:00",
  "isOverBookingSubscription": true,
  "authorizationType": 0,
  "needAdminApproval": true,
  "enrolmentType": 0,
  "externalLink": "monURL",
  "catalogLink": "UrlToPublicCatalog",
  "keywords": "mot,clef,formation",
  "showAvailableSubscriptions": true,
  "certificateId": "",
  "credits": 0.0,
  "nbUsersSubbed": -1,
  "nbUsersQueue": -1,
  "instanceDaysAvailable": 365,
  "instanceDaysToComplete": 180,
  "isAutodeclaration": true,
  "accreditationNumber": "12345-e",
  "autodeclarationStartDate": "0001-01-01T00:00:00",
  "autodeclarationEndDate": "0001-01-01T00:00:00",
  "autodeclarationOrganization": "",
  "autodeclarationApprovalRequired": true,
  "autodeclarationProofUpload": true,
  "autodeclarationProofRequired": true,
  "autodeclarationWorkspaceAndOrganizationEditable": true,
  "autodeclarationSolemnDeclaration": true,
  "autodeclarationPrice": 15.5,
  "lastModificationDate": "0001-01-01T00:00:00",
  "canDeclareMultipleTimes": false,
  "autodeclarationPresenceActivitiesRequired": false,
  "customFields": {
    "Champ1": "Snow",
    "Test": ""
  }

}

Description des champs

Nom	Commentaires/description
id	Il s’agit de l’identifiant unique de la base de données. Ce paramètre doit être vide lorsque la méthode WorkspaceCreate est utilisée, mais obligatoire pour appeler WorkspaceEdit. (Type string)
websiteId	Il s’agit de l’identifiant unique utilisé lors de l’accès aux pages du portail.
creationDate	Date de création du workspace, (seulement en get) type string (YYYY-MM-DDTHH:MM:SSZ)
type	Identifiant unique du type de la formation ou de l’événement. Référez-vous à la page d’édition du type désiré pour récupérer cet identifiant ou à workspace/gettypes
name	Nom de la formation/événement tel qu’affiché dans le portail (Type string entre 5 et 250 caractères)
language	Langue de la formation ou de l’événement 1 = Français (Canada) 2 = Anglais 3 = Français (France) 4 = Espagnol (Type Number)
categoryId	L’identifiant de la catégorie à laquelle votre item formation ou événement est associé. Si plusieurs catégories sont déjà définies, celles-ci seront effacées pour ne conserver que cette catégorie. Retourne l'identifiant de la première catégorie associée. (Type String).
coverId	L’identifiant du visuel de votre formation. Votre item ne peut être associé qu’à un seul visuel (Type String).
providerId	L’identifiant du fournisseur de service auquel votre item formation ou événement est associé. Votre item ne peut être associé qu’à un seul fournisseur de service (Type String). En create, le fournisseur de service par défaut est considéré.
visibilityType	Type de visibilité dans les catalogues 0 = PublicVisibility = public, visiteurs non authentifiés 1 = AuthenticatedVisibility = utilisateurs authentifiés 2 = SubscribedVisibility = utilisateurs inscrits seulement 3 = MaskedVisibility = masqué (Type Number)
maxParticipants	Nombre maximal d’utilisateurs qui peuvent d’inscrire (si la file d’attente n’est pas activée) (Type Number) Valeur 0 correspond à aucun maximum
minParticipants	Nombre minimal d’utilisateurs inscrit pour que la formation ait lieu. (Type Number) Valeur 0 correspond à aucun minimum
description	Description de la formation, ceci sera affiché dans le catalogue et dans la formation. (Type string)
shortDescription	Courte description de la formation, ceci sera affiché dans le catalogue. (Type string)
subscriptionType	Détermine si l’événement ou la formation acceptent les inscriptions : 0 = Ouvert aux inscriptions (valeur par défaut) 1 = Fermé 2 = Ouvert aux inscriptions pour une période spécifique
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)
isOverBookingSubscription	Booléen - ceci active la file d’attente. La valeur par défaut est à false.
authorizationType	Types d’autorisations acceptées : 0 = Approbation par un administrateur 1 = Automatique
needAdminApproval	Booléen - Par défaut cette valeur est à « false ». Cette valeur definie si la formation nécessite de définir un approbateur lors de l'inscription.
enrolmentType	Types d’inscriptions acceptées : 0 = Auto-inscription 1 = Manuelle (administrative) 2 = Externe
externalLink	URL de redirection appliqué sur le lien « m’inscrire » pour rediriger l’utilisateur vers un site externe pour l’inscription. Maximum 250 caractères.
catalogLink	URL vers la page du catalogue public pour cette formation. Le URL donné pointe sur le portail par défaut. (Seulement en get)
keywords	Mots clefs de recherche de formation. Maximum 250 caractères.
showAvailableSubscriptions	Booléen - Par défaut cette valeur est à « false ». Affiche le nombre de places disponibles et totales dans le catalogue lorsque les utilisateurs s’inscrivent.
certificateId	Identifiant du certificat associé à la formation où l’événement. Il est décerné automatiquement selon les critères de complétion du workspace. (Type String)
credits	Nombre de crédit associé à la réussite de cette formation. Ne peut pas être spécifié si la formation ou l'événement possède déjà plusieurs catégories. Type Number
nbUsersSubbed	Valeur seulement disponible en GET permettant d’obtenir le nombre d’utilisateurs inscrits pour l’ensemble des sessions de la formation ou de l’événement Type Number
nbUsersQueue	Valeur seulement disponible en GET permettant d’obtenir le nombre d’utilisateurs en file d’attente pour l’ensemble des sessions de la formation ou de l’événement Type Number
instanceDaysAvailable	Détermine le nombre de jours après l’inscription d’un utilisateur où ce dernier a accès au contenu. Cette valeur peut être redéfinie pour chaque session. Valeur 0 correspond à toujours accessible
instanceDaysToComplete	Détermine le nombre de jours maximal après l’inscription d’un utilisateur où ce dernier doit avoir complété le contenu. Cette valeur peut être redéfinie pour chaque session. Valeur 0 correspond à aucune date limite de complétion
isAutodeclaration	Détermine si le Workspace peut servir de modèle pour autodéclarer une accréditation. Type Boolean
accreditationNumber	Détermine le numéro d’accréditation lors d’une Autodéclaration Obligatoire si isAutodeclaration* est à True seulement*
autodeclarationStartDate	Détermine la date limite inférieure pour autodéclarer ce workspace comme une accréditation. (Type date YYYY-MM-DDTHH:MM:SSZ)
autodeclarationEndDate	Détermine la date limite supérieure pour autodéclarer ce workspace comme une accréditation. (Type date YYYY-MM-DDTHH:MM:SSZ)
autodeclarationOrganization	Détermine le nom de l’organisation par défaut à afficher lors d’une nouvelle autodéclaration.
autodeclarationApprovalRequired	Détermine si l’autodéclaration doit être approuvée par un administrateur
autodeclarationProofUpload	Détermine si l’autodéclaration permet le téléversement de pièces justificatives
autodeclarationProofRequired	Détermine si l’autodéclaration exige le téléversement de pièces justificatives
autodeclarationSolemnDeclaration	Détermine si l’autodéclaration exige une déclaration solennelle de la part de l’utilisateur avant d’être soumise
autodeclarationPrice	Indique le prix de l'autodéclaration. Laisser vide si l'autodéclaration est désactivée ou gratuite. Type : décimal
catalogId	Seulement à la création de formation/événement. Identifiant du catalogue auquel on veut ajouter cette formation/événement.
lastModificationDate	Date de la dernière modification de la formation 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)
isPlannedActivityDisplayInCatalog	Permet d'afficher les activités planifiées ou non dans le catalogue.
categories	Liste des catégories pouvant catégoriser la formation ou l'événement. Le nombre de crédits que vaut la formation ou l'événement peut être défini pour chaque catégories associées.
isCreditCategorySplitManually	Détermine si la répartition des crédits dans les différentes catégories est gérée manuellement ou pas
canDeclareMultipleTimes	Détermine si la formation peut être autodéclarée plusieurs fois par le même utilisateur (Dans un contexte de programme ou de règlement)
autodeclarationPresenceActivitiesRequired	Détermine si l’autodéclaration exige la saisie d'activités ou d'ateliers. Par défaut cette valeur est à « true» lorsque le champ isAutodeclaration est à « true». (Type Boolean)
autodeclarationWorkspaceAndOrganizationEditable	Détermine si l'autodéclaration exige que l'utilisateur entre manuellement le titre de la formation et le nom de l'organisation. Par défaut cette valeur est à « false» lorsque le champ isAutodeclaration est à « true». (Type Boolean)
isRecognizedInCycle	Détermine si la formation est reconnue dans les règlements. Par défaut cette valeur est à « true» lors de la création. (Type Boolean)

Formations et événements : workspace/gettypes

https://www.domaine.com/lmsapi/workspace/gettypes

Permet d'obtenir la liste de l’ensemble des types de formations et événements.
Adresse de l'appel API : https://.../lmsapi/workspace/gettypes

Requête

Exemple de contenu d'appel de requête des types de formation :

ATTENTION : La méthode ne requiert aucun paramètre.

Description des champs

Nom	Obligatoire	Commentaires/description
		La méthode ne requiert aucun paramètre.

Réponse

Exemple de contenu d'appel de réponse d'obtention des types de formation :

[
  {
    "id": "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d",
    "name": {
      "texts": [{
        "text": "Test Nom",
        "languageId": 1
        }
      ]
    },
    "description": {
      "texts": [{
        "text": "Test Description",
        "languageId": 1
        }
      ]
    },
    "type": 0,
    "isDefault": true,
    "iconType": 0,
    "isActive": true,
    "autodeclarationPrice": 15.5,
    "providerId": "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d"
  }
]

Description des champs

Nom	Commentaires/description
id	Identifiant unique du type de formation ou d’événement. Cet identifiant est utilisé dans le champ type des méthodes workspace/create et workspace/edit. (Type string)
name	Nom du type, retourné sous forme de textes multilingues (texts).
description	Description du type, retournée sous forme de textes multilingues (texts).
text	Texte du nom ou de la description dans la langue correspondante. (Type string)
languageId	Identifiant de la langue du texte. 1 = Français (Canada), 2 = Anglais, 3 = Français (France), 4 = Espagnol (Type Number)
type	Catégorie du type (formation ou événement). (Type Number)
isDefault	Indique s’il s’agit du type utilisé par défaut. (Type Boolean)
iconType	Icône associée au type. (Type Number)
isActive	Indique si le type est actif et peut être utilisé. (Type Boolean)
autodeclarationPrice	Indique le prix de l'autodéclaration associé à ce type. Type : décimal
providerId	L’identifiant du fournisseur de service associé au type. (Type string)

Formations et événements : workspace/create

https://www.domaine.com/lmsapi/workspace/create

Permet de créer une formation ou un événement.
Adresse de l'appel API : https://.../lmsapi/workspace/create

Requête

Exemple de contenu d'appel de requête de création de formation :

{
  "name": "Ma formation",
  "categoryId": null,
  "coverId": null,
  "visibilityType": 0, 
  "maxParticipants": 0, 
  "minParticipants": 0, 
  "type": "O%252f9dsKKECyJSUWkOK37D8g%253d%253d", 
  "providerId" : "Mw1VQ2A8DFaNy22zA%3d%3d",
  "language": 1,
  "description": "",
  "shortDescription": "",
  "subscriptionType": 0, 
  "startDate": "0001-01-01T00:00:00",
  "endDate": "0001-01-01T00:00:00",
  "isOverBookingSubscription": true, 
  "authorizationType": 0, 
  "needAdminApproval": true,
  "enrolmentType": 0,
  "externalLink": “monURL”,
  "keywords": “mot,clef,formation”,
  "showAvailableSubscriptions": true,
  "certificateId": 0,
  “isAutodeclaration”: true,
  “accreditationNumber”, “12345-a”, 
  “autodeclarationStartDate”: "0001-01-01T00:00:00",
  “autodeclarationEndDate”: "0001-01-01T00:00:00",
  “catalogId”: "O%252f9dsKKECyJSUWkOK37D8g%253d%253d",
  "canDeclareMultipleTimes": false,
  "autodeclarationPresenceActivitiesRequired": false,
  "categories": [
      { "id": "uprlbtvuqNuwmncYPu1ljg%3d%3d", "credits": 1 },
      { "id": "ZP8QuKCp1lvGwyjiTn8SPw%3d%3d", "credits": 2 }
  ],
  "customFields": {
    "Champ1": "Snow",
    "Test": ""
  }
}

Description des champs

Nom	Obligatoire	Commentaires/description
id		Il s’agit de l’identifiant unique de la base de données. Ce paramètre doit être vide lorsque la méthode WorkspaceCreate est utilisée, mais obligatoire pour appeler WorkspaceEdit. (Type string)
type	X	Identifiant unique du type de la formation ou de l’événement. Référez-vous à la page d’édition du type désiré pour récupérer cet identifiant ou à workspace/gettypes
name	X	Nom de la formation/événement tel qu’affiché dans le portail (Type string entre 5 et 250 caractères)
language		Langue de la formation ou de l’événement 1 = Français (Canada) 2 = Anglais 3 = Français (France) 4 = Espagnol (Type Number)
categoryId		L’identifiant de la catégorie à laquelle votre item formation ou événement est associé. Si plusieurs catégories sont déjà définies, celles-ci seront effacées pour ne conserver que cette catégorie. Retourne l'identifiant de la première catégorie associée. (Type String).
coverId		L’identifiant du visuel de votre formation. Votre item ne peut être associé qu’à un seul visuel (Type String).
providerId		L’identifiant du fournisseur de service auquel votre item formation ou événement est associé. Votre item ne peut être associé qu’à un seul fournisseur de service (Type String). En create, le fournisseur de service par défaut est considéré.
visibilityType	X	Type de visibilité dans les catalogues 0 = PublicVisibility = public, visiteurs non authentifiés 1 = AuthenticatedVisibility = utilisateurs authentifiés 2 = SubscribedVisibility = utilisateurs inscrits seulement 3 = MaskedVisibility = masqué (Type Number)
maxParticipants	X	Nombre maximal d’utilisateurs qui peuvent d’inscrire (si la file d’attente n’est pas activée) (Type Number) Valeur 0 correspond à aucun maximum
minParticipants	X	Nombre minimal d’utilisateurs inscrit pour que la formation ait lieu. (Type Number) Valeur 0 correspond à aucun minimum
description		Description de la formation, ceci sera affiché dans le catalogue et dans la formation. (Type string)
shortDescription		Courte description de la formation, ceci sera affiché dans le catalogue. (Type string)
subscriptionType	X	Détermine si l’événement ou la formation acceptent les inscriptions : 0 = Ouvert aux inscriptions (valeur par défaut) 1 = Fermé 2 = Ouvert aux inscriptions pour une période spécifique
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)
isOverBookingSubscription	X	Booléen - ceci active la file d’attente. La valeur par défaut est à false.
authorizationType	X	Types d’autorisations acceptées : 0 = Approbation par un administrateur 1 = Automatique
needAdminApproval		Booléen - Par défaut cette valeur est à « false ». Cette valeur definie si la formation nécessite de définir un approbateur lors de l'inscription.
enrolmentType		Types d’inscriptions acceptées : 0 = Auto-inscription 1 = Manuelle (administrative) 2 = Externe
externalLink		URL de redirection appliqué sur le lien « m’inscrire » pour rediriger l’utilisateur vers un site externe pour l’inscription. Maximum 250 caractères.
keywords		Mots clefs de recherche de formation. Maximum 250 caractères.
showAvailableSubscriptions	X	Booléen - Par défaut cette valeur est à « false ». Affiche le nombre de places disponibles et totales dans le catalogue lorsque les utilisateurs s’inscrivent.
certificateId		Identifiant du certificat associé à la formation où l’événement. Il est décerné automatiquement selon les critères de complétion du workspace. (Type String)
credits		Nombre de crédit associé à la réussite de cette formation. Ne peut pas être spécifié si la formation ou l'événement possède déjà plusieurs catégories. Type Number
nbUsersSubbed		Valeur seulement disponible en GET permettant d’obtenir le nombre d’utilisateurs inscrits pour l’ensemble des sessions de la formation ou de l’événement Type Number
nbUsersQueue		Valeur seulement disponible en GET permettant d’obtenir le nombre d’utilisateurs en file d’attente pour l’ensemble des sessions de la formation ou de l’événement Type Number
instanceDaysAvailable		Détermine le nombre de jours après l’inscription d’un utilisateur où ce dernier a accès au contenu. Cette valeur peut être redéfinie pour chaque session. Valeur 0 correspond à toujours accessible
instanceDaysToComplete		Détermine le nombre de jours maximal après l’inscription d’un utilisateur où ce dernier doit avoir complété le contenu. Cette valeur peut être redéfinie pour chaque session. Valeur 0 correspond à aucune date limite de complétion
isAutodeclaration		Détermine si le Workspace peut servir de modèle pour autodéclarer une accréditation. Type Boolean
accreditationNumber		Détermine le numéro d’accréditation lors d’une Autodéclaration Obligatoire si isAutodeclaration* est à True seulement*
autodeclarationStartDate		Détermine la date limite inférieure pour autodéclarer ce workspace comme une accréditation. (Type date YYYY-MM-DDTHH:MM:SSZ)
autodeclarationEndDate		Détermine la date limite supérieure pour autodéclarer ce workspace comme une accréditation. (Type date YYYY-MM-DDTHH:MM:SSZ)
autodeclarationOrganization		Détermine le nom de l’organisation par défaut à afficher lors d’une nouvelle autodéclaration.
autodeclarationApprovalRequired		Détermine si l’autodéclaration doit être approuvée par un administrateur
autodeclarationProofUpload		Détermine si l’autodéclaration permet le téléversement de pièces justificatives
autodeclarationProofRequired		Détermine si l’autodéclaration exige le téléversement de pièces justificatives
autodeclarationSolemnDeclaration		Détermine si l’autodéclaration exige une déclaration solennelle de la part de l’utilisateur avant d’être soumise
autodeclarationPrice		Indique le prix de l'autodéclaration. Laisser vide si l'autodéclaration est désactivée ou gratuite. Type : décimal
catalogId		Seulement à la création de formation/événement. Identifiant du catalogue auquel on veut ajouter cette formation/événement.
lastModificationDate		Date de la dernière modification de la formation 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)
isPlannedActivityDisplayInCatalog		Permet d'afficher les activités planifiées ou non dans le catalogue.
categories		Liste des catégories pouvant catégoriser la formation ou l'événement. Le nombre de crédits que vaut la formation ou l'événement peut être défini pour chaque catégories associées.
isCreditCategorySplitManually		Détermine si la répartition des crédits dans les différentes catégories est gérée manuellement ou pas.
canDeclareMultipleTimes		Détermine si la formation peut être autodéclarée plusieurs fois par le même utilisateur (Dans un contexte de programme ou de règlement).
autodeclarationPresenceActivitiesRequired		Détermine si l’autodéclaration exige la saisie d'activités ou d'ateliers. Par défaut cette valeur est à « true» lorsque le champ isAutodeclaration est à « true». (Type Boolean)
autodeclarationWorkspaceAndOrganizationEditable		Détermine si l'autodéclaration exige que l'utilisateur entre manuellement le titre de la formation et le nom de l'organisation. Par défaut cette valeur est à « false» lorsque le champ isAutodeclaration est à « true». (Type Boolean)
isRecognizedInCycle		Détermine si la formation est reconnue dans les règlements. Par défaut cette valeur est à « true» lors de la création. (Type Boolean)

Réponse

Exemple de contenu d'appel de réponse de création de formation :

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

Description des champs

Nom	Commentaires/description
id	Identifiant unique de la formation ou de l’événement créé. (Type string)

Formations et événements : workspace/edit

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

Permet de modifier une formation ou un événement existant.
Adresse de l'appel API : https://.../lmsapi/workspace/edit

Requête

Exemple de contenu d'appel de requête d'édition d'une formation :

{
  "id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d", 
  "name": "Ma formation",
  "categoryId": null,
  "coverId": null,
  "visibilityType": 0, 
  "maxParticipants": 0, 
  "minParticipants": 0, 
  "type": "O%252f9dsKKECyJSUWkOK37D8g%253d%253d", 
  "providerId" : "Mw1VQ2A8DFaNy22zA%3d%3d",
  "language": 1,
  "description": "",
  "shortDescription": "",
  "subscriptionType": 0, 
  "startDate": "0001-01-01T00:00:00",
  "endDate": "0001-01-01T00:00:00",
  "isOverBookingSubscription": true, 
  "authorizationType": 0, 
  "needAdminApproval": true,
  "enrolmentType": 0,
  "externalLink": "monURL",
  "keywords": "mot,clef,formation",
  "showAvailableSubscriptions": true,
  "certificateId": 0,
  "isAutodeclaration”: true,
  "accreditationNumber", "12345-a",
  "autodeclarationEndDate": "0001-01-01T00:00:00",
  "autodeclarationWorkspaceAndOrganizationEditable": false,
  "instanceDaysAvailable", 365,
  "instanceDaysToComplete", 180,
  "canDeclareMultipleTimes": false,
  "autodeclarationPresenceActivitiesRequired": false,
  "categories": [
      { "id": "uprlbtvuqNuwmncYPu1ljg%3d%3d", "credits": 1 },
      { "id": "ZP8QuKCp1lvGwyjiTn8SPw%3d%3d", "credits": 2 }
  ],
  "customFields": {
    "Champ1": "Snow",
    "Test": ""
  }
}

ATTENTION : En édition, seule la valeur Id est obligatoire.

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Il s’agit de l’identifiant unique de la base de données. Ce paramètre doit être vide lorsque la méthode WorkspaceCreate est utilisée, mais obligatoire pour appeler WorkspaceEdit. (Type string)
type		Identifiant unique du type de la formation ou de l’événement. Référez-vous à la page d’édition du type désiré pour récupérer cet identifiant ou à workspace/gettypes
name		Nom de la formation/événement tel qu’affiché dans le portail (Type string entre 5 et 250 caractères)
language		Langue de la formation ou de l’événement 1 = Français (Canada) 2 = Anglais 3 = Français (France) 4 = Espagnol (Type Number)
categoryId		L’identifiant de la catégorie à laquelle votre item formation ou événement est associé. Si plusieurs catégories sont déjà définies, celles-ci seront effacées pour ne conserver que cette catégorie. Retourne l'identifiant de la première catégorie associée. (Type String).
coverId		L’identifiant du visuel de votre formation. Votre item ne peut être associé qu’à un seul visuel (Type String).
providerId		L’identifiant du fournisseur de service auquel votre item formation ou événement est associé. Votre item ne peut être associé qu’à un seul fournisseur de service (Type String). En create, le fournisseur de service par défaut est considéré.
visibilityType		Type de visibilité dans les catalogues 0 = PublicVisibility = public, visiteurs non authentifiés 1 = AuthenticatedVisibility = utilisateurs authentifiés 2 = SubscribedVisibility = utilisateurs inscrits seulement 3 = MaskedVisibility = masqué (Type Number)
maxParticipants		Nombre maximal d’utilisateurs qui peuvent d’inscrire (si la file d’attente n’est pas activée) (Type Number) Valeur 0 correspond à aucun maximum
minParticipants		Nombre minimal d’utilisateurs inscrit pour que la formation ait lieu. (Type Number) Valeur 0 correspond à aucun minimum
description		Description de la formation, ceci sera affiché dans le catalogue et dans la formation. (Type string)
shortDescription		Courte description de la formation, ceci sera affiché dans le catalogue. (Type string)
subscriptionType		Détermine si l’événement ou la formation acceptent les inscriptions : 0 = Ouvert aux inscriptions (valeur par défaut) 1 = Fermé 2 = Ouvert aux inscriptions pour une période spécifique
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)
isOverBookingSubscription		Booléen - ceci active la file d’attente. La valeur par défaut est à false.
authorizationType		Types d’autorisations acceptées : 0 = Approbation par un administrateur 1 = Automatique
needAdminApproval		Booléen - Par défaut cette valeur est à « false ». Cette valeur definie si la formation nécessite de définir un approbateur lors de l'inscription.
enrolmentType		Types d’inscriptions acceptées : 0 = Auto-inscription 1 = Manuelle (administrative) 2 = Externe
externalLink		URL de redirection appliqué sur le lien « m’inscrire » pour rediriger l’utilisateur vers un site externe pour l’inscription. Maximum 250 caractères.
catalogLink		URL vers la page du catalogue public pour cette formation. Le URL donné pointe sur le portail par défaut. (Seulement en get)
keywords		Mots clefs de recherche de formation. Maximum 250 caractères.
showAvailableSubscriptions		Booléen - Par défaut cette valeur est à « false ». Affiche le nombre de places disponibles et totales dans le catalogue lorsque les utilisateurs s’inscrivent.
certificateId		Identifiant du certificat associé à la formation où l’événement. Il est décerné automatiquement selon les critères de complétion du workspace. (Type String)
credits		Nombre de crédit associé à la réussite de cette formation. Ne peut pas être spécifié si la formation ou l'événement possède déjà plusieurs catégories. Type Number
nbUsersSubbed		Valeur seulement disponible en GET permettant d’obtenir le nombre d’utilisateurs inscrits pour l’ensemble des sessions de la formation ou de l’événement Type Number
nbUsersQueue		Valeur seulement disponible en GET permettant d’obtenir le nombre d’utilisateurs en file d’attente pour l’ensemble des sessions de la formation ou de l’événement Type Number
instanceDaysAvailable		Détermine le nombre de jours après l’inscription d’un utilisateur où ce dernier a accès au contenu. Cette valeur peut être redéfinie pour chaque session. Valeur 0 correspond à toujours accessible
instanceDaysToComplete		Détermine le nombre de jours maximal après l’inscription d’un utilisateur où ce dernier doit avoir complété le contenu. Cette valeur peut être redéfinie pour chaque session. Valeur 0 correspond à aucune date limite de complétion
isAutodeclaration		Détermine si le Workspace peut servir de modèle pour autodéclarer une accréditation. Type Boolean
accreditationNumber		Détermine le numéro d’accréditation lors d’une Autodéclaration Obligatoire si isAutodeclaration* est à True seulement*
autodeclarationStartDate		Détermine la date limite inférieure pour autodéclarer ce workspace comme une accréditation. (Type date YYYY-MM-DDTHH:MM:SSZ)
autodeclarationEndDate		Détermine la date limite supérieure pour autodéclarer ce workspace comme une accréditation. (Type date YYYY-MM-DDTHH:MM:SSZ)
autodeclarationOrganization		Détermine le nom de l’organisation par défaut à afficher lors d’une nouvelle autodéclaration.
autodeclarationApprovalRequired		Détermine si l’autodéclaration doit être approuvée par un administrateur
autodeclarationProofUpload		Détermine si l’autodéclaration permet le téléversement de pièces justificatives
autodeclarationProofRequired		Détermine si l’autodéclaration exige le téléversement de pièces justificatives
autodeclarationSolemnDeclaration		Détermine si l’autodéclaration exige une déclaration solennelle de la part de l’utilisateur avant d’être soumise
autodeclarationPrice		Indique le prix de l'autodéclaration. Laisser vide si l'autodéclaration est désactivée ou gratuite. Type : décimal
catalogId		Seulement à la création de formation/événement. Identifiant du catalogue auquel on veut ajouter cette formation/événement.
lastModificationDate		Date de la dernière modification de la formation 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)
isPlannedActivityDisplayInCatalog		Permet d'afficher les activités planifiées ou non dans le catalogue.
categories		Liste des catégories pouvant catégoriser la formation ou l'événement. Le nombre de crédits que vaut la formation ou l'événement peut être défini pour chaque catégories associées.
isCreditCategorySplitManually		Détermine si la répartition des crédits dans les différentes catégories est gérée manuellement ou pas
canDeclareMultipleTimes		Détermine si la formation peut être autodéclarée plusieurs fois par le même utilisateur (Dans un contexte de programme ou de règlement)
autodeclarationPresenceActivitiesRequired		Détermine si l’autodéclaration exige la saisie d'activités ou d'ateliers. Par défaut cette valeur est à « true» lorsque le champ isAutodeclaration est à « true». (Type Boolean)
autodeclarationWorkspaceAndOrganizationEditable		Détermine si l'autodéclaration exige que l'utilisateur entre manuellement le titre de la formation et le nom de l'organisation. Par défaut cette valeur est à « false» lorsque le champ isAutodeclaration est à « true». (Type Boolean)
isRecognizedInCycle		Détermine si la formation est reconnue dans les règlements. Par défaut cette valeur est à « true» lors de la création. (Type Boolean)

Réponse

Exemple de contenu de réponse de requête d'édition d'une formation :

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

Description des champs

Nom	Commentaires/description
id	Identifiant unique de la formation ou de l’événement modifié. (Type string)

Formations et événements : workspace/delete

https://www.domaine.com/lmsapi/workspace/delete

Permet de supprimer une formation ou un événement existant.
Adresse de l'appel API : https://.../lmsapi/workspace/delete

Requête

Exemple de contenu d'appel de requête de suppression d'une formation :

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

ATTENTION : La valeur id est obligatoire pour cette méthode.

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de la formation. (Type string)

Réponse

Exemple de contenu d'appel de réponse de suppression d'une formation :

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

Description des champs

Nom	Commentaires/description
id	Identifiant unique de la formation ou de l’événement supprimé. (Type string)

Formations et événements : workspace/getequivalences

https://www.domaine.com/lmsapi/workspace/getequivalences

Permet d'obtenir la liste des formations ou événements en équivalence.
Adresse de l'appel API : https://.../lmsapi/workspace/getequivalences

Requête

Exemple de contenu d'appel de requête d'obtention des équivalences d'une formation :

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

ATTENTION : La valeur id est obligatoire pour cette méthode.

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de la formation. (Type string)

Réponse

Exemple de contenu d'appel de réponse d'obtention des équivalences d'une formation :

[
  {
    "id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
    "equivalenceId": "AcLsGid1Op46%2bB3ap%2bwoeA%3d%3d",
    "credits": 4.0
  },
  {
    "id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
    "equivalenceId": "uXKrQaur%2fIQ7aFslJTtZVg%3d%3d",
    "credits": 2.0
  },
  {
    "id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
    "equivalenceId": "paIkOU7nZFfUhMSPlj5iPg%3d%3d",
    "credits": 3.0
  }
]

Description des champs

Nom	Commentaires/description
id	Il s’agit de l’identifiant unique de la base de données de la formation/événement sur laquelle une équivalence est associée. (Type string)
equivalenceId	L’identifiant unique de la base de données de la formation/événement en équivalence. (Type string)
credits	Nombre de crédits en équivalence associé à la réussite de cette formation/événement. (Type Number)

Formations et événements : workspace/geturl

https://www.domaine.com/lmsapi/workspace/geturl

Permet d'obtenir la liste des url de catalogue public pour cette formation ou événement.
Adresse de l'appel API : https://.../lmsapi/workspace/geturl

Requête

Exemple de contenu d'appel de requête d'obtention de l'URL au catalogue d'une formation :

{
  "id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
  "filterId" : "aoflemrnQ2A8DFaNy22zA%3d%3d"
}

ATTENTION : La valeur id est obligatoire pour cette méthode.

ATTENTION : La valeur filterId (optionel) est un identifiant de portail pour ne recevoir que l’url de cette formation pour ce portail spécifique

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de la formation. (Type string)
filterId		Identifiant de portail permettant de ne recevoir que l’url de cette formation pour ce portail spécifique. (Type string)

Réponse

Exemple de contenu d'appel de réponse d'obtention de l'URL au catalogue d'une 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 cette formation ou événement pour le portail correspondant. (Type string)

Formations et événements : workspace/getadminbranches

https://www.domaine.com/lmsapi/workspace/getadminbranches

Permet d'obtenir la liste des branches administratives associées à une formation ou événement.
Adresse de l'appel API : https://.../lmsapi/workspace/getadminbranches

Requête

Exemple de contenu d'appel de requête de la ou des branches d'une formation :

{
  "id": "68a9Y6p%2bhVsJJBRcIMOo0w%3d%3d"
}

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de la formation. (Type string)

Réponse

Exemple de contenu d'appel de réponse de la ou des branches d'une formation :

[
  "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d",
    "6d7yavtJwLemtOAO2HF5BQ%3d%3d"
]

Description des champs

Nom	Commentaires/description
branches	Liste des identifiants uniques des branches administratives associées à la formation ou événement. (Type liste de string)

Formations et événements : workspace/addadminbranches

https://www.domaine.com/lmsapi/workspace/addadminbranches

Permet d'ajouter des branches administratives à une formation ou événement.
Adresse de l'appel API : https://.../lmsapi/workspace/addadminbranches

Requête

Exemple de contenu d'appel de requête d'ajout d'une formation à une ou des branches :

{
  "id": "68a9Y6p%2bhVsJJBRcIMOo0w%3d%3d",
  branches: [
    "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d",
    "6d7yavtJwLemtOAO2HF5BQ%3d%3d"
  ]
}

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de la 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 d'une formation à une ou des branches :

{
  "id": "68a9Y6p%2bhVsJJBRcIMOo0w%3d%3d"
}

Description des champs

Nom	Commentaires/description
id	Identifiant unique de la formation ou de l’événement auquel les branches ont été ajoutées. (Type string)

Formations et événements : workspace/removeadminbranches

https://www.domaine.com/lmsapi/workspace/removeadminbranches

Permet d'enlever des branches administratives d'une formation ou événement.
Adresse de l'appel API : https://.../lmsapi/workspace/removeadminbranches

Requête

Exemple de contenu d'appel de requête de retrait d'une formation d'une ou de plusieurs branches :

{
  "id": "68a9Y6p%2bhVsJJBRcIMOo0w%3d%3d",
  branches: [
    "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d",
    "6d7yavtJwLemtOAO2HF5BQ%3d%3d"
  ]
}

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de la 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 d'une formation d'une ou de plusieurs branches :

{
  "id": "68a9Y6p%2bhVsJJBRcIMOo0w%3d%3d"
}

Description des champs

Nom	Commentaires/description
id	Identifiant unique de la formation ou de l’événement auquel les branches ont été enlevées. (Type string)

Description des codes d’erreurs de formation et événements

Numéro	Message	Commentaires/description
400	Required id	Vous devez fournir un identifiant pour la formation et événement.
401	Invalid id	L’identifiant fourni pour la formation et événement est invalide.
402	Required type	Vous devez fournir un identifiant pour le type de la formation et événement.
403	Invalid type	L’identifiant fourni pour le type de la formation et événement n’est pas valide.
404	Required name	Vous devez fournir un nom pour la formation et événement.
405	Invalid name length	Le nom fourni pour la formation et événement doit contenir entre 5 à 250 caractères inclusivement.
406	Required minParticipants	Vous devez fournir une quantité minimum de participant.
407	Invalid minParticipants	La quantité minimum de participant fourni doit être supérieure ou égale à 0.
408	Required maxParticipants	Vous devez fournir une quantité maximum de participant.
409	Invalid maxParticipants	La quantité maximum de participant fourni doit être supérieure ou égale à 0.
410	Required subscriptionType	Vous devez fournir le type d’inscription.
411	Required isOverBookingSubscription	Vous devez fournir "True" ou "False".
412	Required authorizationType	Vous devez fournir le type d’autorisation des inscriptions.
413	Required visibilityType	Vous devez fournir le type de visibilité de la formation.
414	Required showAvailableSubscriptions	Vous devez fournir "True" ou "False".
415	Required accreditationNumber	Si l’autodéclaration est activée, vous devez fournir un numéro d’accréditation.
416	Invalid accreditationNumber length	Le numéro d’accréditation fourni est invalide.
417	Required autodeclarationOrganization	Lorsque l’autodéclaration est activée, vous devez fournir un nom d’organisation.
418	Invalid autodeclarationOrganization length	La longueur du nom de l’organisation fourni pour l’autodéclaration doit contenir entre 3 et 250 caractères inclusivement.
419	Invalid instanceDaysAvailable	Le nombre de jour fourni pour la disponibilité de la formation et événement est invalide.
420	Invalid instanceDaysToComplete	Le nombre de jour fourni pour compléter la formation est invalide.
421	Invalid providerId	L’identifiant fourni pour le fournisseur est invalide.
422	Certificate requires providerId	Lorsque vous fournissez un identifiant de certificat, vous devez fournir un identifiant pour le fournisseur.
423	Invalid certificateId	L’identifiant fourni pour le certificat est invalide.
424	Invalid catalogId	L’identifiant fourni pour le catalogue est invalide.
425	Invalid coverId	L’identifiant fourni pour le choix du visuel est invalide.
426	Required externalLink	Si le type d’inscription accepté est externe, vous devez fournir un lien de redirection.
427	Invalid externalLink length	Si le type d’inscription accepté est externe, le lien de redirection fourni doit contenir entre 5 et 250 caractères inclusivement.
428	Invalid keywords length	La liste de mots clés doit contenir un maximum de 250 caractères inclusivement.
429	Invalid workspaceType ID	L’identifiant fourni pour le type de formation et événement est invalide.
430	Autodeclaration not enabled	Vous devez autoriser l’autodéclaration afin de pouvoir modifier ses paramètres.
431	Invalid shortDescription Length	La description courte doit contenir un maximum de 200 caractères inclusivement.
432	Invalid filterId	L’identifiant donnée pour effectuer le filtre est invalide.
433	Invalid public id	L’identifiant public fourni pour la formation et événement est invalide.
434	Missing required branches	Le paramètre « branches » est obligatoire.
435	Invalid branchId	Un identifiant de branche est invalide.
436	Cannot remove all branches	Impossible de supprimer toutes les branches administratives d’une formation.
437	Cannot add branches	Impossible d'ajouter les branches administratives à une formation, car il y a des branches déjà ajoutées.
438	Cannot remove branches	Impossible de supprimer les branches administratives d'une formation, car il y a des branches qui ne sont pas associées.
439	Invalid language	La valeur fournie pour la langue invalide.
440	Cannot specify both categoryId and categories	Impossible de spécifier à la fois l'identifiant de la catégorie et les catégories
441	Cannot change overall credits when there are multiple categories	Impossible de changer le total de crédits quand il y a plusieurs catégories
442	Invalid Category Id	La valeur de l'identifiant de la catégorie est invalide
443	Invalid Authorization Type	La valeur fournie pour le type d'autorisation ne concorde pas avec les renseignements fournis
444	Invalid AutodeclarationPrice	La valeur du prix de l'autodéclaration est invalide
445	Cannot edit AutodeclarationPresenceActivitiesRequired from the moment a self-declaration is in the training	Impossible de modifier l'option des activités de présence requises des autodéclarations à partir du moment où il y a une autodéclaration dans la formation

Nom	Hôte	Durée	Description
_fw_crm_v	sviesolutions.freshdesk.com	1 an	Cookie Freshchat/Freshworks (utilisé pour suivre l'identité du visiteur/utilisateur et les sessions de chat effectuées par l'utilisateur).
_x_w	sviesolutions.freshdesk.com	Session	Contient l'ID de partition sur lequel le compte s'exécute.
_x_m	sviesolutions.freshdesk.com	Session	Contient l'état de la partition.
_helpkit_session	sviesolutions.freshdesk.com	Session	Votre clé secrète pour vérifier l'intégrité des données de la session de cookies. Si vous modifiez cette clé, toutes les anciennes sessions deviendront non valides !
helpdesk_node_session	sviesolutions.freshdesk.com	Session	Un hachage chiffré qui stocke la clé secrète et l'identifiant de la tentative de connexion.
user_credentials	sviesolutions.freshdesk.com	2 mois	Utilisé pour l'authentification de l'utilisateur.
wf_order	sviesolutions.freshdesk.com	Session	Utilisé pour vérifier dans quel ordre les tickets sont filtrés pour les filtres de tickets personnalisés, par exemple : échéance, réponse_agent_à, réponse_demandeur_à, etc.
wf_order_type	sviesolutions.freshdesk.com	Session	Utilisé pour vérifier si l'ordre est croissant ou décroissant pour les filtres de tickets personnalisés.
wf_filter	sviesolutions.freshdesk.com	Session	Indique quel filtre est appliqué pour la liste des tickets.

Recherches récentes

Articles populaires

Articles

Sujets

Tickets

Formations et événements (Lära)

Formations et événements

Formations et événements : Workspace/get

Requête

Description des champs

Réponse

Description des champs

Formations et événements : workspace/getlist

Requête

Description des champs

Réponse

Description des champs

Formations et événements : workspace/search

Requête

Description des champs

Réponse

Description des champs

Formations et événements : workspace/gettypes

Requête

Description des champs

Réponse

Description des champs

Formations et événements : workspace/create

Requête

Description des champs

Réponse

Description des champs

Formations et événements : workspace/edit

Requête

Description des champs

Réponse

Description des champs

Formations et événements : workspace/delete

Requête

Description des champs

Réponse

Description des champs

Formations et événements : workspace/getequivalences

Requête

Description des champs

Réponse

Description des champs

Formations et événements : workspace/geturl

Requête

Description des champs

Réponse

Description des champs

Formations et événements : workspace/getadminbranches

Requête

Description des champs

Réponse

Description des champs

Formations et événements : workspace/addadminbranches

Requête

Description des champs

Réponse

Description des champs

Formations et événements : workspace/removeadminbranches

Requête

Description des champs

Réponse

Description des champs

Description des codes d’erreurs de formation et événements

Cet article a-t-il été utile ?