Session (Lära)

Modified on Mon, 31 Aug at 11:18 AM

TABLE OF CONTENTS

COURSE AND EVENT SESSIONS

A "session" is a dated occurrence of a course or an event, in which users register and whose completion is tracked. A session in the API is named "workspaceinstance".

Sessions: workspaceinstance/get

https://www.domaine.com/lmsapi/workspaceinstance/get

Returns an object representing a session of a course or event.
API call address : https://.../lmsapi/workspaceinstance/get

Request

Example of request call content for information on a session:

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

Field descriptions

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

Response

Example of response call content for information on a session:

{
  "id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d", 
  "workspaceId": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
  "creationDate": "0001-01-01T00:00:00",
  "websiteId": "V7y5yT3O8nuCDCdA1rE%2fxg%3d%3d",
  "name": "Ma formation", 
  "startDate": "0001-01-01T00:00:00", 
  "endDate": "0001-01-01T00:00:00", 
  "minParticipants": 0, 
  "maxParticipants": 0, 
  "isOverBookingSubscription": false,   
  "nbUsersSubbed": -1, 
  "nbUsersQueue": -1,
  "daysAvailable": 365,
  "daysToComplete": 180,
  "isHidden": false,
  "status": 0,
  "isFormula": false,
  "locationId": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
  "createdByUserID": "%2fUtsC30QAPbKKJCD7cUkJA%3d%3d",
  "lastModificationDate": "0001-01-01T00:00:00",
  "taxEnabled": true,  
  "taxCountryId": 123,  
  "taxStateId": 321,
  "isPlannedActivityDisplayInCatalog": true,
  "gradingMode" : 0,
  "customFields": {
    "Champ1": "Snow",
    "Test": ""
  }
}

Field descriptions

Name	Comments/description
id	This is the unique identifier of the session. (String type)
workspaceId	Identifier of the workspace to which the session is linked. (String type)
websiteId	Identifier in the interface. (String type)
creationDate	Value available in GET only, used to obtain the creation date of the session. (String YYYY-MM-DDTHH:MM:SSZ)
name	Name of the session. (String type)
startDate	Start date of the session. Important for self-registration and catalogue visibility. (String YYYY-MM-DDTHH:MM:SSZ)
endDate	End date of the session. Important for self-registration and catalogue visibility. (String YYYY-MM-DDTHH:MM:SSZ)
minParticipants	Minimum number of participants for your session. (Number type)
maxParticipants	Maximum number of participants for your session. (Number type)
isOverBookingSubscription	Boolean used to enable or disable the waiting list for your session. (Boolean type)
nbUsersSubbed	Value available in GET only, used to obtain the number of users registered for the session. (Number type)
nbUsersQueue	Value available in GET only, used to obtain the number of users on the waiting list for the session. (Number type)
daysAvailable	Determines the number of days after a user's registration during which they have access to the content. (Number type)
daysToComplete	Determines the maximum number of days after a user's registration by which they must have completed the content. (Number type)
isHidden	Boolean used to indicate whether the session is in "Hide from catalogue" mode. Default value: false (Boolean type)
status	Status of the session. 0 = Active 1 = Cancelled 2 = Deleted (Number type)
isFormula	Determines whether the "À la carte" mode is enabled. (Boolean type)
locationId	Identifier of the location where the session takes place. The in-person activities created by the LMS will use this location by default. (String type)
createdByUserID	Identifier of the user who created the session. Read-only value. (String type)
lastModificationDate	Date of the last modification of the session. Cannot be modified. Available in get and getlist. (String YYYY-MM-DDTHH:MM:SSZ)
taxEnabled	Indicates whether taxes are enabled on the course or event. (Boolean type)
taxCountryId	Number indicating the country of the course or event. Number type (See Appendix 3: Countries and States/Provinces)
taxStateId	Number indicating the state of the course or event. Number type (See Appendix 3: Countries and States/Provinces)
isPlannedActivityDisplayInCatalog	Used to display planned activities in the catalogue on the session or not. (Boolean type)
gradingMode	Grading mode of the session. 0 = On the session 1 = On the resources (Number type)
customFields	Custom fields linked to the course or event.

Sessions: workspaceinstance/getlist

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

Returns the list of sessions of a course or event.
API call address : https://.../lmsapi/workspaceinstance/getlist

Request

Example of request call content for the list of sessions:

{
  "id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
  "filterDate": "YYYY-MM-DDTHH:MM:SSZ",
  "filterEditDate": "YYYY-MM-DDTHH:MM:SSZ",
  "filterIncludeDisabled": true
}

Field descriptions

Name	Required	Comments/description
id		Optional parameter representing the identifier of the course whose sessions are to be returned. (String type)
filterDate		Optional parameter corresponding to the creation date of the element. The method returns the list of objects that were created after the date passed as a filter. (String YYYY-MM-DDTHH:MM:SSZ)
filterEditDate		Optional parameter corresponding to the last modification date of the element. A modification made to a session may correspond to: Modification of the administrative settings of the session; The filterDate and filterEditDate parameters can be combined. (String YYYY-MM-DDTHH:MM:SSZ)
filterIncludeDisabled		Optional parameter. By default, cancelled sessions are not included in the return of this call. The value true includes cancelled sessions. (Boolean type)

Response

Example of response call content for the list of sessions:

