Changes to module endpoint parameters
To support Live Learning through the API, LearnUpon has changed its module
endpoint parameters. Learn more about Live Learning: overview and features.
Availability: depends on your LearnUpon plan
In LearnUpon's API, the Live Learning events are called modules
, the same as the other types of modules that make up courses.
To enable API features for Live Learning, LearnUpon:
- added parameters to represent events and sessions
- changed the way module
id
works
From 7 March 2022: for events you create in Live Learning, the module id
is no longer unique to a single event (module), but is associated with as many sessions as you create within the event (module).
This change could affect custom integrations which currently rely on a unique id
for each event.
This change applies to Live Learning events (modules) only: no other module id
is changing.
You can continue using the legacy ILT modules within courses. You can't add both legacy and Live Learning events to the same course.
The following worked examples are from the same demo portal. They illustrate how the module id
works differently with different ILT modules.
Example of Live Learning event, called a module
The following example shows:
- module
id
associated with multiple sessions -
training_id
identifies the event that hosts sessions. The training ID is associated with multiple sessions -
session_id
is the unique identifier for individual sessions
Sample response for Live Learning event (module) with multiple sessions using same module id
{
"modules": [
{
"id": 405223,
"title": "Use APIs to get the most from automation",
"number_of_linked_courses": 4,
"tags": null,
"training_id": 14307,
"session_id": 12222,
"created_at": "2021-11-17T13:54:22Z",
"updated_at": "2021-12-23T11:51:41Z",
"exam_id": null,
"component_type": "ilt session",
"description_html": "Use LearnUpon's API to make creating users and enrollments seamless.",
"description_text": "Use LearnUpon's API to make creating users and enrollments seamless.",
"creator_id": 240669,
"creator_first_name": "Elsa",
"creator_last_name": "Bouvier",
"creator_email": "elsa.bouvier@yourcompany.com",
"assignment_passing_percentage": "",
"assignment_question_html": "",
"assignment_question_text": "",
"location_id": -1,
"location": "",
"address_1": "",
"address_2": null,
"address_3": "",
"location_country_code": "",
"location_state_code": "",
"start_at": "2022-01-05T11:00:00Z",
"end_at": "2022-01-05T12:30:00Z",
"timezone": "Dublin",
"number_enrolled_on_session": 8,
"max_capacity": 10,
"session_tutor_id": 240669,
"tutor_first_name": "Elsa",
"tutor_last_name": "Bouvier",
"tutor_email": "elsa.bouvier@yourcompany.com"
},
{
"id": 405223,
"title": "Use APIs to get the most from automation",
"number_of_linked_courses": 4,
"tags": null,
"training_id": 14307,
"session_id": 12333,
"created_at": "2021-11-23T10:54:02Z",
"updated_at": "2021-11-23T12:32:09Z",
"exam_id": null,
"component_type": "ilt session",
"description_html": "Use LearnUpon's API to make creating users and enrollments seamless.",
"description_text": "Use LearnUpon's API to make creating users and enrollments seamless.",
"creator_id": 240669,
"creator_first_name": "Elsa",
"creator_last_name": "Bouvier",
"creator_email": "elsa.bouvier@yourcompany.com",
"assignment_passing_percentage": "",
"assignment_question_html": "",
"assignment_question_text": "",
"location_id": -1,
"location": "",
"address_1": "",
"address_2": null,
"address_3": "",
"location_country_code": "",
"location_state_code": "",
"start_at": "2021-11-24T11:00:00Z",
"end_at": "2021-11-24T12:30:00Z",
"timezone": "Dublin",
"number_enrolled_on_session": 3,
"max_capacity": 3,
"session_tutor_id": 240669,
"tutor_first_name": "Elsa",
"tutor_last_name": "Bouvier",
"tutor_email": "elsa.bouvier@yourcompany.com"
},
{
"id": 405223,
"title": "Use APIs to get the most from automation",
"number_of_linked_courses": 4,
"tags": null,
"training_id": 14307,
"session_id": 12355,
"created_at": "2021-11-23T15:47:21Z",
"updated_at": "2021-11-24T12:20:56Z",
"exam_id": null,
"component_type": "ilt session",
"description_html": "Use LearnUpon's API to make creating users and enrollments seamless.",
"description_text": "Use LearnUpon's API to make creating users and enrollments seamless.",
"creator_id": 240669,
"creator_first_name": "Elsa",
"creator_last_name": "Bouvier",
"creator_email":"elsa.bouvier@yourcompany.com",
"assignment_passing_percentage": "",
"assignment_question_html": "",
"assignment_question_text": "",
"location_id": -1,
"location": "",
"address_1": "",
"address_2": null,
"address_3": "",
"location_country_code": "",
"location_state_code": "",
"start_at": "2021-11-25T13:00:00Z",
"end_at": "2021-11-25T14:30:00Z",
"timezone": "Dublin",
"number_enrolled_on_session": 2,
"max_capacity": 2,
"session_tutor_id": 291141,
"tutor_first_name": "Berengar",
"tutor_last_name": "Hesse",
"tutor_email": "demouser1@yourcompany.com"
},
]
}
Example of legacy ILT module
For legacy ILT modules, you create a single session per module.
The following example shows:
- module
id
is unique for each module -
training_id
null -
session_id
null
Sample response for legacy ILT module, with unique module id
per ILT module
{
"modules": [
{
"id": 552896,
"title": "New course with live training",
"number_of_linked_courses": 1,
"tags": null,
"training_id": null,
"session_id": null,
"created_at": "2022-02-02T14:52:54Z",
"updated_at": "2022-02-02T14:52:54Z",
"exam_id": null,
"component_type": "ilt session",
"description_html": null,
"description_text": null,
"creator_id": 240669,
"creator_first_name": "Elsa",
"creator_last_name": "Bouvier",
"creator_email": "elsa.bouvier@yourcompany.com",
"assignment_passing_percentage": "",
"assignment_question_html": "<p>Learn the best way to use APIs to create users and enrollments in LearnUpon.</p>\n",
"assignment_question_text": "Learn the best way to use APIs to create users and enrollments in LearnUpon.\n",
"location_id": null,
"location": "",
"address_1": "",
"address_2": "",
"address_3": "",
"location_country_code": "",
"location_state_code": "",
"start_at": "2022-02-08T13:00:00Z",
"end_at": "2022-02-08T14:00:00Z",
"timezone": "Dublin",
"number_enrolled_on_session": 0,
"max_capacity": 5,
"session_tutor_id": null,
"tutor_first_name": "",
"tutor_last_name": "",
"tutor_email": ""
},
{
"id": 552897,
"title": "New course with live training",
"number_of_linked_courses": 1,
"tags": null,
"training_id": null,
"session_id": null,
"created_at": "2022-02-02T14:54:20Z",
"updated_at": "2022-02-02T14:54:20Z",
"exam_id": null,
"component_type": "ilt session",
"description_html": null,
"description_text": null,
"creator_id": 240669,
"creator_first_name": "Elsa",
"creator_last_name": "Bouvier",
"creator_email": "elsa.bouvier@yourcompany.com",
"assignment_passing_percentage": "",
"assignment_question_html": "<p>Make the most of APIs to create users in LearnUpon.</p>\n",
"assignment_question_text": "Make the most of APIs to create users in LearnUpon.\n",
"location_id": null,
"location": "",
"address_1": "",
"address_2": "",
"address_3": "",
"location_country_code": "",
"location_state_code": "",
"start_at": "2022-02-11T20:00:00Z",
"end_at": "2022-02-11T21:00:00Z",
"timezone": "Central Time (US & Canada)",
"number_enrolled_on_session": 0,
"max_capacity": 5,
"session_tutor_id": null,
"tutor_first_name": "",
"tutor_last_name": "",
"tutor_email": ""
}
]
}
See: