LearnUpon
App Vendor: LearnUpon
App Category: IT Services
Connector Version: 1.0.3
API Version: 1.3.3
About App
The LearnUpon app is an employee onboarding platform that helps to speed up processes by automating manual and time-consuming tasks. LearnUpon helps to create and add users to groups, enroll users in courses, and exchange data.
The Learn Upon app is configured with Orchestrate application to perform the following actions:
Action Name | Description |
|---|---|
Create a New User | This action creates a new user. |
Get All Users | This action retrieves a list of all users. |
Get User for ID | This action retrieves the users for a user ID. |
Get User for Email | This action retrieves users for an email. |
Get User for Username | This action retrieves users for a username. |
Update User | This action updates the existing user details. |
Create an Enrollment | This action creates a new enrollment for a user. |
Get Enrollments for Enrollment ID | This action retrieves the enrollments for an enrollment ID. |
Get Enrollments for User | This action retrieves the enrollments for a user. |
Get Enrollments for Email | This action retrieves the enrollment for an email. |
Get Enrollments for Username | This action retrieves the enrollment for a username. |
Get Enrollments for Course Name | This action retrieves the enrollment for a course name. |
Get Courses | This action retrieves the courses. |
Get Learning Path | This action retrieves the learning paths on a portal. |
Create Learning Path Enrollment | This action creates a learning path enrollment. |
Get Learning Path Enrollment for Learning Path Enrollment ID | This action retrieves the learning path enrollments for a learning path enrollment ID. |
Get Learning Path Enrollment for User ID | This action retrieves the learning path enrollments for a user ID. |
Get Learning Path Enrollment for Email | This action retrieves the learning path enrollments for an email. |
Get Learning Path Enrollment for Username | This action retrieves the learning path enrollments for a username. |
Get Learning Path Enrollment for Learning Path Name | This action retrieves the learning path enrollments for a learning path name. |
Get Learning Path Enrollment for Learning Path ID | This action retrieves the learning path enrollments for a learning path ID. |
Configuration Parameters
The following configuration parameters are required for the LearnUpon app to communicate with the Learn Upon enterprise application. The parameters can be configured by creating instances in the Learn Upon app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Base URL | Enter the base URL to connect to LearnUpon. Example: "https://yourdomain.learnupon.com" | Text | Required | |
Username | Enter the username to access LearnUpon. Example: "988d4f13xfxfxfbfdfc7f54244aab" | Text | Required | |
Password | Enter the password. | Password | Required |
Action: Create a New user
This action creates a new user.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
First Name | Enter the first name of the user to be created. Example: "John" | Text | Required | |
Last Name | Enter the last name of the user. Example: "Carter" | Text | Required | |
Enter the email of the user. Example: "johncarter@samplelearningco.com" | Text | Required | ||
Username | Enter the username for the user to sign in. Example: "johnc@learningco" | Text | Required | Note: You can set a username between 6-30 characters. By default, you can use any unicode alphanumeric character such as + - . , $ # @ _ |
Password | Enter the new password. | Password | Required |
Example Request
[
{
"first_name": "John" ,
"last_name": "Carter”,
"email": "johncarter@samplelearningco.com",
"username": "johnc@learningco",
"password": "@1qwert$!j"
}
]Action: Get all Users
This action retrieves a list of all users.
Action Input Parameters
This action does not require any input parameter.
Action: Get User for ID
This action searches users for a user ID.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
User ID | Enter the user ID to search users. Example: 123123 | Integer | Required |
Example Request
[
{
"user_id": 123123
}
]Action: Get User for Email
This action searches users for an email.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Enter the email to search users. Example: "johncarter@samplelearningco.com" | Text | Required |
Example Request
[
{
"email": "johncarter@samplelearningco.com"
}
]Action: Get User for Username
This action retrieves the users for a username.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Username | Enter the username to search a user. Example: "JohnC@sampledomain.com" | Text | Required |
Example Request
[
{
"username": "JohnC@sampledomain.com"
}
]Action: Update User
This action updates the existing user details.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
User ID | Enter the user ID to update the user details. Example: 123123 | Integer | Required | |
First Name | Enter the updated first name. Example: "JohnC" | Text | Optional | |
Last Name | Enter the updated last name. Example: "CarterSmith" | Text | Optional | |
Username | Enter the new username. Example: "John@#76" | Text | Optional | Note: You can set a username between 6-30 characters. By default, you can use any unicode alphanumeric character such as + - . , $ # @ _ |
Password | Enter the updated password. | Password | Optional |
Example Request
[
{
"user_id": 123123,
"first_name": "JohnC”,
"last_name": "CarterSmith”,
"new_username": "John@#76”,
"password": "@1qwert$!j"
}
]Action: Create an Enrollment
This action creates a new enrollment for a user
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Enter the email of an existing user to create an enrollment. Example: "johncarter@samplelearningco.com" | Text | Required | ||
Course Name | Enter the course name. Example: "dsa" | Text | Required |
Example Request
[
{
"email": "johncarter@samplelearningco.com",
"course_name": "dsa"
}
]Action: Get Enrollment for Enrollment ID
This action retrieves the enrollment for an enrollment ID.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Enrollment ID | Enter the enrollment ID to search. Example: 2323 | Integer | Required |
Example Request
[
{
"enroll_id": 2323
}
]Action: Get Enrollments for User
This action retrieves the enrollments for a user based on the user ID.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
User ID | Enter the user ID to search enrollment. Example: 123123 | Integer | Required |
Example Request
[
{
"user_id": 123123
}
]Action: Get Enrollments for Email
This action retrieves all the enrollments based on the email address.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Enter the email address to retrieve the list of enrollments. Example: "johncarter@samplelearningco.com" | Text | Required |
Example Request
[
{
"email": "johncarter@samplelearningco.com"
}
]Action: Get Enrollments for Username
This action retrieves the enrollments for a username.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Username | Enter the username to search for the enrollments. Example: "JohnC" | Text | Required |
Example Request
[
{
"username": "JohnC"
}
]Action: Get Enrollment for Course Name
This action retrieves the enrollment for a course name.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Course Name | Enter the course name to search the enrollment. Example: "dsa" | Text | Required |
Example Request
[
{
"course_name": "dsa"
}
]Action: Get Courses
This action retrieves all courses.
Action Input Parameters
This action does not require any input parameter.
Action: Get Learning Path
This action searches for learning paths on a portal.
Action Input Parameters
This action does not require any input parameter.
Action: Create Learning Path Enrollment
This action creates a learning path enrollment.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Enter the email of the user for creating the learning path enrollment. Example: "johncarter@samplelearningco.com" | Text | Required | ||
Learning Path Name | Enter the learning path name. Example: "Hello API" | Text | Required |
Example Request
[
{
"email": "johncarter@samplelearningco.com",
"lp_name": "hello api"
}
]Action: Get Learning Path Enrollment for Learning path Enrollment ID
This action gets the learning path enrollments for learning path enrollment ID.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Learning Path enrollment ID | Enter the learning path enrollment ID to search the learning path enrollment. Example: 23321 | Integer | Required | . |
Example Request
[
{
"lpe_id": 23321
}
]Action: Get Learning Path Enrollment for User ID
This action searches the learning path enrollments for user ID.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
User ID | Enter the user ID to search for the learning path enrollment. Example: 123123 | Integer | Required |
Example Request
[
{
"user_id": 123123
}
]Action: Get Learning Path Enrollment by Email
This action gets the learning path enrollments by email.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Enter the email to search the learning path enrollment. Example: "johncarter@samplelearningco.com" | Text | Required |
Example Request
[
{
"email": "johncarter@samplelearningco.com"
}
]Action: Get Learning Path Enrollment for Username
This action gets the learning path enrollments for username.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Username | Enter the username to search for all the learning path enrollments. Example: "JohnC" | Text | Required |
Example Request
[
{
"username": "JohnC"
}
]Action: Get Learning Path Enrollment for Learning Path Name
This action gets the learning path enrollments for a learning path name.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Learning Path Name | Enter the learning path name to search for learning path enrollments. Example: "learnupon" | Text | Required | You can retrieve the Learning path name using the action Get Learning Path. |
Example Request
[
{
"lp_name": "learnupon"
}
]Action: Get Learning Path Enrollment for Learning Path ID
This action gets the learning path enrollments for learning path ID.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Learning path ID | Enter the learning path ID to search the learning path enrollment. Example: "learnupon" | Integer | Required | You can retrieve the Learning path ID using the action Get Learning Path. |
Example Request
[
{
"lp_id": "learnupon"
}
]