Activités / Classes virtuelles (Via HTML)

Miro Lagueux

Modifié le : Mar, 20 Févr., 2024 à 1:01 H

ACTIVITÉS / CLASSES VIRTUELLES (VIA HTML)

Les « Activités / classes virtuelles » sont l'ensemble des activités Via HTML de votre environnement, et sont nommées « activity » dans l'API.

Activity/create

Permet de créer une nouvelle activité Via HTML sur votre environnement.
Adresse de l'appel API : https://.../lmsapi/activity/create

Requête

Exemple de contenu d'appel de requête de création d’une activité Via HTML :

{
"title": {"texts": [{"text": "Rencontre préparatoire","languageId": 1}]},
"description": {"texts": [{"text": "Rencontre préparatoire au 1er Cycle","languageId": 1}]},
"startDate": "2020-10-06T09:00:00",
"endDate": "2020-10-06T11:00:00",
"hyperlink": "2dhfwwoh6jqh",
"coverId": "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d",
"presenterId": "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d",
"isPublicAccess": true,
"presenceMinutes": 0,
"playbackAccessType": 1,
"playbackExpirationDelay": 2,
"recordingModeBehavior": 2,
"reminderType": 1,
"reminderTypeDelay": 1,
"branches": ["y%2fzWArt44RkjiaSYb9j%2bHg%3d%3d", "WYAF8HWTyvrqrvtYGbn1vQ%3d%3d"]
}

Description des champs

Nom	Obligatoire	Commentaires/description
Title - texts - text - languageId	X	Text : Titre de l'activité. (Type string) Obligatoire en création seulement. languageId : Le titre peut être multilingue : 1 = Français (Canada) 2 = Anglais 3 = Espagnol (Type Number)
Description - texts - text - languageId	X	Text : Description de l'activité. (Type string) Obligatoire en création seulement. languageId : Le titre peut être multilingue : 1 = Français (Canada) 2 = Anglais 3 = Espagnol (Type Number)
startDate		Date et heure de début de l'activité. Une activité créée sans date de début sera de type permanente. (String YYYY-MM-DDTHH:MM:SSZ)
endDate		Date et heure de fin de l'activité. (String YYYY-MM-DDTHH:MM:SSZ)
hyperlink		Hyperlien public de l'activité. Veuillez n'entrer que la fin de l'hyperlien, par exemple, si on spécifiait « 2dhfwwoh6jqh », le lien de l'activité correspondrea à <https://www.domaine.com/2dhfwwoh6jqh> (Type String)
coverId		Identifiant unique du visuel de l'activité. (Type String)
presenterId	X	Identifiant unique (utilisateur) du présentateur de l'activité. (Type String)
isPublicAccess		Permet de spécifier si l'activité est publique ou privée. (Type booléen)
presenceMinutes		Permet de définir le nombre de minutes requises pour qu’un utilisateur soit considéré comme présent dans l'activité (0 par défaut). (Type Number)
playbackAccessType		Sert à spécifier le type d’accès aux enregistrements par défaut. 0 = Administrateurs 1 = Participants 2 = Public 3 = Public seulement (Type number)
playbackExpirationDelay		Permet de choisir le délai d’expiration pour le visionnement des enregistrements. 0 = Aucune expiration (aucune limite de temps) (valeur par défaut) 1 = 1 jour 2 = 7 jours 3 = 15 jours 4 = 1 mois 5 = 3 mois 6 = 6 mois 7 = 9 mois 8 = 1 an (Type Number)
recordingModeBehavior		Permet de définir le mode d'enregistrement de l'activité. 0 = Aucun 1 = Automatique 2 = Manuel (Type Number)
reminderType		Indique l'unité de mesure servant à définir quand le rappel d'activité sera envoyé aux participants. 0 = Aucun (défaut) 1 = Heures 2 = Jours (Type Number)
reminderTypeDelay		Permet de définir la quantité de l'unité de mesure choisie dans le champ "reminderType" (0 par défaut). Obligatoire si le "reminderType" est différent d'aucun (0), la valeur minimum devient alors "1". La valeur maximale permise est "99".
branches		Permet d'associer l'activité à une ou plusieurs branches administratives. Si aucune branche n'est spécifiée, l'activité sera associée à la branche par défaut de l'organigramme. (Type String)

Réponse

Exemple du contenu d'appel de réponse de création d'une activité Via HTML. Le système renvoie l'identifiant unique de l'activité créé :

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

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique de l'activité Via HTML créée. (Type String)

Activity/edit

Permet de modifier une activité Via HTML sur votre environnement.
Adresse de l'appel API : https://.../lmsapi/activity/edit

Requête

Exemple de contenu d'appel de requête de modification d’une activité Via HTML :

{
    "id": "G0lvlK1mMCapCnTH0VSoQA%3d%3d",
    "title": {
        "texts": [
            {
                "text": "Rencontre préparatoire",
                "languageId": 1
            },
            {
                "languageId": 2
            },
            {
                "languageId": 3
            },
            {
                "languageId": 4
            }
        ],
        "ErrorID": 0
    },
    "description": {
        "texts": [
            {
                "text": "Rencontre préparatoire au 1er Cycle",
                "languageId": 1
            },
            {
                "languageId": 2
            },
            {
                "languageId": 3
            },
            {
                "languageId": 4
            }
        ],
        "ErrorID": 0
    },
    "creatorUserId": "6SPYUlYlIeL3WXhC0eJ4jA%3d%3d",
    "startDate": "2020-10-06T09:00:00",
    "endDate": "2020-10-06T11:00:00",
    "creationDate": "2024-02-15T11:23:35.277",
    "duration": 120,
    "hyperlink": "exemple1",
    "coverId": "tt1EOJz%2fPUbtgjoc4gm1sQ%3d%3d",
    "isFromLMS": false,
    "isPublicAccess": true,
    "type": 1,
    "state": 1,
    "presenceMinutes": 0,
    "playbackAccessType": 1,
    "playbackExpirationDelay": 2,
    "recordingModeBehavior": 2,
    "reminderType": 1,
    "reminderTypeDelay": 1
}

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de l'activité Via HTML à modifier. (Type String)
Title - texts - text - languageId		Text : Titre de l'activité. (Type string) Obligatoire en création seulement. languageId : Le titre peut être multilingue : 1 = Français (Canada) 2 = Anglais 3 = Espagnol (Type Number)
Description - texts - text - languageId		Text : Description de l'activité. (Type string) Obligatoire en création seulement. languageId : Le titre peut être multilingue : 1 = Français (Canada) 2 = Anglais 3 = Espagnol (Type Number)
startDate		Date et heure de début de l'activité. Une activité créée sans date de début sera de type permanente. (String YYYY-MM-DDTHH:MM:SSZ)
endDate		Date et heure de fin de l'activité. (String YYYY-MM-DDTHH:MM:SSZ)
duration		Durée de l'activité en minutes. S’il est spécifié, ce champ remplacera toute valeur placée dans le champs "endDate" pour la date et l'heure correspondante. (Type number)
hyperlink		Hyperlien public de l'activité. Veuillez n'entrer que la fin de l'hyperlien, par exemple, si on spécifiait « 2dhfwwoh6jqh », le lien de l'activité correspondrea à <https://www.domaine.com/2dhfwwoh6jqh> (Type String)
coverId		Identifiant unique du visuel de l'activité. (Type String)
presenterId		Identifiant unique (utilisateur) du présentateur de l'activité. (Type String)
isPublicAccess		Permet de spécifier si l'activité est publique ou privée. (Type booléen)
state		Spécifie l’état (activée ou désactivée) de l'activité. (Type number) 1 = Active 3 = Inactive
presenceMinutes		Permet de définir le nombre de minutes requises pour qu’un utilisateur soit considéré comme présent dans l'activité (0 par défaut). (Type Number)
playbackAccessType		Sert à spécifier le type d’accès aux enregistrements par défaut. 0 = Administrateurs 1 = Participants 2 = Public 3 = Public seulement (Type number)
playbackExpirationDelay		Permet de choisir le délai d’expiration pour le visionnement des enregistrements. 0 = Aucune expiration (aucune limite de temps) (valeur par défaut) 1 = 1 jour 2 = 7 jours 3 = 15 jours 4 = 1 mois 5 = 3 mois 6 = 6 mois 7 = 9 mois 8 = 1 an (Type Number)
recordingModeBehavior		Permet de définir le mode d'enregistrement de l'activité. 0 = Aucun 1 = Automatique 2 = Manuel (Type Number)
reminderType		Indique l'unité de mesure servant à définir quand le rappel d'activité sera envoyé aux participants. 0 = Aucun (défaut) 1 = Heures 2 = Jours (Type Number)
reminderTypeDelay		Permet de définir la quantité de l'unité de mesure choisie dans le champ "reminderType" (0 par défaut). Obligatoire si le "reminderType" est différent d'aucun (0), la valeur minimum devient alors "1". La valeur maximale permise est "99".

Réponse

Exemple du contenu d'appel de réponse de modification d'une activité Via HTML. Le système renvoie l'identifiant unique de l'activité modifiée :

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

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique de l'activité Via HTML modifiée. (Type String)

Activity/get

Permet d'obtenir des informations sur une activité Via HTML sur votre environnement.

Adresse de l'appel API : https://.../lmsapi/activity/get

Requête

Exemple de contenu d'appel de requête d'information pour une activité Via HTML :

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

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de l'activité Via HTML dont on veut obtenir des informations. (Type String)

Réponse

Exemple du contenu d'appel de réponse de requête d'information pour une activité Via HTML. Le système renvoie l'ensemble des champs :

{
    "id": "G0lvlK1mMCapCnTH0VSoQA%3d%3d",
    "title": {
        "texts": [
            {
                "text": "Rencontre préparatoire2",
                "languageId": 1
            },
            {
                "languageId": 2
            },
            {
                "languageId": 3
            },
            {
                "languageId": 4
            }
        ],
        "ErrorID": 0
    },
    "description": {
        "texts": [
            {
                "text": "Rencontre préparatoire au 1er Cycle2",
                "languageId": 1
            },
            {
                "languageId": 2
            },
            {
                "languageId": 3
            },
            {
                "languageId": 4
            }
        ],
        "ErrorID": 0
    },
    "creatorUserId": "6SPYUlYlIeL3WXhC0eJ4jA%3d%3d",
    "startDate": "2020-10-06T09:00:00",
    "endDate": "2020-10-06T11:00:00",
    "creationDate": "2024-02-15T11:23:35.277",
    "duration": 120,
    "hyperlink": "https://laralms.sviesolutions.com/exemple1",
    "coverId": "tt1EOJz%2fPUbtgjoc4gm1sQ%3d%3d",
    "isFromLMS": false,
    "isPublicAccess": true,
    "type": 1,
    "state": 3,
    "presenceMinutes": 0,
    "playbackAccessType": 1,
    "playbackExpirationDelay": 2,
    "recordingModeBehavior": 2,
    "reminderType": 1,
    "reminderTypeDelay": 1
}

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique de l'activité Via HTML. (Type String)
Title - texts - text - languageId		Text : Titre de l'activité. (Type string) Obligatoire en création seulement. languageId : Le titre peut être multilingue : 1 = Français (Canada) 2 = Anglais 3 = Espagnol (Type Number)
Description - texts - text - languageId		Text : Description de l'activité. (Type string) Obligatoire en création seulement. languageId : Le titre peut être multilingue : 1 = Français (Canada) 2 = Anglais 3 = Espagnol (Type Number)
creatorUserId		Identifiant unique de l'utilisateur ayant créé l'activité. (Type String)
startDate		Date et heure de début de l'activité. Une activité créée sans date de début sera de type permanente. (String YYYY-MM-DDTHH:MM:SSZ)
endDate		Date et heure de fin de l'activité. (String YYYY-MM-DDTHH:MM:SSZ)
creationDate		Date et heure de la création de l'activité. (String YYYY-MM-DDTHH:MM:SSZ)
duration		Durée de l'activité en minutes. S’il est spécifié, ce champ remplacera toute valeur placée dans le champs "endDate" pour la date et l'heure correspondante. (Type number)
hyperlink		Hyperlien public de l'activité. Veuillez n'entrer que la fin de l'hyperlien, par exemple, si on spécifiait « 2dhfwwoh6jqh », le lien de l'activité correspondrea à <https://www.domaine.com/2dhfwwoh6jqh> (Type String)
coverId		Identifiant unique du visuel de l'activité. (Type String)
isFromLMS		Indique si l'activité est associée à une session (workspaceInstance) de formation de Lära LMS.
presenterId		Identifiant unique (utilisateur) du présentateur de l'activité. (Type String)
isPublicAccess		Permet de spécifier si l'activité est publique ou privée. (Type booléen)
type		Type de cette activité. 1 = Normal 2 = Permanente (Type Number)
state		Spécifie l’état (activée ou désactivée) de l'activité. 1 = Active 3 = Inactive (Type Number)
presenceMinutes		Permet de définir le nombre de minutes requises pour qu’un utilisateur soit considéré comme présent dans l'activité (0 par défaut). (Type Number)
playbackAccessType		Sert à spécifier le type d’accès aux enregistrements par défaut. 0 = Administrateurs 1 = Participants 2 = Public 3 = Public seulement (Type number)
playbackExpirationDelay		Permet de choisir le délai d’expiration pour le visionnement des enregistrements. 0 = Aucune expiration (aucune limite de temps) (valeur par défaut) 1 = 1 jour 2 = 7 jours 3 = 15 jours 4 = 1 mois 5 = 3 mois 6 = 6 mois 7 = 9 mois 8 = 1 an (Type Number)
recordingModeBehavior		Permet de définir le mode d'enregistrement de l'activité. 0 = Aucun 1 = Automatique 2 = Manuel (Type Number)
reminderType		Indique l'unité de mesure servant à définir quand le rappel d'activité sera envoyé aux participants. 0 = Aucun (défaut) 1 = Heures 2 = Jours (Type Number)
reminderTypeDelay		Permet de définir la quantité de l'unité de mesure choisie dans le champ "reminderType" (0 par défaut). Obligatoire si le "reminderType" est différent d'aucun (0), la valeur minimum devient alors "1". La valeur maximale permise est "99".

Activity/delete

Permet de supprimer une activité activité Via HTML sur votre environnement.

Adresse de l'appel API : https://.../lmsapi/activity/delete

Requête

Exemple de contenu d'appel de requête de suppression d'une activité Via HTML :

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

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de l'activité Via HTML à supprimer. (Type String)

Réponse

Exemple du contenu d'appel de réponse de requête de suppression d'une activité Via HTML :

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

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique de l'activité Via HTML supprimée. (Type String)

Activity/getlist

Permet d'obtenir une liste d'activités ou de classes virtuelles Via HTML de votre environnement (200).

Adresse de l'appel API : https://.../lmsapi/activity/getlist

Requête

Exemple de contenu d'appel de requête de liste d'activités ou de classes virtuelles Via HTML de votre environnement :

{
  "filterDate": "YYYY-MM-DDTHH:MM:SSZ",
  "filterStartDate": "YYYY-MM-DDTHH:MM:SSZ",
  "filterEndDate": "YYYY-MM-DDTHH:MM:SSZ" ,
  "filterIndex": 2
  "filterIncludeDisabled": 1
}

Description des champs

Nom	Obligatoire	Commentaires/description
filterDate		Permet d’obtenir la liste des activités créées depuis une date précise. (String YYYY-MM-DDTHH:MM:SSZ)
filterStartDate		Permet d’obtenir toutes les activités qui commencent après une date précise. (String YYYY-MM-DDTHH:MM:SSZ)
filterEndDate		Si associé à une date de début, permet d’obtenir toutes les activités ayant lieu entre ces dates. Si utilisé seul, il permet d’obtenir toutes les activités qui finissent après une date précise. (String YYYY-MM-DDTHH:MM:SSZ)
filterIndex		Le paramètre de filtre par index est optionnel et correspond à une pagination de 200 activités. La méthode retourne la liste de 200 objets selon l’index passé comme filtre. Un filtre par index de 1 retourne les activités 1 à 200 et un filtre par index de 2 retourne les activités de 201 à 400.
filterIncludeDisabled		Le paramètre de filtre des activités désactivées est optionnel. Par défaut elles ne sont jamais retournées, la valeur 1 permet d’inclure les activités désactivées dans la liste.

Réponse

Exemple du contenu d'appel de réponse de requête d'une liste d'activités Via HTML :

[
    {
        "id": "JQrSIOlE123pel7c3FXZ1w%3d%3d",
        "title": {
            "texts": [
                {
                    "text": "Non-respect des délais : Survie pratique pour limiter les risques!",
                    "languageId": 1
                },
                {
                    "languageId": 2
                },
                {
                    "languageId": 3
                },
                {
                    "languageId": 4
                }
            ],
            "ErrorID": 0
        },
        "description": {
            "texts": [
                {
                    "languageId": 1
                },
                {
                    "languageId": 2
                },
                {
                    "languageId": 3
                },
                {
                    "languageId": 4
                }
            ],
            "ErrorID": 0
        },
        "creatorUserId": "hyKnH0JSL7De3ohq7FSvPg%3d%3d",
        "startDate": "2024-02-23T13:35:53.917",
        "endDate": "2024-02-23T16:35:53.917",
        "creationDate": "2024-01-23T13:35:53.73",
        "duration": 180,
        "coverId": "JK63ARb9yPZ5tpmS%2bq7jmw%3d%3d",
        "isFromLMS": true,
        "isPublicAccess": false,
        "type": 1,
        "state": 1,
        "presenceMinutes": 0,
        "playbackAccessType": 0,
        "playbackExpirationDelay": 0,
        "recordingModeBehavior": 2
    },
    {
        "id": "mo%2bA8U7QUB%2fB3Ekbyocd2g%3d%3d",
        "title": {
            "texts": [
                {
                    "text": "Exemple1",
                    "languageId": 1
                },
                {
                    "languageId": 2
                },
                {
                    "languageId": 3
                },
                {
                    "languageId": 4
                }
            ],
            "ErrorID": 0
        },
        "description": {
            "texts": [
                {
                    "languageId": 1
                },
                {
                    "languageId": 2
                },
                {
                    "languageId": 3
                },
                {
                    "languageId": 4
                }
            ],
            "ErrorID": 0
        },
        "creatorUserId": "6r7EJL43twvjlMLUt32Hug%3d%3d",
        "startDate": "2023-12-21T13:21:00",
        "endDate": "2023-12-21T16:21:00",
        "creationDate": "2023-12-14T13:23:00.927",
        "duration": 180,
        "coverId": "JK63ARb9yPZ5tpmS%2bq7jmw%3d%3d",
        "isFromLMS": true,
        "isPublicAccess": false,
        "type": 1,
        "state": 1,
        "presenceMinutes": 0,
        "playbackAccessType": 0,
        "playbackExpirationDelay": 0,
        "recordingModeBehavior": 1
    }
}

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique de l'activité Via HTML. (Type String)
Title - texts - text - languageId		Text : Titre de l'activité. (Type string) Obligatoire en création seulement. languageId : Le titre peut être multilingue : 1 = Français (Canada) 2 = Anglais 3 = Espagnol (Type Number)
Description - texts - text - languageId		Text : Description de l'activité. (Type string) Obligatoire en création seulement. languageId : Le titre peut être multilingue : 1 = Français (Canada) 2 = Anglais 3 = Espagnol (Type Number)
creatorUserId		Identifiant unique de l'utilisateur ayant créé l'activité. (Type String)
startDate		Date et heure de début de l'activité. Une activité créée sans date de début sera de type permanente. (String YYYY-MM-DDTHH:MM:SSZ)
endDate		Date et heure de fin de l'activité. (String YYYY-MM-DDTHH:MM:SSZ)
creationDate		Date et heure de fin de l'activité. (String YYYY-MM-DDTHH:MM:SSZ)
duration		Durée de l'activité en minutes. S’il est spécifié, ce champ remplacera toute valeur placée dans le champs "endDate" pour la date et l'heure correspondante. (Type number)
hyperlink		Hyperlien public de l'activité. Veuillez n'entrer que la fin de l'hyperlien, par exemple, si on spécifiait « 2dhfwwoh6jqh », le lien de l'activité correspondrea à <https://www.domaine.com/2dhfwwoh6jqh> (Type String)
coverId		Identifiant unique du visuel de l'activité. (Type String)
isFromLMS		Indique si l'activité est associée à une session (workspaceInstance) de formation de Lära LMS.
presenterId		Identifiant unique (utilisateur) du présentateur de l'activité. (Type String)
isPublicAccess		Permet de spécifier si l'activité est publique ou privée. (Type booléen)
type		Type de cette activité. 1 = Normal 2 = Permanente (Type Number)
state		Spécifie l’état (activée ou désactivée) de l'activité. 1 = Active 3 = Inactive (Type Number)
presenceMinutes		Permet de définir le nombre de minutes requises pour qu’un utilisateur soit considéré comme présent dans l'activité (0 par défaut). (Type Number)
playbackAccessType		Sert à spécifier le type d’accès aux enregistrements par défaut. 0 = Administrateurs 1 = Participants 2 = Public 3 = Public seulement (Type number)
playbackExpirationDelay		Permet de choisir le délai d’expiration pour le visionnement des enregistrements. 0 = Aucune expiration (aucune limite de temps) (valeur par défaut) 1 = 1 jour 2 = 7 jours 3 = 15 jours 4 = 1 mois 5 = 3 mois 6 = 6 mois 7 = 9 mois 8 = 1 an (Type Number)
recordingModeBehavior		Permet de définir le mode d'enregistrement de l'activité. 0 = Aucun 1 = Automatique 2 = Manuel (Type Number)

Activity/duplicate

Permet de dupliquer une activité Via HTML de votre environnement.

Adresse de l'appel API : https://.../lmsapi/activity/duplicate

Requête

Exemple du contenu d'appel de requête d'une duplication d'activité Via HTML. En ajoutant d'autres champs que "id", vous donnerez des caractéristiques à votre nouvelle activité (duplicata) :

{
  "id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
  "title": {
    "texts": [
      {
        "text": "Rencontre préparatoire semestrielle - 2021",
        "languageId": 1
      },
      {
        "text": "Semi-annual preparatory meeting - 2021",
        "languageId": 2
      }
    ]
  },
  "startDate": "2021-10-10T09:00:00",
  "endDate": "2021-10-10T12:00:00",
  "duration": 180,
  "includeUsers": false
}

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de l'activité. (Type string)
title - texts - text - language		Text : Titre de la nouvelle activité. (Type string) languageId : Le titre peut être multilingue : 1 = Français (Canada) 2 = Anglais 4 = Espagnol (Type Number)
startDate		Date et heure de début de l'activité. (String YYYY-MM-DDTHH:MM:SSZ)
endDate		Date et heure de fin de l'activité. (String YYYY-MM-DDTHH:MM:SSZ)
duration		Durée de l'activité en minutes. S’il est spécifié, ce champ remplacera toute valeur placée dans le champs "endDate" pour la date et l'heure correspondante. (Type number)
includeUsers		Indique si l'activité doit conserver les participants de l'activité originale. (Seul le présentateur sera conservé lorsque la valeur est false) (Type Booléen)

Réponse

Exemple du contenu d'appel de réponse de requête de duplication d'une activité Via HTML :

{
  "id": "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d"
}

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique de l'activité Via HTML dupliquée. (Type String)

Activity/addparticipants

Permet d'ajouter des participants à une activité Via HTML de votre environnement.

Adresse de l'appel API : https://.../lmsapi/activity/addparticipants

Requête

Exemple du contenu d'appel de requête d'ajout de participants à une activité Via HTML :

{
  "id": "nNESxmSxMI6mK0EDxoE3Gg%3d%3d",
  "participantList": [
    {
      "userId": "6SPYUlYlIeL3WXhC0eJ4jA%3d%3d",
      "participantType": "1",
    },
    {
      "userId": "32hdyyJ%2brWlI5nnr1IoncQ%3d%3d",
      "participantType": "2"
    }
  ]
}

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de l'activité. (Type string)
participantList	X	Liste de participants à ajouter à l'activité.
userId	X	Identifiant unique de l'utilisateur à ajouter à l'activité. (Type string)
participantType		Type de participant à ajouter à l'activité. Si vide le type participant est considéré par défaut. 0 = Participant 1 = Animateur 2 = Hôte (Type Number)

Réponse

Exemple du contenu d'appel de réponse de requête d'ajout de participants à une activité Via HTML :

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

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique de l'activité Via HTML à laquelle des participants ont été ajoutés. (Type String)

Activity/removeparticipants

Permet de retirer des participants d'une activité Via HTML de votre environnement.

Adresse de l'appel API : https://.../lmsapi/activity/removeparticipants

Requête

Exemple du contenu d'appel de requête de retrait de participants d'une activité Via HTML :

{
  "id": "nNESxmSxMI6mK0EDxoE3Gg%3d%3d",
  "participantList": [
    {
      "userId": "6SPYUlYlIeL3WXhC0eJ4jA%3d%3d",
    },
    {
      "userId": "32hdyyJ%2brWlI5nnr1IoncQ%3d%3d"
    }
  ]
}

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de l'activité. (Type string)
participantList	X	Liste de participants à retirer de l'activité.
userId	X	Identifiant unique de l'utilisateur à retirer de l'activité. (Type string)

Réponse

Exemple du contenu d'appel de réponse de requête de retrait de participants d'une activité Via HTML :

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

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique de l'activité Via HTML de laquelle des participants ont été retirés. (Type String)

Activity/setparticipants

Permet d'établir la liste des participants d'une activité Via HTML de votre environnement. Cet appel ajoutera des participants à l'activité ou les retirera selon la nouvelle liste. La liste complète des participants sera mise à jour.

Adresse de l'appel API : https://.../lmsapi/activity/setparticipants

Requête

Exemple du contenu d'appel de requête de mise à jour de la liste des participants d'une activité Via HTML :