[
  {
    "id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
    "workspaceId": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
    "creationDate": "0001-01-01T00:00:00",
    "websiteId": "V7y5yT3O8nuCDCdA1rE%2fxg%3d%3d",
    "name": "Ma formation",
    "startDate": "0001-01-01T00:00:00",
    "endDate": "0001-01-01T00:00:00",
    "minParticipants": 0,
    "maxParticipants": 0,
    "isOverBookingSubscription": false,
    "nbUsersSubbed": -1,
    "nbUsersQueue": -1,
    "daysAvailable": 365,
    "daysToComplete": 180,
    "isHidden": false,
    "status": 0,
    "isFormula": false,
    "locationId": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
    "createdByUserID": "%2fUtsC30QAPbKKJCD7cUkJA%3d%3d",
    "lastModificationDate": "0001-01-01T00:00:00",
    "gradingMode": 0
  }
]

Field descriptions

Name	Comments/description
id	This is the unique identifier of the session. (String type)
workspaceId	Identifier of the workspace to which the session is linked. (String type)
websiteId	Identifier in the interface. (String type)
creationDate	Value available in GET only, used to obtain the creation date of the session. (String YYYY-MM-DDTHH:MM:SSZ)
name	Name of the session. (String type)
startDate	Start date of the session. Important for self-registration and catalogue visibility. (String YYYY-MM-DDTHH:MM:SSZ)
endDate	End date of the session. Important for self-registration and catalogue visibility. (String YYYY-MM-DDTHH:MM:SSZ)
minParticipants	Minimum number of participants for your session. (Number type)
maxParticipants	Maximum number of participants for your session. (Number type)
isOverBookingSubscription	Boolean used to enable or disable the waiting list for your session. (Boolean type)
nbUsersSubbed	Value available in GET only, used to obtain the number of users registered for the session. (Number type)
nbUsersQueue	Value available in GET only, used to obtain the number of users on the waiting list for the session. (Number type)
daysAvailable	Determines the number of days after a user's registration during which they have access to the content. (Number type)
daysToComplete	Determines the maximum number of days after a user's registration by which they must have completed the content. (Number type)
isHidden	Boolean used to indicate whether the session is in "Hide from catalogue" mode. Default value: false (Boolean type)
status	Status of the session. 0 = Active 1 = Cancelled 2 = Deleted (Number type)
isFormula	Determines whether the "À la carte" mode is enabled. (Boolean type)
locationId	Identifier of the location where the session takes place. The in-person activities created by the LMS will use this location by default. (String type)
createdByUserID	Identifier of the user who created the session. Read-only value. (String type)
lastModificationDate	Date of the last modification of the session. Cannot be modified. Available in get and getlist. (String YYYY-MM-DDTHH:MM:SSZ)
taxEnabled	Indicates whether taxes are enabled on the course or event. (Boolean type)
taxCountryId	Number indicating the country of the course or event. Number type (See Appendix 3: Countries and States/Provinces)
taxStateId	Number indicating the state of the course or event. Number type (See Appendix 3: Countries and States/Provinces)
isPlannedActivityDisplayInCatalog	Used to display planned activities in the catalogue on the session or not. (Boolean type)
gradingMode	Grading mode of the session. 0 = On the session 1 = On the resources (Number type)
customFields	Custom fields linked to the course or event.

Sessions: workspaceinstance/getuserlist

https://www.domaine.com/lmsapi/workspaceinstance/getuserlist

Returns the list of users registered in a session of a course or event.
API call address : https://.../lmsapi/workspaceinstance/getuserlist

Request

Example of request call content for the list of users registered in a session:

{
  "id": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d",
  "filterDate": "YYYY-MM-DDTHH:MM:SSZ",
   "filterIncludeDisabled" : false
}

Field descriptions

Name	Required	Comments/description
id		Identifier of a session of a course or event. (String type)
filterDate		Optional parameter corresponding to the creation date of the element. The method returns the list of objects that were created after the date passed as a filter. (String YYYY-MM-DDTHH:MM:SSZ)
filterIncludeDisabled		Optional parameter. When the parameter is not provided, all the registrations in an active session, and even the cancelled registrations ("Unregistered" and "Disabled"), are included in the return of this call. The value true returns all the registrations in a session even if it is cancelled. The value false excludes the registrations with the "Unregistered" and "Disabled" statuses only in an active session. (Boolean type)

Response

Example of response call content for the list of users registered in a session:

[
  {
    "userId": "Jv3rHIZqqtZrVY0PIPSrlQ%3d%3d",
    "firstName": "John",
    "lastName": "Smith",
    "billingId": "FYDTzsHATli%2fHQ2O8Jsi7g%3d%3d",
    "status": 1,
    "creationDate": "2020-03-04T10:45:39.82",
    "subscriptionDate": "2020-03-04T10:45:39.82",
    "roleId": "O%2f9dsKKECyJSUWkOK37D8g%3d%3d",
    "provenance": 3
  },
  {
    "userId": "C4i4iN558zEjSMd61%2fo8qA%3d%3d",
    "firstName": "Peter",
    "lastName": "Jackman",
    "billingId": "kV2Jp00zjTFP7fG8ntfqCA%3d%3d",
    "status": 1,
    "creationDate": "2020-03-04T10:45:39.863",
    "subscriptionDate": "2020-03-04T10:45:39.863",
    "roleId": "O%2f9dsKKECyJSUWkOK37D8g%3d%3d",
    "provenance": 3
  },
  {
    "userId": "tA3yMUqx02%2b%2b%2fZcDHHR0tg%3d%3d",
    "firstName": "Joe",
    "lastName": "Johnson",
    "billingId": "l0zjIxBuxsjuZCHqTdbCmA%3d%3d",
    "status": 1,
    "creationDate": "2020-03-04T10:45:39.89",
    "subscriptionDate": "2020-03-04T10:45:39.89",
    "roleId": "O%2f9dsKKECyJSUWkOK37D8g%3d%3d",
    "provenance": 3
  }
]

Field descriptions

Name

Comments/description

userId

Unique identifier of the registered user (String type)

firstName

First name of the registered user

(String type)

lastName

Last name of the registered user

(String type)

billingId

Unique identifier of the registration billing for the session.

(String type)

status

Status of the registration

0 = Inactive
1 = Registered
2 = Pending
3 = Unregistered
4 = Disabled
5 = Transferred
6 = Expired
7 = Unconfirmed
8 = Expired with access

(Number type)

creationDate

Date on which the registration was made.

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

subscriptionDate

Date on which the registration was confirmed or accepted.

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

roleId

Identifier of the role of the registered user.

(String type)

provenance

Source of the user's registration

0 = GroupSubscription
1 = BranchSubscription
2 = ManualSubscription
3 = SelfSubscription
4 = LotPurchaseSubscription
5 = ProgramSubscription
6 = AutoResubscription

(Number type)

Sessions: workspaceinstance/create

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

Creates a session for a course or an event.
API call address : https://.../lmsapi/workspaceinstance/create

Request

Example of request call content to create a session:

{
  "workspaceId": "vBW5xMw1VQ2A8DFaNy22zA%3d%3d", 
  "name": "Ma formation", 
  "maxParticipants": 0, 
  "minParticipants": 0,
  "startDate": "0001-01-01T00:00:00", 
  "endDate": "0001-01-01T00:00:00", 
  "isOverBookingSubscription": false,   
  "isHidden": false,
  "locationId": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
  "customFields": {
    "Champ1": "Snow",
    "Test": ""
  }
}

Field descriptions

Name	Required	Comments/description
workspaceId	X	Identifier of the workspace to which the session is linked. (String type)
name	X	Name of the session. (String type)
maxParticipants	X	Maximum number of participants for your session. (Number type)
minParticipants	X	Minimum number of participants for your session. (Number type)
startDate		Start date of the session. (String YYYY-MM-DDTHH:MM:SSZ)
endDate		End date of the session. (String YYYY-MM-DDTHH:MM:SSZ)
isOverBookingSubscription		Boolean used to enable or disable the waiting list. (Boolean type)
daysAvailable		Number of days after registration during which the user has access to the content. (Number type)
daysToComplete		Maximum number of days after registration to complete the content. (Number type)
isHidden		Indicates whether the session is hidden from the catalogue. (Boolean type)
isFormula		Determines whether the "À la carte" mode is enabled. (Boolean type)
locationId		Identifier of the location where the session takes place. (String type)
gradingMode		Grading mode of the session. 0 = On the session 1 = On the resources (Number type)
customFields		Custom fields linked to the session.

Response

Example of response call content when creating a session:

Field descriptions

Name	Comments/description
id	Unique identifier of the created session. (String type)

Sessions: workspaceinstance/edit

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

Modifies an existing session.
API call address : https://.../lmsapi/workspaceinstance/edit

Request

Example of request call content to edit a session:

{
   "id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d", 
  "name": "Ma formation",
  "startDate": "0001-01-01T00:00:00", 
  "endDate": "0001-01-01T00:00:00", 
  "minParticipants": 0, 
  "maxParticipants": 0, 
  "isOverBookingSubscription": false,
  "daysAvailable": 365,
  "daysToComplete": 180,  
  "isHidden": false,
  "isFormula": false,
  "locationId": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
  "customFields": {
    "Champ1": "Snow",
    "Test": ""
  }
}

IMPORTANT: Only the id value is required; the values that are not sent during editing are simply not updated.

Field descriptions

Name	Required	Comments/description
id	X	Unique identifier of the session to modify. (String type)
name		Name of the session. (String type)
maxParticipants		Maximum number of participants for your session. (Number type)
minParticipants		Minimum number of participants for your session. (Number type)
startDate		Start date of the session. (String YYYY-MM-DDTHH:MM:SSZ)
endDate		End date of the session. (String YYYY-MM-DDTHH:MM:SSZ)
isOverBookingSubscription		Boolean used to enable or disable the waiting list. (Boolean type)
daysAvailable		Number of days after registration during which the user has access to the content. (Number type)
daysToComplete		Maximum number of days after registration to complete the content. (Number type)
isHidden		Indicates whether the session is hidden from the catalogue. (Boolean type)
isFormula		Determines whether the "À la carte" mode is enabled. (Boolean type)
locationId		Identifier of the location where the session takes place. (String type)
gradingMode		Grading mode of the session. 0 = On the session 1 = On the resources (Number type)
customFields		Custom fields linked to the session.

Response

Example of response call content when editing a session:

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

Field descriptions

Name	Comments/description
id	Unique identifier of the modified session. (String type)

Sessions: workspaceinstance/delete

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

Deletes an existing session.
API call address : https://.../lmsapi/workspaceinstance/delete

Request

Example of request call content to delete a session:

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

Field descriptions

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

Response

Example of response call content when deleting a session:

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

Field descriptions

Name	Comments/description
id	Unique identifier of the deleted session. (String type)

Sessions: workspaceinstance/subscribeusers

https://www.domaine.com/lmsapi/workspaceinstance/subscribeusers

Registers several users in a session.
API call address : https://.../lmsapi/workspaceinstance/subscribeusers

Request

Example of request call content to register users in a session:

{
  "id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
  "userIds": ["5G5hg343fggalp4JQ%3d%3d","7Z9345EWRTm7TQjdlQ%3d%3d"] ,
  "subscriptionDate": "2023-02-22T09:30:00.000"
}

Field descriptions

Name	Required	Comments/description
id	X	Unique identifier of the session. (String type)
userIds	X	List of the unique identifiers of the users to register. (List of strings type)
subscriptionDate		An optional subscriptionDate field exists when a specific registration date is to be specified. If none is specified (null), the current date and time will be used. (String YYYY-MM-DDTHH:MM:SSZ)

Response

Example of response call content when registering users in a session:

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

Field descriptions

Name	Comments/description
id	Unique identifier of the session in which the users were registered. (String type)

Sessions: workspaceinstance/subscribeuser

https://www.domaine.com/lmsapi/workspaceinstance/subscribeuser

Registers a user in a session.
API call address : https://.../lmsapi/workspaceinstance/subscribeuser

Request

Example of request call content to register a user in a session:

{
  "id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
  "userId": "5G5hg343fggalp4JQ%3d%3d",
  "subscriptionDate": "2023-02-22T09:30:00.000" 
}

Field descriptions

Name	Required	Comments/description
id	X	Unique identifier of the session. (String type)
userId	X	Unique identifier of the user to register. (String type)
subscriptionDate		An optional subscriptionDate field exists when a specific registration date is to be specified. If none is specified (null), the current date and time will be used. (String YYYY-MM-DDTHH:MM:SSZ)

Response

Example of response call content when registering a user in a session:

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

Field descriptions

Name	Comments/description
id	Registration identifier of the registered user. (String type)

Sessions: workspaceinstance/getuserresourcecompletionlist

https://www.domaine.com/lmsapi/workspaceinstance/getuserresourcecompletionlist

Returns the list of completion details of the resources of a course session for a registration.
API call address : https://.../lmsapi/workspaceinstance/getuserresourcecompletionlist

Request

Example of request call content for the list of resource completions for a registration:

{
  "id": "7Zi3zYvuHTZ7YLK7TQjdlQ%3d%3d",
  "workspaceInstanceId": "VJRRva0G1SLnlhn3vs7rQA%3d%3d"
}

Field descriptions

IMPORTANT: Only the details of active users are returned by the API.

Name	Required	Comments/description
id	X	Identifier of a user's registration. (String type)
workspaceInstanceId		Identifier of a course session. To be used when the same registration identifier corresponds to more than one session. This can happen when a registration is transferred to another session. (String type)

Response

Example of response call content for the list of resource completions for a registration:

[
    {
        "resourceId": "I8sAL3jQfx%2fuIAl%2bUCYFCw%3d%3d",
        "parentResourceId": null,
        "title": "Module_1",
        "resourceType": 6,
        "credits": 0.00,
        "categoryId": null,
        "adminCode": "",
        "creationDate": "2024-08-07T13:48:36.307",
        "dateCondition": null,
        "dateEndCondition": null,
        "minParticipants": 0,
        "maxParticipants": 0,
        "completionDate": "2024-08-16T17:42:46.497",
        "isCompleted": true,
        "isSuccess": true,
        "certificateId": null,
        "completionPoints": 8,
        "obtainedPoints": 8,
        "duration": 60,
        "sectionPosition": 1,
        "resourcePosition": 2,
        "sectionTitle": "Section par défaut",
        "sessionId": "5xq1pmToL2W34EmS3sAElg%3d%3d",
        "moduleResources": [
            {
                "completionDate": "2024-08-16T17:42:57.703",
                "isCompleted": true,
                "obtainedPoints": 0,
                "duration": 20,
                "resourceId": "XM%2b%2fYiItTx0KO4UKfxu6yw%3d%3d",
                "title": "Module1_ress1",
                "resourceType": 1,
                "completionPoints": 0,
                "sessionId": "EeAj0XPFV%2fZGONobGc3Xmg%3d%3d"
            },
            {
                "isCompleted": false,
                "obtainedPoints": 0,
                "duration": 10,
                "resourceId": "6y%2f%2fxDcGBZzlKu5Z16grRQ%3d%3d",
                "title": "Module1_ress2",
                "resourceType": 1,
                "completionPoints": 0,
                "sessionId": null
            },
            {
                "completionDate": "2024-08-16T17:43:18.39",
                "isCompleted": true,
                "obtainedPoints": 0,
                "duration": 10,
                "resourceId": "YUwxqkTk7isY8AuE6JU9Vg%3d%3d",
                "title": "aaaa",
                "resourceType": 5,
                "completionPoints": 0,
                "sessionId": null
            },
            {
                "completionDate": "2024-08-16T17:43:25.37",
                "isCompleted": true,
                "obtainedPoints": 0,
                "duration": 10,
                "resourceId": "oRUSmxbMkPWLH5geOPdZDg%3d%3d",
                "title": "aqwer",
                "resourceType": 11,
                "completionPoints": 4,
                "sessionId": null
            },
            {
                "completionDate": "2024-08-16T17:45:17.757",
                "isCompleted": true,
                "obtainedPoints": 0,
                "duration": 10,
                "resourceId": "M0cWdYzMEWN63AdbRUBLYg%3d%3d",
                "title": "FORMATI F1",
                "resourceType": 11,
                "completionPoints": 123,
                "sessionId": "2o4ZlGvtB9%2feOAae6rVDqA%3d%3d"
            }
        ]
    },
    {
        "resourceId": "swtEd%2bKK9LodkzrX9xZy0Q%3d%3d",
        "parentResourceId": null,
        "title": "Module_2",
        "resourceType": 6,
        "credits": 0.00,
        "categoryId": null,
        "adminCode": "",
        "creationDate": "2024-08-08T12:30:40.633",
        "dateCondition": null,
        "dateEndCondition": null,
        "minParticipants": 0,
        "maxParticipants": 0,
        "completionDate": null,
        "isCompleted": false,
        "isSuccess": null,
        "certificateId": "Y0D0Wfz93PjzpVlnREnthg%3d%3d",
        "completionPoints": 0,
        "obtainedPoints": 0,
        "duration": 60,
        "sectionPosition": 1,
        "resourcePosition": 3,
        "sectionTitle": "Section par défaut",
        "sessionId": "alCXA7t%2bHaESdG0BY9jZ9Q%3d%3d",
        "moduleResources": [
            {
                "isCompleted": false,
                "obtainedPoints": 0,
                "duration": 20,
                "resourceId": "2QEH7NEzUYWjNC7yzCmklA%3d%3d",
                "title": "ress1_mod2",
                "resourceType": 11,
                "completionPoints": 0,
                "sessionId": null
            },
            {
                "isCompleted": false,
                "obtainedPoints": 0,
                "duration": 20,
                "resourceId": "QZVPmGCAY1UrEAHdR7SRvg%3d%3d",
                "title": "ress2",
                "resourceType": 1,
                "completionPoints": 0,
                "sessionId": null
            },
            {
                "isCompleted": false,
                "obtainedPoints": 6,
                "duration": 20,
                "resourceId": "Rz2PbnX0fb5e814CSBap2A%3d%3d",
                "title": "Capture d’écran 2024-06-05 161442FICHI",
                "resourceType": 1,
                "completionPoints": 8,
                "sessionId": null
            }
        ]
    },
    {
        "resourceId": "UQGnEhW0yJqMcfuEE8dgbQ%3d%3d",
        "parentResourceId": null,
        "title": "dépot1",
        "resourceType": 12,
        "credits": 0.00,
        "categoryId": null,
        "adminCode": "",
        "creationDate": "2024-08-08T12:32:08.543",
        "dateCondition": null,
        "dateEndCondition": null,
        "minParticipants": 0,
        "maxParticipants": 0,
        "completionDate": "2024-09-05T14:27:30.337",
        "isCompleted": true,
        "isSuccess": true,
        "certificateId": null,
        "completionPoints": 16,
        "obtainedPoints": 9,
        "duration": 20,
        "sectionPosition": 2,
        "resourcePosition": 1,
        "sectionTitle": "SECTIONDEUX",
        "sessionId": null
    }
]

