Activities / Virtual classrooms (Via HTML)

Created by Miro Lagueux, Modified on Mon, 31 Aug at 8:42 AM by Miro Lagueux

ACTIVITIES / VIRTUAL CLASSROOMS (VIA HTML)

« Activities / virtual classrooms » are all the Via HTML activities in your environment, and are named « activity » in the API.

Activity/create

Creates a new Via HTML activity in your environment.
API call address : https://.../lmsapi/activity/create

Request

Example of request call content to create a Via HTML activity:

{
"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"]
}

Field descriptions

Name	Required	Comments/description
Title - texts - text - languageId	X	Text: Title of the activity. (String type) Required for creation only. languageId: The title can be multilingual: 1 = French (Canada) 2 = English 3 = Spanish (Number type)
Description - texts - text - languageId	X	Text: Description of the activity. (String type) Required for creation only. languageId: The title can be multilingual: 1 = French (Canada) 2 = English 3 = Spanish (Number type)
startDate		Start date and time of the activity. An activity created without a start date will be of the permanent type. (String YYYY-MM-DDTHH:MM:SSZ)
endDate		End date and time of the activity. (String YYYY-MM-DDTHH:MM:SSZ)
hyperlink		Public hyperlink of the activity. Please enter only the end of the hyperlink; for example, if « 2dhfwwoh6jqh » were specified, the activity link would be <https://www.domaine.com/2dhfwwoh6jqh> (String type)
coverId		Unique identifier of the activity's cover image. (String type)
presenterId	X	Unique identifier (user) of the activity's presenter. (String type)
isPublicAccess		Specifies whether the activity is public or private. (Boolean type)
presenceMinutes		Defines the number of minutes required for a user to be considered present in the activity (0 by default). (Number type)
playbackAccessType		Specifies the default access type for recordings. 0 = Administrators 1 = Participants 2 = Public 3 = Public only (Number type)
playbackExpirationDelay		Sets the expiration delay for viewing recordings. 0 = No expiration (no time limit) (default value) 1 = 1 day 2 = 7 days 3 = 15 days 4 = 1 month 5 = 3 months 6 = 6 months 7 = 9 months 8 = 1 year (Number type)
recordingModeBehavior		Defines the recording mode of the activity. 0 = None 1 = Automatic 2 = Manual (Number type)
reminderType		Indicates the unit of measure used to define when the activity reminder will be sent to participants. 0 = None (default) 1 = Hours 2 = Days (Number type)
reminderTypeDelay		Defines the quantity of the unit of measure selected in the "reminderType" field (0 by default). Required if "reminderType" is other than none (0); the minimum value then becomes "1". The maximum allowed value is "99".
branches		Associates the activity with one or more administrative branches. If no branch is specified, the activity will be associated with the default branch of the organization chart. (String type)

Response

Example of the response call content when creating a Via HTML activity. The system returns the unique identifier of the created activity:

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

Field descriptions

Name	Required	Comments/description
id		Unique identifier of the created Via HTML activity. (String type)

Activity/edit

Modifies a Via HTML activity in your environment.
API call address : https://.../lmsapi/activity/edit

Request

Example of request call content to modify a Via HTML activity:

{
    "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
}

Field descriptions

Name	Required	Comments/description
id	X	Unique identifier of the Via HTML activity to modify. (String type)
Title - texts - text - languageId		Text: Title of the activity. (String type) Required for creation only. languageId: The title can be multilingual: 1 = French (Canada) 2 = English 3 = Spanish (Number type)
Description - texts - text - languageId		Text: Description of the activity. (String type) Required for creation only. languageId: The title can be multilingual: 1 = French (Canada) 2 = English 3 = Spanish (Number type)
startDate		Start date and time of the activity. An activity created without a start date will be of the permanent type. (String YYYY-MM-DDTHH:MM:SSZ)
endDate		End date and time of the activity. (String YYYY-MM-DDTHH:MM:SSZ)
duration		Duration of the activity in minutes. If specified, this field will override any value placed in the "endDate" field for the corresponding date and time. (Number type)
hyperlink		Public hyperlink of the activity. Please enter only the end of the hyperlink; for example, if « 2dhfwwoh6jqh » were specified, the activity link would be <https://www.domaine.com/2dhfwwoh6jqh> (String type)
coverId		Unique identifier of the activity's cover image. (String type)
presenterId		Unique identifier (user) of the activity's presenter. (String type)
isPublicAccess		Specifies whether the activity is public or private. (Boolean type)
state		Specifies the state (enabled or disabled) of the activity. (Number type) 1 = Active 3 = Inactive
presenceMinutes		Defines the number of minutes required for a user to be considered present in the activity (0 by default). (Number type)
playbackAccessType		Specifies the default access type for recordings. 0 = Administrators 1 = Participants 2 = Public 3 = Public only (Number type)
playbackExpirationDelay		Sets the expiration delay for viewing recordings. 0 = No expiration (no time limit) (default value) 1 = 1 day 2 = 7 days 3 = 15 days 4 = 1 month 5 = 3 months 6 = 6 months 7 = 9 months 8 = 1 year (Number type)
recordingModeBehavior		Defines the recording mode of the activity. 0 = None 1 = Automatic 2 = Manual (Number type)
reminderType		Indicates the unit of measure used to define when the activity reminder will be sent to participants. 0 = None (default) 1 = Hours 2 = Days (Number type)
reminderTypeDelay		Defines the quantity of the unit of measure selected in the "reminderType" field (0 by default). Required if "reminderType" is other than none (0); the minimum value then becomes "1". The maximum allowed value is "99".

Response

Example of response call content when modifying a Via HTML activity. The system returns the unique identifier of the modified activity:

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

Field descriptions

Name	Required	Comments/description
id		Unique identifier of the modified Via HTML activity. (String type)

Activity/get

Retrieves information about a Via HTML activity in your environment.

API call address : https://.../lmsapi/activity/get

Request

Example of request call content for information on a Via HTML activity:

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

Field descriptions

Name	Required	Comments/description
id	X	Unique identifier of the Via HTML activity for which information is requested. (String type)

Response

Example of response call content for an information request on a Via HTML activity. The system returns all the fields:

{
    "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
}

Field descriptions

Name	Required	Comments/description
id		Unique identifier of the Via HTML activity. (String type)
Title - texts - text - languageId		Text: Title of the activity. (String type) Required for creation only. languageId: The title can be multilingual: 1 = French (Canada) 2 = English 3 = Spanish (Number type)
Description - texts - text - languageId		Text: Description of the activity. (String type) Required for creation only. languageId: The title can be multilingual: 1 = French (Canada) 2 = English 3 = Spanish (Number type)
creatorUserId		Unique identifier of the user who created the activity. (String type)
startDate		Start date and time of the activity. An activity created without a start date will be of the permanent type. (String YYYY-MM-DDTHH:MM:SSZ)
endDate		End date and time of the activity. (String YYYY-MM-DDTHH:MM:SSZ)
creationDate		Date and time the activity was created. (String YYYY-MM-DDTHH:MM:SSZ)
duration		Duration of the activity in minutes. If specified, this field will override any value placed in the "endDate" field for the corresponding date and time. (Number type)
hyperlink		Public hyperlink of the activity. Please enter only the end of the hyperlink; for example, if « 2dhfwwoh6jqh » were specified, the activity link would be <https://www.domaine.com/2dhfwwoh6jqh> (String type)
coverId		Unique identifier of the activity's cover image. (String type)
isFromLMS		Indicates whether the activity is associated with a Lära LMS training session (workspaceInstance).
presenterId		Unique identifier (user) of the activity's presenter. (String type)
isPublicAccess		Specifies whether the activity is public or private. (Boolean type)
type		Type of this activity. 1 = Normal 2 = Permanent (Number type)
state		Specifies the state (enabled or disabled) of the activity. 1 = Active 3 = Inactive (Number type)
presenceMinutes		Defines the number of minutes required for a user to be considered present in the activity (0 by default). (Number type)
playbackAccessType		Specifies the default access type for recordings. 0 = Administrators 1 = Participants 2 = Public 3 = Public only (Number type)
playbackExpirationDelay		Sets the expiration delay for viewing recordings. 0 = No expiration (no time limit) (default value) 1 = 1 day 2 = 7 days 3 = 15 days 4 = 1 month 5 = 3 months 6 = 6 months 7 = 9 months 8 = 1 year (Number type)
recordingModeBehavior		Defines the recording mode of the activity. 0 = None 1 = Automatic 2 = Manual (Number type)
reminderType		Indicates the unit of measure used to define when the activity reminder will be sent to participants. 0 = None (default) 1 = Hours 2 = Days (Number type)
reminderTypeDelay		Defines the quantity of the unit of measure selected in the "reminderType" field (0 by default). Required if "reminderType" is other than none (0); the minimum value then becomes "1". The maximum allowed value is "99".

Activity/delete

Deletes a Via HTML activity in your environment.

API call address : https://.../lmsapi/activity/delete

Request

Example of request call content to delete a Via HTML activity:

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

Field descriptions

Name	Required	Comments/description
id	X	Unique identifier of the Via HTML activity to delete. (String type)

Response

Example of response call content for a request to delete a Via HTML activity:

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

Field descriptions

Name	Required	Comments/description
id		Unique identifier of the deleted Via HTML activity. (String type)

Activity/getlist

Retrieves a list of Via HTML activities or virtual classrooms in your environment (200).

API call address : https://.../lmsapi/activity/getlist

Request

Example of request call content for a list of Via HTML activities or virtual classrooms in your environment:

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

Field descriptions

Name	Required	Comments/description
filterDate		Retrieves the list of activities created since a specific date. (String YYYY-MM-DDTHH:MM:SSZ)
filterStartDate		Retrieves all activities that start after a specific date. (String YYYY-MM-DDTHH:MM:SSZ)
filterEndDate		When combined with a start date, retrieves all activities taking place between those dates. When used alone, it retrieves all activities that end after a specific date. (String YYYY-MM-DDTHH:MM:SSZ)
filterIndex		The index filter parameter is optional and corresponds to pagination of 200 activities. The method returns the list of 200 objects based on the index passed as a filter. An index filter of 1 returns activities 1 to 200, and an index filter of 2 returns activities 201 to 400.
filterIncludeDisabled		The disabled activities filter parameter is optional. By default they are never returned; the value 1 includes disabled activities in the list.

Response

Example of response call content for a request for a list of Via HTML activities:

[
    {
        "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
    }
}

Field descriptions

Name	Required	Comments/description
id		Unique identifier of the Via HTML activity. (String type)
Title - texts - text - languageId		Text: Title of the activity. (String type) Required for creation only. languageId: The title can be multilingual: 1 = French (Canada) 2 = English 3 = Spanish (Number type)
Description - texts - text - languageId		Text: Description of the activity. (String type) Required for creation only. languageId: The title can be multilingual: 1 = French (Canada) 2 = English 3 = Spanish (Number type)
creatorUserId		Unique identifier of the user who created the activity. (String type)
startDate		Start date and time of the activity. An activity created without a start date will be of the permanent type. (String YYYY-MM-DDTHH:MM:SSZ)
endDate		End date and time of the activity. (String YYYY-MM-DDTHH:MM:SSZ)
creationDate		End date and time of the activity. (String YYYY-MM-DDTHH:MM:SSZ)
duration		Duration of the activity in minutes. If specified, this field will override any value placed in the "endDate" field for the corresponding date and time. (Number type)
hyperlink		Public hyperlink of the activity. Please enter only the end of the hyperlink; for example, if « 2dhfwwoh6jqh » were specified, the activity link would be <https://www.domaine.com/2dhfwwoh6jqh> (String type)
coverId		Unique identifier of the activity's cover image. (String type)
isFromLMS		Indicates whether the activity is associated with a Lära LMS training session (workspaceInstance).
presenterId		Unique identifier (user) of the activity's presenter. (String type)
isPublicAccess		Specifies whether the activity is public or private. (Boolean type)
type		Type of this activity. 1 = Normal 2 = Permanent (Number type)
state		Specifies the state (enabled or disabled) of the activity. 1 = Active 3 = Inactive (Number type)
presenceMinutes		Defines the number of minutes required for a user to be considered present in the activity (0 by default). (Number type)
playbackAccessType		Specifies the default access type for recordings. 0 = Administrators 1 = Participants 2 = Public 3 = Public only (Number type)
playbackExpirationDelay		Sets the expiration delay for viewing recordings. 0 = No expiration (no time limit) (default value) 1 = 1 day 2 = 7 days 3 = 15 days 4 = 1 month 5 = 3 months 6 = 6 months 7 = 9 months 8 = 1 year (Number type)
recordingModeBehavior		Defines the recording mode of the activity. 0 = None 1 = Automatic 2 = Manual (Number type)

Activity/duplicate

Duplicates a Via HTML activity in your environment.

API call address : https://.../lmsapi/activity/duplicate

Request

Example of request call content to duplicate a Via HTML activity. By adding fields other than "id", you will give characteristics to your new activity (duplicate):

{
  "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
}

Field descriptions

Name	Required	Comments/description
id	X	Unique identifier of the activity. (String type)
title - texts - text - language		Text: Title of the new activity. (String type) languageId: The title can be multilingual: 1 = French (Canada) 2 = English 4 = Spanish (Number type)
startDate		Start date and time of the activity. (String YYYY-MM-DDTHH:MM:SSZ)
endDate		End date and time of the activity. (String YYYY-MM-DDTHH:MM:SSZ)
duration		Duration of the activity in minutes. If specified, this field will override any value placed in the "endDate" field for the corresponding date and time. (Number type)
includeUsers		Indicates whether the activity should keep the participants of the original activity. (Only the presenter will be kept when the value is false) (Boolean type)

Response

Example of response call content for a request to duplicate a Via HTML activity:

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

Field descriptions

Name	Required	Comments/description
id		Unique identifier of the duplicated Via HTML activity. (String type)

Activity/addparticipants

Adds participants to a Via HTML activity in your environment.

API call address : https://.../lmsapi/activity/addparticipants

Request

Example of request call content to add participants to a Via HTML activity:

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

Field descriptions

Name	Required	Comments/description
id	X	Unique identifier of the activity. (String type)
participantList	X	List of participants to add to the activity.
userId	X	Unique identifier of the user to add to the activity. (String type)
participantType		Type of participant to add to the activity. If left empty, the participant type is used by default. 0 = Participant 1 = Facilitator 2 = Host (Number type)

Response

Example of response call content for a request to add participants to a Via HTML activity:

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

Field descriptions

Name	Required	Comments/description
id		Unique identifier of the Via HTML activity to which participants were added. (String type)

Activity/removeparticipants

Removes participants from a Via HTML activity in your environment.

API call address : https://.../lmsapi/activity/removeparticipants

Request

Example of request call content to remove participants from a Via HTML activity:

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

Field descriptions

Name	Required	Comments/description
id	X	Unique identifier of the activity. (String type)
participantList	X	List of participants to remove from the activity.
userId	X	Unique identifier of the user to remove from the activity. (String type)

Response

Example of response call content for a request to remove participants from a Via HTML activity:

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

Field descriptions

Name	Required	Comments/description
id		Unique identifier of the Via HTML activity from which participants were removed. (String type)

Activity/setparticipants

Sets the participant list of a Via HTML activity in your environment. This call adds participants to the activity or removes them based on the new list. The full participant list is updated.

API call address : https://.../lmsapi/activity/setparticipants

Request

Example of request call content to update the participant list of a Via HTML activity:

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

Field descriptions

Name	Required	Comments/description
id	X	Unique identifier of the activity. (String type)
participantList	X	List of participants to add to the activity.
userId	X	Unique identifier of the user to add to the activity. (String type)
participantType		Type of participant to add to the activity. If left empty, the participant type is used by default. 0 = Participant 1 = Facilitator 2 = Host (Number type)

Response

Example of response call content for a request to update the participants of a Via HTML activity:

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

Field descriptions

Name	Required	Comments/description
id		Unique identifier of the Via HTML activity for which the participant list was updated. (String type)

Activity/getparticipantlist

Retrieves the participant list of a Via HTML activity in your environment.

API call address : https://.../lmsapi/activity/getparticipantlist

Request

Example of request call content for the participant list of a Via HTML activity:

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

Field descriptions

Name	Required	Comments/description
id	X	Unique identifier of the Via HTML activity for which the participant list is requested. (String type)

Response

Example of response call content for a request for the participant list of a Via HTML activity:

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

Field descriptions

Name	Required	Comments/description
id		Unique identifier of the activity. (String type)
participantList		List of participants in the activity.
userId		Unique identifier of a user in the activity. (String type)
participantType		Type of participant in the activity. 0 = Participant 1 = Facilitator 2 = Host (Number type)
isGuest		Indicates whether the participant is a guest or one of the environment's users. (Boolean type)

Activity/getparticipantslogs

Retrieves the connection times for one participant or for all participants of a Via HTML activity in your environment.

API call address : https://.../lmsapi/activity/getparticipantslogs

Request

Example of request call content for the connection times of one or more participants of a Via HTML activity:

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

Field descriptions

Name	Required	Comments/description
id	X	Unique identifier of the activity. (String type)
filterId		Unique identifier of a user in order to query that user only. If the parameter is omitted, the complete participant list will be returned.

Response

Example of response call content for a request for the connection times of one or more participants of a Via HTML activity:

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

Field descriptions

Name	Required	Comments/description
id		Unique identifier of the activity. (String type)
participantList		List of participants in the activity.
userId		Unique identifier of the user. (String type)
participantType		Type of participant in the activity. 0 = Participant 1 = Facilitator 2 = Host (Number type)
isGuest	Read only	Indicates whether the user is a guest user. (Boolean type)
connectionDuration	Read only	Connection time to the activity, in minutes. (Number type)
playbackDuration	Read only	Connection time spent playing back a recording of the activity, in minutes. (Number type)

Activity/getgroups

Retrieves the list of user groups associated with a Via HTML activity in your environment.

API call address : https://.../lmsapi/activity/getgroups

Request

Example of request call content for the list of groups associated with a Via HTML activity:

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

Field descriptions

Name	Required	Comments/description
id	X	Unique identifier of the activity. (String type)

Response

Example of response call content for a request for the list of user groups associated with a Via HTML activity:

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

Field descriptions

Name	Required	Comments/description
id		Unique identifier of the user group. (String type)
name - texts - text - languageId		Text: Name of the group. (String type) languageId: The group name can be multilingual: 1 = French (Canada) 2 = English 3 = Spanish (Number type)
creationDate		Initial creation date of the user group. (String YYYY-MM-DDTHH:MM:SSZ)
createdByUserId		Unique identifier of the user who created the user group. (String type)

Activity/addgroup

Adds a user group to a Via HTML activity in your environment.

API call address : https://.../lmsapi/activity/addgroup

Request

Example of request call content to add a group to a Via HTML activity:

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

Field descriptions

Name	Required	Comments/description
id	X	Unique identifier of the activity. (String type)
groupId	X	Unique identifier of the group to add to the activity. (String type)

Response

Example of response call content for a request to add a user group to a Via HTML activity:

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

Field descriptions

Name	Required	Comments/description
id		Unique identifier of the activity. (String type)
groupId		Unique identifier of the group to add to the activity. (String type)

Activity/removegroup

Removes a user group from a Via HTML activity in your environment. This call also removes the users from the activity.

API call address : https://.../lmsapi/activity/removegroup

Request

Example of request call content to remove a user group from a Via HTML activity:

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

Field descriptions

Name	Required	Comments/description
id	X	Unique identifier of the activity. (String type)
groupId	X	Unique identifier of the group to remove from the activity. (String type)

Response

Example of response call content for a request to remove a user group from a Via HTML activity:

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

Field descriptions

Name	Required	Comments/description
id		Unique identifier of the activity. (String type)
groupId		Unique identifier of the group to remove from the activity. (String type)

Activity/unlinkgroup

Unlinks a user group from a Via HTML activity in your environment. This call keeps the group's users in the activity.

API call address : https://.../lmsapi/activity/unlinkgroup

Request

Example of request call content to unlink a user group from a Via HTML activity:

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

Field descriptions

Name	Required	Comments/description
id	X	Unique identifier of the activity. (String type)
groupId	X	Unique identifier of the group to unlink from the activity. (String type)

Response

Example of response call content for a request to unlink a user group from a Via HTML activity:

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

Field descriptions

Name	Required	Comments/description
id		Unique identifier of the activity. (String type)
groupId		Unique identifier of the group to unlink from the activity. (String type)

Activity/getbranches

Retrieves the branch or branches of the organization chart to which a Via HTML activity in your environment is deemed to be attached.

API call address : https://.../lmsapi/activity/getbranches

Request

Example of request call content for the branches of a Via HTML activity:

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

Field descriptions

Name	Required	Comments/description
id	X	Unique identifier of the activity. (String type)

Response

Example of response call content for a request for the branches of a Via HTML activity:

[
    "OyaT0qm4u5Lt9ue3v97Kuw%3d%3d"
]

Field descriptions

Name	Required	Comments/description
-		Unique identifier of the branch or branches of the organization chart to which the activity is attached. (String type)

Activity/addbranches

Associates a Via HTML activity with one or more branches of your environment's organization chart.

API call address : https://.../lmsapi/activity/addbranches

Request

Example of call content to add a Via HTML activity to one or more branches of your environment's organization chart:

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

Field descriptions

Name	Required	Comments/description
id	X	Unique identifier of the activity. (String type)
branches	X	Unique identifier of the activity's branches. (String type)

Response

Example of response call content for a request to add a Via HTML activity to one or more branches of your environment's organization chart:

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

Field descriptions

Name	Required	Comments/description
id		Unique identifier of the activity associated with branches. (String type)

Activity/sendinvitation

Sends an invitation email to the participants of a Via HTML activity.

API call address : https://.../lmsapi/activity/sendinvitation

Request

Example of call content to send an invitation notification for a Via HTML activity:

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

Field descriptions

Name	Required	Comments/description
id	X	Unique identifier of the activity. (String type)
users	X	Unique identifier of the activity's branches. (String type)

Response

Example of response call content for a request to send an invitation notification for a Via HTML activity:

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

Field descriptions

Name	Required	Comments/description
id		Unique identifier of the activity. (String type)

Activity/getsubroomlist

Retrieves the list of breakout rooms of a Via HTML activity.

API call address : https://.../lmsapi/activity/getsubroomlist

Request

Example of request call content for the breakout rooms of a Via HTML activity:

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

Field descriptions

Name	Required	Comments/description
id	X	Unique identifier of the activity. (String type)

Response