{
  "id": "nNESxmSxMI6mK0EDxoE3Gg%3d%3d",
  "participantList": [
    {
      "userId": "6SPYUlYlIeL3WXhC0eJ4jA%3d%3d",
      "participantType": "1",
    },
    {
      "userId": "32hdyyJ%2brWlI5nnr1IoncQ%3d%3d",
      "participantType": "2"
    }
  ]
}

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de l'activité. (Type string)
participantList	X	Liste de participants à ajouter à l'activité.
userId	X	Identifiant unique de l'utilisateur à ajouter à l'activité. (Type string)
participantType		Type de participant à ajouter à l'activité. Si vide le type participant est considéré par défaut. 0 = Participant 1 = Animateur 2 = Hôte (Type Number)

Réponse

Exemple du contenu d'appel de réponse de requête de mise à jour des participants d'une activité Via HTML :

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

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique de l'activité Via HTML pour laquelle la liste des participants a été mise à jour. (Type String)

Activity/getparticipantlist

Permet d'obtenir la liste des participants d'une activité Via HTML de votre environnement.

Adresse de l'appel API : https://.../lmsapi/activity/getparticipantlist

Requête

Exemple du contenu d'appel de requête de la liste des participants d'une activité Via HTML :

{
  "id": "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d"
}

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de l'activité Via HTML pour laquelle la liste des participants est requêtée. (Type String)

Réponse

Exemple du contenu d'appel de réponse de requête de la liste des participants d'une activité Via HTML :

{
  "id": "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d",
  "participantList": [
    {
      "userId": "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d",
      "participantType": "1",
      "isGuest": true,
    },
    {
      "userId": "6d7yavtJwLemtOAO2HF5BQ%3d%3d",
      "participantType": "2",
      "isGuest": false,
    }
  ]
}

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique de l'activité. (Type string)
participantList		Liste de participants de l'activité.
userId		Identifiant unique d'un utilisateur de l'activité. (Type string)
participantType		Type de participant dans l'activité. 0 = Participant 1 = Animateur 2 = Hôte (Type Number)
isGuest		Indique si le participant est un invité ou s'il fait partie des utilisateurs de l'environnement. (Type Booléen)

Activity/getparticipantslogs

Permet d'obtenir la liste des temps de connexion pour un participant ou pour tous les participants d'une activité Via HTML de votre environnement.

Adresse de l'appel API : https://.../lmsapi/activity/getparticipantslogs

Requête

Exemple du contenu d'appel de requête de la liste des temps de connexion d'un ou des participants d'une activité Via HTML :

{
  "id": "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d",
  "filterId": "6d7yavtJwLemtOAO2HF5BQ%3d%3d"
}

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de l'activité. (Type string)
filterId		Identifiant unique d’un utilisateur pour requêter uniquement cet utilisateur. Si le paramètre est omis, la liste des participants au complet sera retournée.

Réponse

Exemple du contenu d'appel de réponse de requête de la liste des temps de connexion d'un ou des participants d'une activité Via HTML :

{
  "id": "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d",
  "participantList": [
    {
      "userId": "6d7yavtJwLemtOAO2HF5BQ%3d%3d",
      "participantType": "2",
      "isGuest": false,
      "connectionDuration": 60.5,
      "playbackDuration": 0,
    }
  ]
}

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique de l'activité. (Type string)
participantList		Liste des participants de l'activité.
userId		Identifiant unique de l’utilisateur. (Type string)
participantType		Type de participant de l'activité. 0 = Participant 1 = Animateur 2 = Hôte (Type Number)
isGuest	Lecture seule	Indique si l’utilisateur est un utilisateur invité. (Type Boolean)
connectionDuration	Lecture seule	Nombre de temps en minute de connexion à l'activité. (Type Number)
playbackDuration	Lecture seule	Nombre de temps en minute de connexion à la lecture d'un enregistrement de l'activité. (Type Number)

Activity/getgroups

Permet d'obtenir la liste des groupes d'utilisateurs associés à une activité Via HTML de votre environnement.

Adresse de l'appel API : https://.../lmsapi/activity/getgroups

Requête

Exemple du contenu d'appel de requête de la liste des groupes associés à une activité Via HTML :

{
  "id": "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d"
}

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de l'activité. (Type string)

Réponse

Exemple du contenu d'appel de réponse de requête de la liste des groupes d'utilisateurs associés à une activité Via HTML :

{
  "id": "vBW5xMw1VQ2A8DFaNy22zA",
  "name": {
    "texts": [{
        "text": "Mon groupe",
        "languageId": 1
      }
    ]
  },
  "creationDate": "2018-02-08T15:02:45.73",
  "createdByUserID": "%2fUtsC30QAPbKKJCD7cUkJA%3d%3d",
}

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique du groupe d'utilisateurs. (Type string)
name - texts - text - languageId		Text : Nom du groupe. (Type string) languageId : Le nom du groupe peut être multilingue : 1 = Français (Canada) 2 = Anglais 3 = Espagnol (Type Number)
creationDate		Date de création initiale du groupe d'utilisateurs. (String YYYY-MM-DDTHH:MM:SSZ)
createdByUserId		Identifiant unique du l groupe d'utilisateurs. (Type string)

Activity/addgroup

Permet d'ajouter un groupe d'utilisateurs à une activité Via HTML de votre environnement.