Field descriptions

Name	Comments/description
resourceId	Identifier of the resource (Type: String)
parentResourceId	Identifier of the parent resource of this one Null if it does not have a parent resource. (Type: String)
resourceType	Type of the resource 1 = Document (Word, Excel, PowerPoint, Video, etc.) 2 = Via HTML, Zoom or Zoom Webinar activity 3 = In-person activity 4 = N/A 5 = Survey 6 = Module 7 = N/A 8 = SCORM object 9 = Text block (no completion possible) 10 = Quiz 11 = Formative quiz 12 = Assignment drop box 13 = Moodle object (Type : Number)
credits	Number of credits obtained through the completion of this resource by the registrant (Type: Number)
adminCode	Administrative code of the resource. (Type: String)
creationDate	Creation date of this resource. (String YYYY-MM-DDTHH:MM:SSZ)
dateCondition	Date from which the resource is available. Null if not defined. (String YYYY-MM-DDTHH:MM:SSZ)
dateEndCondition	Date on which the resource is no longer available. Null if not defined. (String YYYY-MM-DDTHH:MM:SSZ)
categoryId	Identifier of the category associated with this resource. (Type : String)
certificateId	Identifier of the certification associated with this resource. (Type : String)
minParticipants	Minimum number of participants required for this resource or activity. (Type : Integer)
maxParticipants	Maximum number of participants for this resource or activity. (Type: Integer)
completionDate	Completion date of this resource by the registrant. Null if the resource is not completed. (String YYYY-MM-DDTHH:MM:SSZ)
isCompleted	Indicates whether the resource is completed. (Type : Boolean)
isSuccess	Indicates whether the user completed the resource successfully or not. Null if not applicable for this type of resource. (Type : Boolean)
completionPoints	Number of points to be obtained through the completion of this resource by the registrant (Type : Number)
obtainedPoints	Number of points obtained by the registrant for this resource (Type : Integer)
duration	Time in seconds that the registrant spent in this resource (Type : Integer)
sectionPosition	Position of the section that contains this resource (Type : Integer)
resourcePosition	Position of the resource in the content of the session (Type : Integer)
sectionTitle	Title of the section of the resource (Type : Integer)
sessionId	Identifier of the session associated with this resource (Type : String)
moduleResources	List containing the resources contained in a resource of the Module type (Type: List)
moduleResources .completionDate	Completion date of the resource in the module by the registrant. Not displayed if the resource is not completed. (String YYYY-MM-DDTHH:MM:SSZ)
moduleResources .isCompleted	Indicates whether the resource in the module is completed. (Type : Boolean)
moduleResources.resourceId	Unique identifier of the resource contained in the module (Type : String)
moduleResources.title	Title of the resource contained in the module (Type : String)
moduleResources.resourceType	Type of the resource contained in the module (Type : String)
moduleResources.completionPoints	Completion points of the resource contained in the module (Type : Number)
moduleResources.obtainedPoints	Number of points obtained by the registrant for this resource in the module (Type : Integer)

Sessions: workspaceinstance/getresourcelist

https://www.domaine.com/lmsapi/workspaceinstance/getresourcelist

Returns the list of details of the resources of a course session.
API call address : https://.../lmsapi/workspaceinstance/getresourcelist

Request

Example of request call content for the list of resources of a session:

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

Field descriptions

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

Response

Example of response call content for the list of resources of a session:

[
    {
        "resourceId": "jnKQkzdIDj6/4Ww+nspwPA==",
        "parentResourceId": "",
        "title": "Questionnaire noté",
        "resourceType": 10,
        "credits": 5.00,
        "adminCode": "",
        "creationDate": "2020-07-07T20:27:12.303",
        "dateCondition": null,
        "dateEndCondition": null,
        "categoryId" : null,
        "certificateId": null,
        "minParticipants": 0,
        "maxParticipants": 0,
        "completionPoints": 0,
        "sectionPosition": 1,
        "resourcePosition": 1,
        "sectionTitle": "Default section",
        "usersCompletion": [
         {
          "userId": "3mCrRAsA6ZEonpg234234xqc2VQA%3d%3d",
          "billingId": "j9XoGU3mn7fvb45b5K7vuvsg9LQ%3d%3d",
          "isCompleted": false,
          "isSuccess": null
        },
        {
          "userId": "PFjUV2AbVTMG3Ksdf56456EiPb1CkQ%3d%3d",
          "billingId": "x9XNzlzm6b7w55h67s4idU%2f7NSOiew%3d%3d",
          "isCompleted": true,
          "isSuccess": true
        } 
      ]
    },
    {
        "resourceId": "Cjfode5wCmSAxDBPmxUH4w==",
      "parentResourceId": "",
        "title": "Classe virtuelle",
        "resourceType": 2,
        "credits": 3.00,
        "adminCode": "",
        "creationDate": "2020-05-06T19:29:04.76",
        "dateCondition": null,
        "dateEndCondition": null,
        "categoryId" : null,
        "minParticipants": 0,
        "maxParticipants": 0,
        "completionDate": "2020-07-07T20:21:28.113",
        "completionPoints": 0,
        "sectionPosition": 1,
        "resourcePosition": 2,
        "sectionTitle": "Default section",
        "usersCompletion": [
        {
          "userId": "3mCrRAsA6ZEonpg234234xqc2VQA%3d%3d",
          "billingId": "j9XoGU3mn7fvb45b5K7vuvsg9LQ%3d%3d",
          "isCompleted": true,
          "isSuccess": true,
          "credits": 2.5
        },
        {
          "userId": "PFjUV2AbVTMG3Ksdf56456EiPb1CkQ%3d%3d",
          "billingId": "x9XNzlzm6b7w55h67s4idU%2f7NSOiew%3d%3d",
          "isCompleted": false,
          "isSuccess": null,
          "credits": 0
        } 
      ]
    },
    {
        "resourceId": "cbOYWAa343b5n4nvgnhb81aWrXptOTPwyEQ==",
      "parentResourceId": "",
        "title": "Module",
        "resourceType": 6,
        "credits": 3.00,
        "adminCode": "",
        "creationDate": "2020-05-06T19:28:12.707",
        "dateCondition": null,
        "dateEndCondition": null,
        "categoryId" : null,
        "minParticipants": 0,
        "maxParticipants": 0,
        "completionDate": null,
        "completionPoints": 0,
        "sectionPosition": 1,
        "resourcePosition": 3,
        "sectionTitle": "Default section",
        "usersCompletion": [],
         "moduleResources": [
            {
                "resourceId": "Q0dwYTCoGM5%2f6WtMIOSFSw%3d%3d",
                "title": "tom fencer",
                "resourceType": 1,
                "completionPoints": 0
            },
            {
                "resourceId": "xr%2bRMKQDAFtu0cUDzu%2bZvQ%3d%3d",
                "title": "hjkhjkhjk",
                "resourceType": 11,
                "completionPoints": 0
            }
        ]
    },
    {
        "resourceId": "hqoiLDqEj2UANHVVkVTkGg%3d%3d",
      "parentResourceId": "cbOYWAa343b5n4nvgnhb81aWrXptOTPwyEQ==",
        "title": "Sondage",
        "resourceType": 5,
        "credits": 3.00,
        "adminCode": "",
        "creationDate": "2020-05-06T19:28:12.707",
        "dateCondition": null,
        "dateEndCondition": null,
        "categoryId" : null,
        "minParticipants": 0,
        "maxParticipants": 0,
        "completionDate": null,
        "completionPoints": 0,
        "sectionPosition": 1,
        "resourcePosition": 4,
        "sectionTitle": "Default section",
        "usersCompletion": []
    }
]

Field descriptions

Name	Comments/description
resourceId	Identifier of the resource. (Type: String)
parentResourceId	Identifier of the parent resource of this one. (Type: String)
resourceType	Type of the resource 1 = Document (Word, Excel, PowerPoint, Video, etc.) 2 = Via HTML, Zoom or Zoom Webinar activity 3 = In-person activity 4 = N/A 5 = Survey 6 = Module 7 = N/A 8 = SCORM object 9 = Text block (no completion possible) 10 = Quiz 11 = Formative quiz 12 = Assignment drop box 13 = Moodle object (Type : Number)
credits	Number of credits obtained through the completion of this resource by the registrant. (Type: Number)
adminCode	Administrative code of the resource. (Type: String)
creationDate	Creation date of this resource. (String YYYY-MM-DDTHH:MM:SSZ)
dateCondition	Date from which the resource is available. Null if not defined. (String YYYY-MM-DDTHH:MM:SSZ)
dateEndCondition	Date on which the resource is no longer available. Null if not defined. (String YYYY-MM-DDTHH:MM:SSZ)
minParticipants	Minimum number of participants required for this resource or activity. (Type : Integer)
maxParticipants	Maximum number of participants for this resource or activity. (Type: Integer)
completionPoints	Number of points to be obtained through the completion of this resource by the registrant (Type : Number)
sectionPosition	Position of the section that contains this resource (Type : Integer)
resourcePosition	Position of the resource in the content of the session (Type : Integer)
sectionTitle	Title of the section of the resource (Type : String)
usersCompletion	List containing the list of users who have access to this resource as well as the completion information for it. (Type: List)
usersCompletion.userId	Unique identifier of the user. (Type : String)
usersCompletion.billingId	Unique identifier of the user's registration. (Type : String)
usersCompletion.isCompleted	Indicates whether the resource is completed for this user. (Type: Boolean)
usersCompletion.isSuccess	Indicates whether the user completed the resource successfully or not. Null if not applicable for this type of resource. (Type : Boolean)
usersCompletion.credits	Number of credits obtained by the user for this resource (Number type)
moduleResources	List containing the resources contained in a resource of the Module type (Type: List)
moduleResources.resourceId	Unique identifier of the resource (Type : String)
moduleResources.title	Title of the resource (Type : String)
moduleResources.resourceType	Type of the resource (Type : Integer)
moduleResources.completionPoints	Completion points of the resource (Type : Number)

Sessions: workspaceinstance/getcompletion

https://www.domaine.com/lmsapi/workspaceinstance/getcompletion

Returns the completion details of a course session for a specific registration.
API call address : https://.../lmsapi/workspaceinstance/getcompletion

Request

Example of request call content for the completion details of a registration:

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

Field descriptions

Name	Required	Comments/description
id	X	Identifier of a user's registration. (String type)

Response

Example of response call content for the completion details of a registration:

{
    "workspaceInstanceId": "svfshXWaAIeuJVsdfsdf92cr5fng%3d%3d",
    "userId": "S6QQM%2bgPrrasdasdkaqeKRgTudmQ%3d%3d",
    "billingId": "7Zi3zYvuHTZ7YsdfsdLK7TQjdlQ%3d%3d ",
    "completionDate": "2021-02-17T15:04:06.687",
    "manualCompletionDate": "2021-02-17T15:04:06.687",
    "modificationDate": "2021-02-17T15:04:06.687",
    "modifiedByUserId": "DR7sYn48%2asdasdfuzi3b4fTGZ1nQ%3d%3d",
    "isCompleted": true,
    "isSuccess": true,
    "certificateId": "",
    "progressionPercent": 100,
    "creditsObtained": 1.00
}

Field descriptions

Name	Comments/description
workspaceInstanceId	Identifier of the session. (Type: String)
userId	Identifier of the user. (Type: String)
billingId	Identifier of the user's registration. (Type: String)
completionDate	Completion date of the registration. (String YYYY-MM-DDTHH:MM:SSZ)
manualCompletionDate	Date on which the completion was performed manually by an administrator. Empty if completed otherwise. (String YYYY-MM-DDTHH:MM:SSZ)
modificationDate	Date of the last modification of the completion. (String YYYY-MM-DDTHH:MM:SSZ)
modifiedByUserId	Identifier of the user who modified the completion manually. (Type: String)
isCompleted	Indicates whether the completion of the session by the user is done. (Type: Boolean)
isSuccess	Indicates whether the completion of the session by the user was completed with failure or success. (Type: Boolean)
certificateId	Identifier of the certificate associated with the completion of the registration. (Type: String)
progressionPercent	Indicates the progress of the registration in the session. (Type : Number)
creditsObtained	Indicates the number of credits obtained by the user (Number type)

Sessions: workspaceinstance/setcompletion

https://www.domaine.com/lmsapi/workspaceinstance/setcompletion

Modifies the completion details of a course session for a specific registration.
API call address : https://.../lmsapi/workspaceinstance/setcompletion

Request

Example of request call content to modify the completion details:

{
  "id": "7Zi3zYvuHTZ7YsdfsddfgLK7TQjdlQ%3d%3d",
  "isCompleted": true,
  "isSuccess": true,
  "completionDate": "2021-02-17T15:04:06.687"
}

Field descriptions

Name	Required	Comments/description
id	X	Identifier of a user's registration. (String type)
isCompleted	X	Indicates whether the completion is done. (Boolean type)
isSuccess		Indicates whether the completion is a success or a failure. If not provided, success is used by default. (Boolean type)
completionDate		To set a specific completion date. Otherwise the moment the call was made will be used. (String YYYY-MM-DDTHH:MM:SSZ)

Response

Example of response call content when modifying the completion details:

{
  "id": "7Zi3zYvuHTZ7YsdfsddfgLK7TQjdlQ%3d%3d",
  "isCompleted": true,
  "isSuccess": true,
  "completionDate": "2021-02-17T15:04:06.687"
}

Field descriptions

Name	Comments/description
id	Identifier of a user's registration. (String type)
isCompleted	Indicates whether the completion is done. (Boolean type)
isSuccess	Indicates whether the completion is a success or a failure. (Boolean type)
completionDate	Completion date of the registration. (String YYYY-MM-DDTHH:MM:SSZ)

Sessions: workspaceinstance/getcompletionlist

https://www.domaine.com/lmsapi/workspaceinstance/getcompletionlist

Returns the list of completions of the registrations of a session.
API call address : https://.../lmsapi/workspaceinstance/getcompletionlist

Request

Example of request call content for the list of completions:

{
    "filterId": "HHjmOri6Olr%2fCPfwPL9RYA%3d%3d",
    "filterDate" : "2020-06-23",
    "filterIndex": 1
}

Field descriptions

Name	Required	Comments/description
filterId		Optional parameter corresponding to the identifier of a session whose list of completions is to be retrieved. (String type)
filterDate		Optional parameter corresponding to the date the completion was last modified. The method returns the list of objects whose date is after the date passed as a filter. (String YYYY-MM-DDTHH:MM:SSZ)
filterIndex		Optional parameter corresponding to pagination of 200 completions. An index filter of 1 returns completions 1 to 200, and an index filter of 2 returns completions 201 to 400. If this parameter is not used, the return of this call will contain at most 100 elements. (Number type)

Response

Example of response call content for the list of completions:

[
    {
        "workspaceInstanceId": "HHjmOri6Olr%2fCPfwPL9RYA%3d%3d",
        "userId": "fXUahxX%2fIwT8ZY2xvyYAIA%3d%3d",
        "billingId": "e0nKeBcWqr5855xBTXG5PQ%3d%3d",
        "completionDate": "2024-05-06T17:25:49.683",
        "manualCompletionDate": "2024-05-06T17:25:49.683",
        "modificationDate": "2024-05-06T17:25:49.72",
        "modifiedByUserId": "p8V%2fzu0l1%2f5NDo%2ftHpCEkQ%3d%3d",
        "isCompleted": true,
        "isSuccess": true,
        "certificateId": "",
        "progressionPercent": 0,
        "creditsObtained": 0.00
    },
    {
        "workspaceInstanceId": "HHjmOri6Olr%2fCPfwPL9RYA%3d%3d",
        "userId": "0UMoqf3eneEOXbfkyGXtcQ%3d%3d",
        "billingId": "CulZe4L%2bCfTGXKC2KdtdUg%3d%3d",
        "completionDate": "2024-05-03T09:45:54.913",
        "manualCompletionDate": "2024-05-03T09:45:54.913",
        "modificationDate": "2024-05-03T09:45:55.223",
        "modifiedByUserId": "p8V%2fzu0l1%2f5NDo%2ftHpCEkQ%3d%3d",
        "isCompleted": true,
        "isSuccess": true,
        "certificateId": "",
        "progressionPercent": 0,
        "creditsObtained": 0.00
    }
]

Field descriptions

Name	Comments/description
workspaceInstanceId	Identifier of the session. (String type)
userId	Identifier of the user. (String type)
billingId	Identifier of the user's registration. (String type)
completionDate	Completion date of the registration. (String YYYY-MM-DDTHH:MM:SSZ)
manualCompletionDate	Date on which the completion was performed manually by an administrator. Empty if completed otherwise. (String YYYY-MM-DDTHH:MM:SSZ)
modificationDate	Date of the last modification of the completion. (String YYYY-MM-DDTHH:MM:SSZ)
modifiedByUserId	Identifier of the user who modified the completion manually. (String type)
isCompleted	Indicates whether the completion of the session by the user is done. (Boolean type)
isSuccess	Indicates whether the completion of the session was finished with failure or success. (Boolean type)
certificateId	Identifier of the certificate associated with the completion of the registration. (String type)
progressionPercent	Indicates the progress of the registration in the session. (Number type)
creditsObtained	Indicates the number of credits obtained by the user. (Number type)

Error code descriptions for course sessions

Number	Message	Comments/description
500	Required id	You must provide an identifier for the course or event.
501	Invalid id	The identifier provided for the course or event is invalid.
502	Required type	You must provide an identifier for the type of the course or event.
503	Invalid type	The identifier provided for the type of the course or event is not valid.
504	Required name	You must provide a name for the course or event.
505	Invalid name length	The name provided for the course or event must contain between 5 and 250 characters inclusively.
506	Required minParticipants	You must provide a minimum number of participants.
507	Invalid minParticipants	The minimum number of participants provided must be greater than or equal to 0.
508	Required maxParticipants	You must provide a maximum number of participants.
509	Invalid maxParticipants	The maximum number of participants provided must be greater than or equal to 0.
510	Required subscriptionType	You must provide the registration type.
511	Required isOverBookingSubscription	You must provide "True" or "False".
512	Required authorizationType	You must provide the authorization type for registrations.
513	Required visibilityType	You must provide the visibility type of the course.
514	Required showAvailableSubscriptions	You must provide "True" or "False".
515	Required accreditationNumber	If self-declaration is enabled, you must provide an accreditation number.
516	Invalid accreditationNumber length	The accreditation number provided is invalid.
517	Invalid userId	The unique identifier of the user is invalid.
518	Required BillingID	The registration identifier is required for the call to /workspaceinstance/getuserresourcecompletionlist.
519	Invalid BillingID	The registration identifier provided is invalid.
520	Invalid website id	The website identifier provided is invalid.
521	Required isCompleted	The parameter indicating the completion to assign to the registration is required.
522	Invalid gradingMode	The value provided for the grading mode of the session is invalid.
523	Cannot edit gradingMode	When there are registrations in the session, this value cannot be modified
524	Can't delete workspaceInstance	When the session is linked to an external connector, it cannot be deleted.

Recent Searches

Popular Articles

Articles

Topics

Tickets

Session (Lära)

COURSE AND EVENT SESSIONS

Sessions: workspaceinstance/get

Request

Field descriptions

Response

Field descriptions

Sessions: workspaceinstance/getlist

Request

Field descriptions

Response

Field descriptions

Sessions: workspaceinstance/getuserlist

Request

Field descriptions

Response

Field descriptions

Sessions: workspaceinstance/create

Request

Field descriptions

Response

Field descriptions

Sessions: workspaceinstance/edit

Request

Field descriptions

Response

Field descriptions

Sessions: workspaceinstance/delete

Request

Field descriptions

Response

Field descriptions

Sessions: workspaceinstance/subscribeusers

Request

Field descriptions

Response

Field descriptions

Sessions: workspaceinstance/subscribeuser

Request

Field descriptions

Response

Field descriptions

Sessions: workspaceinstance/getuserresourcecompletionlist

Request

Field descriptions

Response

Field descriptions

Sessions: workspaceinstance/getresourcelist

Request

Field descriptions

Response

Field descriptions

Sessions: workspaceinstance/getcompletion

Request

Field descriptions

Response

Field descriptions

Sessions: workspaceinstance/setcompletion

Request

Field descriptions

Response

Field descriptions

Sessions: workspaceinstance/getcompletionlist

Request

Field descriptions

Response

Field descriptions

Error code descriptions for course sessions

Was this article helpful?