Example of response call content for a request for the breakout rooms of a Via HTML activity:

[
    {
        "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
    }
]

Field descriptions

Name	Required	Comments/description
subroomId		Unique identifier of the breakout room. (String type)
title		Title of the breakout room
isMainRoom		Indicates whether the breakout room is the main room. (Boolean type)

Error code descriptions for virtual classroom methods

Number	Message	Comments/description
1700	Required id	You must provide a virtual classroom identifier.
1701	Invalid id	The identifier provided for the virtual classroom is invalid.
1702	End or Duration required	The end date or the duration is required.
1703	Hyperlink is not available	The specified hyperlink is already in use.
1704	Invalid coverId	The identifier of the activity's cover image is invalid.
1705	Required presenterId	The identifier of the activity's presenter is required when creating an activity.
1706	Invalid presenterId	The identifier of the activity's presenter is invalid.
1707	Required title	The activity title is required when creating an activity.
1708	Invalid title length	The title is invalid; it must be between 3 and 100 characters.
1709	Ending date of the activity must be higher than the start date	The activity end date must be later than the start date.
1710	Hyperlink is invalid	The hyperlink format is not valid (it must contain only numbers and letters)
1711	Cannot be deleted	All users must be disconnected before the activity can be deleted
1712	Invalid participantType	The participant type is invalid.
1713	Invalid userId	The user identifier is invalid.
1714	Presenter error	There is an error in the request concerning the presenter.
1715	Invalid filterId	The identifier used for filtering is invalid.
1716	Required userId	The user identifier is required.
1717	Invalid DateTime	Specifying a start date, an end date or a duration is not valid when duplicating a permanent activity.
1718	Invalid State	The state value must be 1 = Active or 3 = Inactive.
1719	Activity must have Active state to be duplicated	The activity must be active in order to be duplicated.
1720	Invalid playbackAccessType	The value for the default recording access type is invalid.
1721	Invalid playbackExpirationDelay	The default recording expiration value is invalid.
1722	Missing required branches	The « branches » parameter is required.
1723	Invalid branchId	A branch identifier is invalid.
1724	Cannot remove all branches	All administrative branches of an activity cannot be removed.
1725	Cannot add branches	The administrative branches cannot be added to an activity because some branches have already been added.
1726	Cannot remove branches	The administrative branches of an activity cannot be removed because some branches are not associated.
1727	Required users	A list of users is required in order to send invitations.
1728	Invitation not sent	There is an error in the request concerning the sending.
1729	Invalid reminderType	The reminder type value is invalid.
1730	Invalid reminderTypeDelay	The delay value is not defined or is invalid

Recent Searches

Popular Articles

Articles

Topics

Tickets

Activities / Virtual classrooms (Via HTML)

ACTIVITIES / VIRTUAL CLASSROOMS (VIA HTML)

Activity/create

Request

Field descriptions

Response

Field descriptions

Activity/edit

Request

Field descriptions

Response

Field descriptions

Activity/get

Request

Field descriptions

Response

Field descriptions

Activity/delete

Request

Field descriptions

Response

Field descriptions

Activity/getlist

Request

Field descriptions

Response

Field descriptions

Activity/duplicate

Request

Field descriptions

Response

Field descriptions

Activity/addparticipants

Request

Field descriptions

Response

Field descriptions

Activity/removeparticipants

Request

Field descriptions

Response

Field descriptions

Activity/setparticipants

Request

Field descriptions

Response

Field descriptions

Activity/getparticipantlist

Request

Field descriptions

Response

Field descriptions

Activity/getparticipantslogs

Request

Field descriptions

Response

Field descriptions

Activity/getgroups

Request

Field descriptions

Response

Field descriptions

Activity/addgroup

Request

Field descriptions

Response

Field descriptions

Activity/removegroup

Request

Field descriptions

Response

Field descriptions

Activity/unlinkgroup

Request

Field descriptions