Adresse de l'appel API : https://.../lmsapi/activity/addgroup

Requête

Exemple du contenu d'appel de requête d'ajout d'un groupe à une activité Via HTML :

{
  "id": "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d",
  "groupId": "6d7yavtJwLemtOAO2HF5BQ%3d%3d"
}

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de l'activité. (Type string)
groupId	X	Identifiant unique du groupe à ajouter à l'activité. (Type string)

Réponse

Exemple du contenu d'appel de réponse de requête d'ajout d'un groupe d'utilisateurs à une activité Via HTML :

{
  "id": "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d",
  "groupId": "6d7yavtJwLemtOAO2HF5BQ%3d%3d"
}

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique de l'activité. (Type string)
groupId		Identifiant unique du groupe à ajouter à l'activité. (Type string)

Activity/removegroup

Permet de retirer un groupe d'utilisateurs d'une activité Via HTML de votre environnement. Cet appel retire aussi les utilisateurs de l'activité.

Adresse de l'appel API : https://.../lmsapi/activity/removegroup

Requête

Exemple du contenu d'appel de requête de retrait d'un groupe d'utilisateurs d'une activité Via HTML :

{
  "id": "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d",
  "groupId": "6d7yavtJwLemtOAO2HF5BQ%3d%3d"
}

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de l'activité. (Type string)
groupId	X	Identifiant unique du groupe à retirer de l'activité. (Type string)

Réponse

Exemple du contenu d'appel de réponse de requête de retrait d'un groupe d'utilisateurs à une activité Via HTML :

{
  "id": "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d",
  "groupId": "6d7yavtJwLemtOAO2HF5BQ%3d%3d"
}

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique de l'activité. (Type string)
groupId		Identifiant unique du groupe à retirer de l'activité. (Type string)

Activity/unlinkgroup

Permet de délier un groupe d'utilisateurs d'une activité Via HTML de votre environnement. Cet appel conserve les utilisateur du groupe dans l'activité.

Adresse de l'appel API : https://.../lmsapi/activity/unlinkgroup

Requête

Exemple du contenu d'appel de requête de déliaison d'un groupe d'utilisateurs d'une activité Via HTML :

{
  "id": "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d",
  "groupId": "6d7yavtJwLemtOAO2HF5BQ%3d%3d"
}

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de l'activité. (Type string)
groupId	X	Identifiant unique du groupe à délier de l'activité. (Type string)

Réponse

Exemple du contenu d'appel de réponse de requête de déliaison d'un groupe d'utilisateurs à une activité Via HTML :

{
  "id": "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d",
  "groupId": "6d7yavtJwLemtOAO2HF5BQ%3d%3d"
}

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique de l'activité. (Type string)
groupId		Identifiant unique du groupe à délier de l'activité. (Type string)

Activity/getbranches

Permet d'obtenir la branche ou les branches de l'organigramme auxquelles une activité Via HTML de votre environnement est réputée être attachée.

Adresse de l'appel API : https://.../lmsapi/activity/getbranches

Requête

Exemple du contenu d'appel de requête des branches d'une activité Via HTML :

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

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de l'activité. (Type string)

Réponse

Exemple du contenu d'appel de réponse de requête des branches d'une activité Via HTML :

[
    "OyaT0qm4u5Lt9ue3v97Kuw%3d%3d"
]

Description des champs

Nom	Obligatoire	Commentaires/description
-		Identifiant unique de la ou des branches de l'organigramme auxquelles l'activité est attachée. (Type string)

Activity/addbranches

Permet d'associer une activité Via HTML à une ou plusieurs branches de l'organigramme de votre environnement.

Adresse de l'appel API : https://.../lmsapi/activity/addbranches

Requête

Exemple du contenu d'appel d'ajout d'une activité Via HTML à une ou plusieurs branches de l'organigramme de votre environnement :

{
  "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 l'activité. (Type string)
branches	X	Identifiant unique des branches de l'activité. (Type string)

Réponse

Exemple du contenu d'appel de réponse de requête d'ajout d'une activité Via HTML à une ou plusieurs branches de l'organigramme de votre environnement :

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

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique de l'activité associée à des branches. (Type string)

Activity/sendinvitation

Permet d'émettre un courriel d'invitation aux participants d'une activité Via HTML.

Adresse de l'appel API : https://.../lmsapi/activity/sendinvitation

Requête

Exemple du contenu d'appel d'envoi d'une notification d'invitation à une activité Via HTML :

{
  "id": "fOYuF4aPrwcgQQ8ewDX0gA%3d%3d",
  "users": [
        "vrj0IrWe0HF%2bK9OKGpDF5A%3d%3d",  
        "6d7yavtJwLemtOAO2HF5BQ%3d%3d"
    ]
}

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de l'activité. (Type string)
users	X	Identifiant unique des branches de l'activité. (Type string)

Réponse

Exemple du contenu d'appel de réponse de requête d'envoi d'une notification d'invitation à une activité Via HTML :

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

Description des champs

Nom	Obligatoire	Commentaires/description
id		Identifiant unique de l'activité. (Type string)

Activity/getsubroomlist

Permet d'obtenir la liste des ateliers d'une activité Via HTML.

Adresse de l'appel API : https://.../lmsapi/activity/getsubroomlist

Requête

Exemple du contenu d'appel de requête des ateliers d'une activité Via HTML :

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

Description des champs

Nom	Obligatoire	Commentaires/description
id	X	Identifiant unique de l'activité. (Type string)

Réponse

Exemple du contenu d'appel de réponse de requête des ateliers d'une activité Via HTML :

[
    {
        "subRoomId": "p3sdfsdfKk2bp6D6sdfguYcUsdfmKtsdfgQQ%sdfsdf3d%3sdd",
        "title": "Main Room",
        "isMainRoom": true
    },
    {
        "subRoomId": "KsdfsdsdffntCQv60sdfaOsdfTErgkTDlZhyw%3fsdfd%sdf3d",
        "title": "Atelier 1",
        "isMainRoom": false
    },
    {
        "subRoomId": "wsdfOsdf6gusdf30nvc2QlsdfQsucsdfo%2fNpgssdfdf%3d%3d",
        "title": "Atelier 2",
        "isMainRoom": false
    }
]

Description des champs

Nom	Obligatoire	Commentaires/description
subroomId		Identifiant unique de l'atelier. (Type string)
title		Titre de l'atelier
isMainRoom		Indique si l'atelier est la salle principale. (Type Booléen)

Description des codes d’erreurs des méthodes liées aux classes virtuelles

Numéro	Message	Commentaires/description
1700	Required id	Vous devez fournir un identifiant de classe virtuelle.
1701	Invalid id	L’identifiant fourni pour la classe virtuelle est invalide.
1702	End or Duration required	La date de fin ou la durée sont requis.
1703	Hyperlink is not available	L’hyperlien spécifié est déjà utilisé.
1704	Invalid coverId	L’identifiant du visuel de l'activité est invalide.
1705	Required presenterId	L’identifiant du présentateur de l'activité est requis lors de la création d’une activité.
1706	Invalid presenterId	L’identifiant du présentateur de l'activité est invalide.
1707	Required title	Le titre de l’activité est requis lors de la création d’une activité.
1708	Invalid title length	Le titre est invalide, il doit être entre 3 et 100 caractères.
1709	Ending date of the activity must be higher than the start date	La date de fin de l’activité doit être plus haut que la date de début.
1710	Hyperlink is invalid	Le format de l’hyperlien ne convient pas (Il doit contenir uniquement des chiffres et des lettres)
1711	Cannot be deleted	Tous les utilisateurs doivent être déconnectés pour pouvoir supprimer l’activité
1712	Invalid participantType	Le type de participant est invalide.
1713	Invalid userId	L’identifiant utilisateur est invalide.
1714	Presenter error	Il y a une erreur dans la requête concernant le présenteur.
1715	Invalid filterId	L’identifiant pour filter est invalide.
1716	Required userId	L’identifiant utilisateur est requis.
1717	Invalid DateTime	Spécifier une date de début ou de fin ou une durée n’est pas valide dans le cas d’une duplication d’une activité permanente.
1718	Invalid State	La valeur d’état doit être 1 = Active ou 3 = Inactive.
1719	Activity must have Active state to be duplicated	L’activité doit être active pour être dupliqué.
1720	Invalid playbackAccessType	La valeur pour le type d’accès par défaut pour les enregistrements est invalide.
1721	Invalid playbackExpirationDelay	La valeur d’expiration d’enregistrement par défaut est invalide.
1722	Missing required branches	Le paramètre « branches » est obligatoire.
1723	Invalid branchId	Un identifiant de branche est invalide.
1724	Cannot remove all branches	Impossible de supprimer toutes les branches administratives d’une activité.
1725	Cannot add branches	Impossible d'ajouter les branches administratives à une activité, car il y a des branches déjà ajoutées.
1726	Cannot remove branches	Impossible de supprimer les branches administratives d'une activité, car il y a des branches qui ne sont pas associées.
1727	Required users	Une liste d'utilisateurs est nécessaire pour envoyer des invitations.
1728	Invitation not sent	Il y a une erreur dans la requête concernant l'envoi.
1729	Invalid reminderType	La valeur du type de rappel est invalide.
1730	Invalid reminderTypeDelay	La valeur du délai n'est pas défini ou est invalide

French

ACTIVITÉS / CLASSES VIRTUELLES (VIA HTML)

Activity/create

Requête

Description des champs

Réponse

Description des champs

Activity/edit

Requête

Description des champs

Réponse

Description des champs

Activity/get

Requête

Description des champs

Réponse

Description des champs

Activity/delete

Requête

Description des champs

Réponse

Description des champs

Activity/getlist

Requête

Description des champs

Réponse

Description des champs

Activity/duplicate

Requête

Description des champs

Réponse

Description des champs

Activity/addparticipants

Requête

Description des champs

Réponse

Description des champs

Activity/removeparticipants

Requête

Description des champs

Réponse

Description des champs

Activity/setparticipants

Requête

Description des champs

Réponse

Description des champs

Activity/getparticipantlist

Requête

Description des champs

Réponse

Description des champs

Activity/getparticipantslogs

Requête

Description des champs

Réponse

Description des champs

Activity/getgroups

Requête

Description des champs

Réponse

Description des champs

Activity/addgroup

Requête

Description des champs

Réponse

Description des champs

Activity/removegroup

Requête

Description des champs

Réponse

Description des champs

Activity/unlinkgroup

Requête

Description des champs

Réponse

Description des champs

Activity/getbranches

Requête

Description des champs