Introduction
Welcome to our API documentation!
Authenticating requests
This API is not authenticated.
Accredible
It allows users to receive digital credentials
Validate Accredible Key
Validates whether the given key is correct.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/accredible/validate-key/3cc557a91d67378f7fc29fed973e5c94" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/accredible/validate-key/3cc557a91d67378f7fc29fed973e5c94"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Success",
"status": "success"
}Request
GET
api/accredible/validate-key/{key}
URL Parameters
key string
Key of the accredible needs to be validated.
Accredible Groups Lookup
Retrieves all the accredible groups. Helps while showing group names in dropdown elements.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/accredible/group/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/accredible/group/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"isEnabled": true,
"data": [
{
"id": 353767,
"name": "group_aom_course"
},
{
"id": 353282,
"name": "intro-ce"
},
{
"id": 352594,
"name": "aom"
}
]
}Request
GET
api/accredible/group/lookup
Announcements
Announcements are used to send messages to all students. Helps in reaching out to students when Instructor needs to notice everyone.
Create Announcement
To create announcement, you need to use this request. (See parameters) Created announcement can be used to send messages out to students.
Returns : id of the text module created and successfull message
Example request:
curl -X POST \
"https://demo.aomlms.com/api/announcement" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"heading":"New Announcement","content":"This is for test purpose","expiry":"2020-08-05","sending_rules":"all","user_ids":[],"course_ids":[]}'
const url = new URL(
"https://demo.aomlms.com/api/announcement"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"heading": "New Announcement",
"content": "This is for test purpose",
"expiry": "2020-08-05",
"sending_rules": "all",
"user_ids": [],
"course_ids": []
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 1,
"message": "Announcement Created Successfully"
}Request
POST
api/announcement
Body Parameters
heading string
Heading of the announcement.
content string
Content(Body) for the announcement that students will see.
expiry date optional
Till what date, the announcement is active for users.
sending_rules string
Rule for sending announcement, based on this rule announcement will be sent to all or specific users or users of specific courses. Sending rules options: all, specific_users or specific_course_users.
user_ids array optional
Id of the users which needs to receive announcement specifically (required if sending_rules set as student wise).
course_ids array optional
Id of the courses where student enrolled, needs to receive announcement specifically (required if sending_rules set as course wise).
Announcement Tabular List
Returns all the announcement in a tabular list format in paginated mode. You can apply filter using search_param via heading of the announcements.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/announcement/tabularlist?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22heading%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/announcement/tabularlist"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"heading":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"id": 1,
"heading": "New Announcement",
"author": "Aom Staff",
"content": "This is for test purpose",
"created_at": "Aug 11, 2020 01:25 PM",
"sent_to": "All"
}
]
}Request
GET
api/announcement/tabularlist
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on field names.
Update Announcement
Updates the details of a specified announcement. (See parameters) Announcement can be used to send out messages to students.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/announcement/2" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"heading":"New Announcement","content":"This is for test purpose","expiry":"2020-08-05","sending_rules":"all","user_ids":[],"course_ids":[]}'
const url = new URL(
"https://demo.aomlms.com/api/announcement/2"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"heading": "New Announcement",
"content": "This is for test purpose",
"expiry": "2020-08-05",
"sending_rules": "all",
"user_ids": [],
"course_ids": []
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Announcement Updated Successfully"
}Request
PUT
api/announcement/{id}
URL Parameters
id string
ID of the announcement needs to be updated.
Body Parameters
heading string
Heading of the announcement.
content string
Content(Body) for the announcement that students will see.
expiry date optional
Till what date, the announcement is active for users.
sending_rules string
Rule for sending announcement, based on this rule announcement will be sent to all or specific users or users of specific courses. Sending rules options: all, specific_users or specific_course_users.
user_ids array optional
Id of the users which needs to receive announcement specifically (required if sending_rules set as student wise).
course_ids array optional
Id of the courses where student enrolled, needs to receive announcement specifically (required if sending_rules set as course wise).
Retrieve Announcement
Retrieves the details of the specified announcement. Helps in fetching announcement using its ID. (See Parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/announcement/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/announcement/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 1,
"heading": "New Announcement",
"content": "This is for test purpose",
"sending_rules": "all",
"expiry": "2020-08-05"
}Request
GET
api/announcement/{id}
URL Parameters
id string
ID of the announcement you want to fetch the details of.
Delete Announcement
To delete an announcement, you need to use this request. Returns number of announcement deleted. (See Response)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/announcement/delete" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"delete_ids":[1,12,15]}'
const url = new URL(
"https://demo.aomlms.com/api/announcement/delete"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"delete_ids": [
1,
12,
15
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "3 announcement(s) deleted "
}Request
POST
api/announcement/delete
Body Parameters
delete_ids array
All announcement IDs which needs to be deleted.
Student Announcement List
Returns all the announcement in list format in paginated mode. You can apply filter using search_param via heading of the announcements. These annoucement list will appear in student panel(dashboard) not admin panel.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/student/announcements?page_size=5&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C%22direction%22%3A%22desc%22%7D&search_param=%7B%22heading%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/student/announcements"
);
let params = {
"page_size": "5",
"page_number": "1",
"order_by": "{"colName":"created_at","direction":"desc"}",
"search_param": "{"heading":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"avatar": "<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"40\" height=\"40\" viewBox=\"0 0 40 40\"><circle cx=\"20\" cy=\"20\" r=\"20\" stroke=\"background\" stroke-width=\"0\" fill=\"#00BCD4\" \/><text x=\"20\" y=\"20\" font-size=\"14\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">AS<\/text><\/svg>",
"recordsTotal": 1,
"recordsFiltered": 0,
"records": []
}Request
GET
api/student/announcements
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on field names.
Assignments
An Assignment Module is a lesson module used as course content. Helps to perform CRUD operation to and for Assignments modules.
Assignment Modules Tabular List
Returns all the assignment modules in a tabular list format in paginated mode. You can apply filter using search_param via associatedCourse(modules used in course) and moduleName.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/modules/assignment?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22associatedCourse%22%3A%22%22%2C%22moduleName%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/modules/assignment"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"associatedCourse":"","moduleName":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 2,
"recordsFiltered": 2,
"records": [
{
"id": 4,
"name": "assign",
"slug": "assign",
"type": "assignment",
"submissionType": "file",
"totalPoints": 50,
"icon": "<i class=\"el-icon-edit-outline\"><\/i>",
"author": "Aom Staff",
"created_at": "Aug 10, 2020 06:43 AM"
},
{
"id": 2,
"name": "assignment 1",
"slug": "assignment-1",
"type": "assignment",
"submissionType": "text",
"totalPoints": 100,
"icon": "<i class=\"el-icon-edit-outline\"><\/i>",
"author": "Aom Staff",
"created_at": "Aug 09, 2020 07:25 AM"
}
]
}Request
GET
api/modules/assignment
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on field names.
Create Assignment Module
To create a assignment module, you need to use this request. (See parameters) Created assignment modules can be used in the course as course content/lesson.
Returns : id of the assignment created and successfull message
Example request:
curl -X POST \
"https://demo.aomlms.com/api/modules/assignment" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"Essay on LMS","content":"A brief description","submission_type":"file","totalPoints":25,"allowed_filetypes":"[\"image\", \"pdf\"]"}'
const url = new URL(
"https://demo.aomlms.com/api/modules/assignment"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "Essay on LMS",
"content": "A brief description",
"submission_type": "file",
"totalPoints": 25,
"allowed_filetypes": "[\"image\", \"pdf\"]"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 10,
"message": "Module saved successfully"
}Request
POST
api/modules/assignment
Body Parameters
name string
Name of the assignment module.
content string
Content for the assignment modules that students will see.
submission_type string
Type for the assignment module(file based or text based). Submission type options: text or file.
totalPoints integer optional
Student will get this number if they complete the assignment.
allowed_filetypes string optional
Allowed file types that will be submitted by the students when the submission_type is file(required).
Update Assignment Module
Updates the details of specified assignment module. (See parameters) Assignment modules can be used in the course as course content.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/modules/assignment/{id}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"Essay on LMS","content":"An Updated brief description","submission_type":"file","totalPoints":25,"allowed_filetypes":"[\"image\", \"pdf\"]"}'
const url = new URL(
"https://demo.aomlms.com/api/modules/assignment/{id}"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "Essay on LMS",
"content": "An Updated brief description",
"submission_type": "file",
"totalPoints": 25,
"allowed_filetypes": "[\"image\", \"pdf\"]"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Module updated successfully"
}Request
PUT
api/modules/assignment/{id}
Body Parameters
name string
Name of the assignment module.
content string
Content for the assignment modules that students will see.
submission_type string
Type for the assignment module(file based or text based). Submission type options: text or file.
totalPoints integer optional
Student will get this number if they complete the assignment.
allowed_filetypes string optional
Allowed file types that will be submitted by the students when the submission_type is file(required).
Retrieve Assignment Modules
Retrieves the details of the specified assignment module. Helps in fetching assignment module using its ID. (See Parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/modules/assignment/2" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/modules/assignment/2"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "assignment 1",
"slug": "assignment-1",
"content": "Hola",
"totalPoints": 100,
"submission_type": "text",
"allowed_filetypes": [
""
]
}Request
GET
api/modules/assignment/{id}
URL Parameters
id string
ID of the assignment module you want to fetch the details of.
Retrieve Detailed Assignment Module Info
Retrieves details of assignment module in depth as well as different modules details that are being used as course content for the same course the current assignment module is attached to. Returns related fields value. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/module/assignment/details?registrationId=1&moduleId=9" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/module/assignment/details"
);
let params = {
"registrationId": "1",
"moduleId": "9",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "Essay on LMS",
"slug": "essay-on-lms",
"content": "A brief description",
"courseName": "course 1",
"courseSlug": "http:\/\/localhost:8000\/course\/course-1",
"totalPoints": 25,
"submissionType": "text",
"maxUploadSize": 5,
"min_time_spent": 0,
"allowedFileTypes": ".",
"otherModules": [
{
"module_id": 1,
"name": "test",
"slug": "test",
"type": "text",
"icon": "<i class=\"el-icon-tickets\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": 1,
"status": "Completed",
"started_on": "2020-08-03T10:02:33.000000Z",
"completed_on": "2020-08-03T10:02:41.000000Z",
"last_accessed_on": "8 hours ago",
"total_time_spent": {
"hours": 0,
"minutes": 0,
"seconds": 6,
"totalSeconds": 6
},
"completion_percentage": 100,
"no_of_times_accessed": 3
},
{
"module_id": 4,
"name": "assign",
"slug": "assign",
"type": "assignment",
"icon": "<i class=\"el-icon-edit-outline\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": true,
"status_row_id": -1,
"status": "Not Started",
"started_on": "",
"completed_on": "",
"last_accessed_on": "Never",
"total_time_spent": "",
"points_awarded": "",
"completion_percentage": 0,
"no_of_times_accessed": 0
},
{
"module_id": 7,
"name": "First-quiz",
"slug": "first-quiz",
"type": "quiz",
"icon": "<i class=\"el-icon-discover\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": -1,
"status": "Not Started",
"started_on": "",
"completed_on": "",
"last_accessed_on": "Never",
"total_time_spent": "",
"points_awarded": "",
"completion_percentage": 0,
"no_of_times_accessed": 0
},
{
"module_id": 9,
"name": "My-video-lesson",
"slug": "my-video-lesson",
"type": "video",
"icon": "<i class=\"el-icon-video-play\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": 4,
"status": "In Progress",
"started_on": "2020-08-10T20:04:14.000000Z",
"completed_on": null,
"last_accessed_on": "6 hours ago",
"total_time_spent": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"totalSeconds": null
},
"completion_percentage": 0,
"no_of_times_accessed": 1
},
{
"module_id": 10,
"name": "Essay on LMS",
"slug": "essay-on-lms",
"type": "assignment",
"icon": "<i class=\"el-icon-edit-outline\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": 5,
"status": "Completed",
"started_on": "2020-08-11T02:47:32.000000Z",
"completed_on": "2020-08-11T02:47:32.000000Z",
"last_accessed_on": "46 seconds ago",
"total_time_spent": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"totalSeconds": null
},
"completion_percentage": 100,
"no_of_times_accessed": 1
}
],
"launchCheck": {
"canbeLaunched": true,
"errTitle": "",
"errDesc": ""
},
"prevSlug": "my-video-lesson",
"nextSlug": "",
"status": "Completed",
"statusRowId": 5,
"timeSpent": null,
"prevSubmission": []
}Request
GET
api/module/assignment/details
Query Parameters
registrationId string
ID of the course Registration for which this module is attached to.
moduleId string
ID of the assignment module.
Retrieve Assignment Submissions
Retrieves the submissions of the assigment the student have given. Helps in grading a student. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/module/assignment/submissions?statusRowId=7" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/module/assignment/submissions"
);
let params = {
"statusRowId": "7",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"courseId": 1,
"courseName": "course 1",
"assignmentName": "assign",
"status": "Submitted",
"content": "Desc",
"totalPoints": 50,
"submissions": [
{
"id": 1,
"file_path": "https:\/\/aom-uploads-test.s3.us-west-2.amazonaws.com\/assignments\/aom-sample-bulkupload_1597042007.csv",
"student_message": null,
"instructor_message": null,
"points_awarded": null,
"evaluated_by": "",
"submitted_on": "Aug 10, 2020",
"evaluated_on": ""
}
]
}Request
GET
api/module/assignment/submissions
Query Parameters
statusRowId string
ID of the Module status of the current assignment.
Submit Assignment
Submits the assignment after attempting all the aspects of the assignment. Updates the status of assignment to submitted if student is finished the assignment and submits. (See Parameters)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/module/assignment/submit" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"statusRowId":"7","submission":"This is text based assignment submission"}'
const url = new URL(
"https://demo.aomlms.com/api/module/assignment/submit"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"statusRowId": "7",
"submission": "This is text based assignment submission"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Assignment submitted successfully"
}Request
POST
api/module/assignment/submit
Body Parameters
statusRowId required optional
ID of the Module status of the current assignment.
submission required optional
Submission data(file or text).
Upload Assignment File
Helps in upload the assignment file by students. You can use File form to upload a file to the system. (See Parameters) Returns the S3 bucket URL link for the uploaded file.
Example request:
curl -X POST \
"https://demo.aomlms.com/api/module/assignment/upload" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"file":"binary"}'
const url = new URL(
"https://demo.aomlms.com/api/module/assignment/upload"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"file": "binary"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"s3_url": "https:\/\/s3.aws.com\/wTsycTYRCLKIUVXXIYFYVXBXIXUGIXB"
}Request
POST
api/module/assignment/upload
Body Parameters
file required optional
File to be uploaded for current assignment.
Evaluate Assignment
Evaluates the assignment from Instructor side.Updates the status of assignment to completed if Instructor thinks student's submission is upto the marks. (See Parameters)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/module/assignment/evaluate" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"statusRowId":"7","evaluation":"{instructorMessage : 'Assignment looks good', pointsAwarded: '50', isAccepted : true }"}'
const url = new URL(
"https://demo.aomlms.com/api/module/assignment/evaluate"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"statusRowId": "7",
"evaluation": "{instructorMessage : 'Assignment looks good', pointsAwarded: '50', isAccepted : true }"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Assignment evaluated successfully"
}Request
POST
api/module/assignment/evaluate
Body Parameters
statusRowId required optional
ID of the Module status of the current assignment.
evaluation required optional
Evaluation data by the Instructor(Completed or not).
Audit Logs
It allows you to track the user activity in the LMS.
Tabular List
Retrieves all the audit log activities in a tabular list format with pagination mode. You can apply filter using search_param via user_id, activityName or dates
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/audit-activities?page_size=10&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C%22direction%22%3A%22desc%22%7D&search_param=%7B%22performed_by%22%3A%22Aom+Staff%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/audit-activities"
);
let params = {
"page_size": "10",
"page_number": "1",
"order_by": "{"colName":"created_at","direction":"desc"}",
"search_param": "{"performed_by":"Aom Staff"}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"performed_by": "Aom Staff",
"effect_on": "User",
"subject": "User",
"action": "Created",
"created_at": "Aug 06, 2020 07:20 AM",
"details": []
}
],
"performedOnList": []
}Request
GET
api/audit-activities
Query Parameters
page_size string
The number of the user you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on performed_by, user and dates.
Audit Activity Lookup
Retrieves all the activity for the user. Helps showing options in dropdowns elements
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/audit-activities/verb/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/audit-activities/verb/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"db_value": "login",
"display_value": "LOGIN"
},
{
"db_value": "created",
"display_value": "CREATED"
},
{
"db_value": "updated",
"display_value": "UPDATED"
},
{
"db_value": "deleted",
"display_value": "DELETED"
}
]Request
GET
api/audit-activities/verb/lookup
Categories
Categories represents Course category, Product category, Question category. Helps performimg operations in all these models.
Product Category Lookup
Retrieves all the categories of the product user has ever created. This request helps in showing all product categories in form elements like dropdown, etc. Returns ID and name of the product category.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/categories/product/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/categories/product/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"id": 4,
"name": "Question-cat"
}
]Request
GET
api/categories/product/lookup
Course Category Lookup
Retrieves all the categories of the courses user has ever created. This request helps in showing all course categories in form elements like dropdown, etc. Returns ID and name of the course category.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/categories/course/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/categories/course/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"id": 1,
"name": "Category-1"
}
]Request
GET
api/categories/course/lookup
Module category Lookup
Retrieves all the categories of the module user has ever created. This request helps in showing all module categories in form elements like dropdown, etc. Returns ID and name of the module category.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/categories/module/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/categories/module/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"id": 1,
"name": "Category-1"
}
]Request
GET
api/categories/module/lookup
Question Category Lookup
Retrieves all the categories of the question user has ever created. This request helps in showing all question categories in form elements like dropdown, etc. Returns ID and name of the question category.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/categories/question/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/categories/question/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"id": 4,
"name": "Question-cat"
}
]Request
GET
api/categories/question/lookup
Course Category Tabular List
Returns all the course categories in a tabular list format in paginated mode. You can apply filter using search_param via categoryName.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/coursecategory/tabularlist?page_size=9&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22categoryName%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/coursecategory/tabularlist"
);
let params = {
"page_size": "9",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"categoryName":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 4,
"recordsFiltered": 3,
"records": [
{
"id": 3,
"name": "superman_postman",
"author": "Client Admin",
"count": 0,
"created_at": "Aug 10, 2020 12:43 PM"
},
{
"id": 2,
"name": "category-new",
"author": "Aom Staff",
"count": 0,
"created_at": "Aug 10, 2020 12:37 PM"
},
{
"id": 1,
"name": "Category-1",
"author": "Aom Staff",
"count": 1,
"created_at": "Aug 09, 2020 06:20 PM"
}
]
}Request
GET
api/coursecategory/tabularlist
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on category name.
Module Category Tabular List
Returns all the module categories in a tabular list format in paginated mode. You can apply filter using search_param via categoryName.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/modulecategory/tabularlist?page_size=9&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22categoryName%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/modulecategory/tabularlist"
);
let params = {
"page_size": "9",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"categoryName":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 2,
"recordsFiltered": 1,
"records": [
{
"id": 2,
"name": "module memberships",
"author": "Aom Staff",
"count": 1,
"created_at": "May 10, 2022 03:39 AM"
}
]
}Request
GET
api/modulecategory/tabularlist
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on category name.
Product Category Tabular List
Returns all the product categories in a tabular list format in paginated mode. You can apply filter using search_param via categoryName.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/productcategory/tabularlist?page_size=9&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22categoryName%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/productcategory/tabularlist"
);
let params = {
"page_size": "9",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"categoryName":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 4,
"recordsFiltered": 3,
"records": [
{
"id": 3,
"name": "superman_postman",
"author": "Client Admin",
"count": 0,
"created_at": "Aug 10, 2020 12:43 PM"
},
{
"id": 2,
"name": "category-new",
"author": "Aom Staff",
"count": 0,
"created_at": "Aug 10, 2020 12:37 PM"
},
{
"id": 1,
"name": "Category-1",
"author": "Aom Staff",
"count": 1,
"created_at": "Aug 09, 2020 06:20 PM"
}
]
}Request
GET
api/productcategory/tabularlist
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on category name.
Question Category Tabular List
Returns all the question categories in a tabular list format in paginated mode. You can apply filter using search_param via categoryName.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/questioncategory/tabularlist?page_size=9&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22categoryName%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/questioncategory/tabularlist"
);
let params = {
"page_size": "9",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"categoryName":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 4,
"recordsFiltered": 1,
"records": [
{
"id": 4,
"name": "Question-cat",
"author": "Aom Staff",
"count": 0,
"created_at": "Aug 10, 2020 01:58 PM"
}
]
}Request
GET
api/questioncategory/tabularlist
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on category name.
Create Category
To create a category, you need to use this request. Provide category name and it will be created. (See parameters) Helps in grouping multiple courses, question and products.
Example request:
curl -X POST \
"https://demo.aomlms.com/api/category/create" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"category_name":"category-new","categoryType":"course"}'
const url = new URL(
"https://demo.aomlms.com/api/category/create"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"category_name": "category-new",
"categoryType": "course"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Category Created Successfully"
}Request
POST
api/category/create
Body Parameters
category_name string
Name of the course category.
categoryType string
Type for the category that is being created. Type options: course, question, product and module.
Update Category
Updates a category using parameters mentioned. (See parameters) Updates the course/question/product category details using category name and category ID.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/category/3" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"category_name":"category-new-updated"}'
const url = new URL(
"https://demo.aomlms.com/api/category/3"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"category_name": "category-new-updated"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Category Updated Successfully"
}Request
PUT
api/category/{id}
URL Parameters
id string
ID of the category.
Body Parameters
category_name string
Name of the category.
Retrieve Category
Retrieves category details for specified category ID.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/category/3" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/category/3"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 3,
"name": "superman_postman",
"type": "course",
"created_by": 2,
"updated_by": null,
"deleted_by": null,
"created_at": "2020-08-10 12:43:12",
"updated_at": "2020-08-10 12:56:37",
"deleted_at": null
}Request
GET
api/category/{id}
URL Parameters
id string
ID of the category.
Delete Category
To delete a category, you need to use this request. Returns number of category deleted(if multiple selected)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/category/delete" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"delete_ids":[1]}'
const url = new URL(
"https://demo.aomlms.com/api/category/delete"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"delete_ids": [
1
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "1 category(s) deleted "
}Request
POST
api/category/delete
Body Parameters
delete_ids array
All category IDs which needs to be deleted.
Certificate Templates
A Certificate template is used to provide to students. Students can achieve this award by completing the course. Helps in performing CRUD operations for and to certificates
Certificates Lookup
Retrieves all the certificate templates. Helps while showing certificate templates in form elements like dropdown. Returns Id and name of the certificate templates. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/certificate_templates/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/certificate_templates/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"id": 1,
"name": "cert 1"
}
]Request
GET
api/certificate_templates/lookup
Certificate Template Tabular List
Returns all the certificate templates in a tabular list format in paginated mode. You can apply filter using search_param via templateName(certificate template name) and courseId(course Id).
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/certificate_templates/tabularlist?page_size=50&page_number=20&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22templateName%22%3A%22%22%2C%22courseId%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/certificate_templates/tabularlist"
);
let params = {
"page_size": "50",
"page_number": "20",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"templateName":"","courseId":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"id": 1,
"name": "cert 1",
"author": "Aom Staff",
"courses": "course 1, Awesome Course, course 1_copy",
"created_at": "Aug 03, 2020 09:58 AM"
}
]
}Request
GET
api/certificate_templates/tabularlist
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on field names.
Quick Edit
Updates the details in bulk for specified certificate templates. Parameters is provided which needs to be updated. (See Parameters)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/certificate_templates/quickEdit" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"template_ids":[3,1],"author_id":1}'
const url = new URL(
"https://demo.aomlms.com/api/certificate_templates/quickEdit"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"template_ids": [
3,
1
],
"author_id": 1
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Certificate Templates updated Successfully"
}Request
POST
api/certificate_templates/quickEdit
Body Parameters
template_ids array
All certificate template IDs which needs to be updated.
author_id integer optional
Update the instructor/Author for the selected certificate templates.
Certificate Template Fields Lookup
Retrieves all the fields name user can add in the certificate templates. Fields like student name, instructor name, course name, etc. Helps showing options in dropdowns elements while creating certificate template.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/certificate_template/keysLookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/certificate_template/keysLookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"db_value": "student_first_name",
"display_value": "Student First Name"
},
{
"db_value": "student_last_name",
"display_value": "Student Last Name"
},
{
"db_value": "student_full_name",
"display_value": "Student Full Name"
},
{
"db_value": "course_name",
"display_value": "Course Name"
},
{
"db_value": "issue_date",
"display_value": "Date of Issue"
},
{
"db_value": "expiry_date",
"display_value": "Date of Expiry"
},
{
"db_value": "instructor_name",
"display_value": "Instructor Name"
},
{
"db_value": "certificate_code",
"display_value": "Certificate Code"
},
{
"db_value": "course_credit",
"display_value": "Course Credit"
},
{
"db_value": "custom_text",
"display_value": "Custom Text"
}
]Request
GET
api/certificate_template/keysLookup
Certificate Template Fonts Lookup
Retrieves all the fonts user can add in the certificate templates. Fonts like Arial, Times-Roman, Helvetica, etc. Helps showing options in dropdowns elements while creating certificate template.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/certificate_template/fontFamilyLookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/certificate_template/fontFamilyLookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"db_value": "Arial",
"display_value": "Arial",
"is_selected": "true"
},
{
"db_value": "Courier",
"display_value": "Courier"
},
{
"db_value": "Times-Roman",
"display_value": "Times-Roman"
},
{
"db_value": "Helvetica",
"display_value": "Helvetica"
},
{
"db_value": "Times-Bold",
"display_value": "Times-Bold"
},
{
"db_value": "Courier-Bold",
"display_value": "Courier-Bold"
},
{
"db_value": "DejaVuSans-Bold",
"display_value": "DejaVuSans-Bold"
},
{
"db_value": "DejaVuSansMono-Bold",
"display_value": "DejaVuSansMono-Bold"
}
]Request
GET
api/certificate_template/fontFamilyLookup
Create Certificate Template
To create a certificate template, you need to use this request. (See parameters) Created certificate template can be used to assign students when they completed the course.
Returns : id of the certificate template created and successfull message
Example request:
curl -X POST \
"https://demo.aomlms.com/api/certificate_template" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"Completion-Certificate","bg_url":"http:\/\/aom.com\/images\/default-certificate.png","height":680,"width":1075,"fields":[{"key":"course_name","value":"Course Name","font_size":"20","align_center":false,"font_family":"Arial","font_color":"#222","top":432,"left":469,"width":200,"height":40,"show_tools":false},{"key":"student_first_name","value":"Student First Name","font_size":"20","align_center":false,"font_family":"Arial","font_color":"#222","top":332,"left":452,"width":200,"height":40,"show_tools":false}]}'
const url = new URL(
"https://demo.aomlms.com/api/certificate_template"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "Completion-Certificate",
"bg_url": "http:\/\/aom.com\/images\/default-certificate.png",
"height": 680,
"width": 1075,
"fields": [
{
"key": "course_name",
"value": "Course Name",
"font_size": "20",
"align_center": false,
"font_family": "Arial",
"font_color": "#222",
"top": 432,
"left": 469,
"width": 200,
"height": 40,
"show_tools": false
},
{
"key": "student_first_name",
"value": "Student First Name",
"font_size": "20",
"align_center": false,
"font_family": "Arial",
"font_color": "#222",
"top": 332,
"left": 452,
"width": 200,
"height": 40,
"show_tools": false
}
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 2,
"message": "Certificate Template created successfully"
}Request
POST
api/certificate_template
Body Parameters
name string
Name of the certificate template.
bg_url string optional
Background for the certificate template.
height integer
Height size for the certificate template.
width integer
Width size for the certificate template.
fields array optional
All the certificate fields user have added to appear in certificate template(student name, instructor name, course name, etc).
Retrieve Certificate Template
Retrieves the details of the specified certificate template. Helps in fetching certificate template using its ID. (See Parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/certificate_template/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/certificate_template/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "cert 1",
"bg_url": "https:\/\/v3.academyofmine.net\/wp-content\/uploads\/2020\/07\/default-certificate.png",
"height": 827,
"width": 1070,
"fields": [
{
"key": "student_full_name",
"value": "Student Full Name",
"font_size": 20,
"font_family": "Arial",
"font_color": "#222",
"top": 401,
"left": 443,
"align_center": false,
"width": 200,
"height": 60
}
]
}Request
GET
api/certificate_template/{id}
URL Parameters
id string
ID of the certificate template you want to fetch the details of.
Preview Certificate Template
It let users preview certificate by downloading it with demo data. Changes the completion percentage to 100% and mark completed the text module.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/certificate_template/preview/2" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/certificate_template/preview/2"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
pdf file as download optionRequest
GET
api/certificate_template/preview/{id}
URL Parameters
id string
ID of the Certificate template.
Update Certificate Template
Updates the details of a specified certificate template. (See parameters) Certificate template can be used to assign students when they completed the course.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/certificate_template/2" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"Updated-Completion-Certificate","bg_url":"http:\/\/aom.com\/images\/default-certificate.png","height":780,"width":1075,"fields":[{"key":"course_name","value":"Course Name","font_size":"20","align_center":false,"font_family":"Arial","font_color":"#222","top":432,"left":469,"width":200,"height":40,"show_tools":false},{"key":"student_first_name","value":"Student First Name","font_size":"20","align_center":false,"font_family":"Arial","font_color":"#222","top":332,"left":452,"width":200,"height":40,"show_tools":false}]}'
const url = new URL(
"https://demo.aomlms.com/api/certificate_template/2"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "Updated-Completion-Certificate",
"bg_url": "http:\/\/aom.com\/images\/default-certificate.png",
"height": 780,
"width": 1075,
"fields": [
{
"key": "course_name",
"value": "Course Name",
"font_size": "20",
"align_center": false,
"font_family": "Arial",
"font_color": "#222",
"top": 432,
"left": 469,
"width": 200,
"height": 40,
"show_tools": false
},
{
"key": "student_first_name",
"value": "Student First Name",
"font_size": "20",
"align_center": false,
"font_family": "Arial",
"font_color": "#222",
"top": 332,
"left": 452,
"width": 200,
"height": 40,
"show_tools": false
}
]
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 2,
"message": "Certificate Template created successfully"
}Request
PUT
api/certificate_template/{id}
URL Parameters
id string
ID of the certificate template
Body Parameters
name string
Name of the certificate template.
bg_url string optional
Background for the certificate template.
height integer
Height size for the certificate template.
width integer
Width size for the certificate template.
fields array optional
All the certificate fields user have added to appear in certificate template(student name, instructor name, course name, etc).
Delete Certificate Template
To delete a certificate template, you need to use this request. Returns number of certificate template deleted(if multiple selected) and also not deleted. (See Response)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/certificate_template/delete" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"delete_ids":[1,12,15]}'
const url = new URL(
"https://demo.aomlms.com/api/certificate_template/delete"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"delete_ids": [
1,
12,
15
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "2 template(s) deleted 1 template(s) not deleted as it is used in course. Please remove the template(s) from the course and try again."
}Request
POST
api/certificate_template/delete
Body Parameters
delete_ids array
All certificate template IDs which needs to be deleted.
Courses
You can perform operations like create, edit, delete on courses and its contents.
Tabular List
Returns all the courses in a tabular list format in paginated mode. You can apply filter using search_param via courseName(for specific course) and status(course status)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/courses/tabularlist?page_size=9&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22courseCategoryIds%22%3A%5B%5D%2C%22courseName%22%3A%22course+1%22%2C%22status%22%3A%22In+Progress%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/courses/tabularlist"
);
let params = {
"page_size": "9",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"courseCategoryIds":[],"courseName":"course 1","status":"In Progress"}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"id": 1,
"name": "course 1",
"slug": "course-1",
"status": "publish",
"categories": "",
"author": "Aom Staff",
"created_at": "03 Aug 2020 09:08 AM"
}
]
}Request
GET
api/courses/tabularlist
Query Parameters
page_size string
The number of the item you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on Course category ids, course name and role names.
Dropdown List
Returns course seat details while adding this to a group.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/courses/dropdownlist?group_id=1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/courses/dropdownlist"
);
let params = {
"group_id": "1",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"id": 1,
"name": "course 1",
"used_seats": null,
"total_seats": null
}
]Request
GET
api/courses/dropdownlist
Query Parameters
group_id string
ID of the group.
Enrolled Students
Retrieves all the student details enrolled in a course. You can use search_param filter using nameOrEmail(student name or email) and status(course status)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/course/enrolled-students?course_id=1&group_id=1&page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22registered_on%22%2C%22direction%22%3A%22desc%22%7D&search_param=%7B%22nameOrEmail%22%3A%22%22%2C%22status%22%3A%5B%22In+Progress%22%5D%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/course/enrolled-students"
);
let params = {
"course_id": "1",
"group_id": "1",
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"registered_on","direction":"desc"}",
"search_param": "{"nameOrEmail":"","status":["In Progress"]}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"courseName": "course 1",
"featuredImage": null,
"recordsTotal": 2,
"totalNotStarted": 1,
"totalInProgress": 0,
"totalCompleted": 1,
"recordsFiltered": 2,
"records": [
{
"id": 6,
"user_id": 4,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"avatar": "<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"40\" height=\"40\" viewBox=\"0 0 40 40\"><circle cx=\"20\" cy=\"20\" r=\"20\" stroke=\"background\" stroke-width=\"0\" fill=\"#03A9F4\" \/><text x=\"20\" y=\"20\" font-size=\"14\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">JD<\/text><\/svg>",
"status": "Not Started",
"percentComplete": 0,
"access_status": "Allowed",
"registered_on": "09-Aug-2020",
"started_on": "",
"completed_on": "",
"expire_on": "Never",
"last_accessed_on": "Never"
},
{
"id": 1,
"user_id": 3,
"first_name": "Demo",
"last_name": "Student",
"email": "[email protected]",
"avatar": "<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"40\" height=\"40\" viewBox=\"0 0 40 40\"><circle cx=\"20\" cy=\"20\" r=\"20\" stroke=\"background\" stroke-width=\"0\" fill=\"#4CAF50\" \/><text x=\"20\" y=\"20\" font-size=\"14\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">DS<\/text><\/svg>",
"status": "Completed",
"percentComplete": 100,
"access_status": "Allowed",
"registered_on": "03-Aug-2020",
"started_on": "03-Aug-2020",
"completed_on": "03-Aug-2020",
"expire_on": "Never",
"last_accessed_on": "6 days ago"
}
]
}Request
GET
api/course/enrolled-students
Query Parameters
course_id string
ID of the course.
group_id string
ID of the group.
page_size string
Number of the results you want in each page.
page_number string
Current Page number.
order_by string optional
Returns details in some order.
search_param string optional
Search parameters related to course.
api/courses/locations/lookup
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/courses/locations/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/courses/locations/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/courses/locations/lookup
Course Submissions
Retrieves all the submissions for a course in pagination mode. You can apply filter on data returned using search_param via nameOrEmail(student name or email) and type(submission type - assignment or discussion)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/course/submissions?course_id=1&page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22updated_at%22%2C%22direction%22%3A%22desc%22%7D&search_param=%7B%22nameOrEmail%22%3A%22%22%2C%22type%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/course/submissions"
);
let params = {
"course_id": "1",
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"updated_at","direction":"desc"}",
"search_param": "{"nameOrEmail":"","type":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"courseName": "course 1",
"featuredImage": null,
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"status_row_id": 2,
"module_id": 4,
"module_name": "assign",
"module_type": "assignment",
"first_name": "Aom",
"last_name": "Staff",
"email": "[email protected]",
"avatar": "<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"40\" height=\"40\" viewBox=\"0 0 40 40\"><circle cx=\"20\" cy=\"20\" r=\"20\" stroke=\"background\" stroke-width=\"0\" fill=\"#00BCD4\" \/><text x=\"20\" y=\"20\" font-size=\"14\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">AS<\/text><\/svg>",
"submission_id": 1,
"submitted_on": "10-Aug-2020"
}
]
}Request
GET
api/course/submissions
Query Parameters
course_id string
ID of the course.
page_size string
The number of the submissions you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on Course category ids, course name and role names.
All Courses Submissions
Retrieves all the submissions for all the courses in pagination mode. You can apply filter on data returned using search_param via nameOrEmail(student name or email) and type(submission type - assignment or discussion)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/course/all-submissions?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22updated_at%22%2C%22direction%22%3A%22desc%22%7D&search_param=%7B%22nameOrEmail%22%3A%22%22%2C%22type%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/course/all-submissions"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"updated_at","direction":"desc"}",
"search_param": "{"nameOrEmail":"","type":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"course_name": "Professional Development and Training",
"status_row_id": 2,
"module_id": 4,
"module_name": "assign",
"module_type": "assignment",
"first_name": "Aom",
"last_name": "Staff",
"email": "[email protected]",
"avatar": "<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"40\" height=\"40\" viewBox=\"0 0 40 40\"><circle cx=\"20\" cy=\"20\" r=\"20\" stroke=\"background\" stroke-width=\"0\" fill=\"#00BCD4\" \/><text x=\"20\" y=\"20\" font-size=\"14\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">AS<\/text><\/svg>",
"submission_id": 1,
"submitted_on": "10-Aug-2020"
}
]
}Request
GET
api/course/all-submissions
Query Parameters
page_size string
The number of the submissions you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on course name, user names and submission type.
LMS Overview Report
Retrieves the overview report for all courses. Returned data contains information like total number of modules and number of courses in different status(In Progress, Not Started and Completed). Example - [1,0]. You can use these data for graphs representation as well. You can use the group_id filter to get details specific to a group.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/course/reports/overview?group_id=3" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/course/reports/overview"
);
let params = {
"group_id": "3",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"labels": [
"course 1",
"Awesome Course"
],
"totalNotStarted": [
1,
0
],
"totalInProgress": [
1,
0
],
"totalCompleted": [
1,
0
],
"sumNotStarted": 1,
"sumInProgress": 1,
"sumCompleted": 1
}Request
GET
api/course/reports/overview
Query Parameters
group_id string optional
ID of the group.
Course Report
Retrieves the detailed report for all courses. Returned data contains information like total number of modules and number of courses in different status(In Progress, Not Started and Completed). Example - [1,0]. You can use these data for graphs representation as well. You can use the group_id, search_param filters to get specific details.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/course/reports/course-detailed?course_id=3&group_id=deserunt&page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22registered_on%22%2C%22direction%22%3A%22desc%22%7D&search_param=%7B%22nameOrEmail%22%3A%22%22%2C%22status%22%3A%5B%5D%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/course/reports/course-detailed"
);
let params = {
"course_id": "3",
"group_id": "deserunt",
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"registered_on","direction":"desc"}",
"search_param": "{"nameOrEmail":"","status":[]}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"courseName": "course 1",
"featuredImage": null,
"recordsTotal": 3,
"totalNotStarted": 1,
"totalInProgress": 1,
"totalCompleted": 1,
"recordsFiltered": 3,
"records": [
{
"first_name": "Aom",
"last_name": "Staff",
"email": "[email protected]",
"status": "In Progress",
"percent_complete": 45,
"access_status": "Allowed",
"registered_on": "10-Aug-2020",
"started_on": "10-Aug-2020",
"completed_on": "",
"expire_on": "Never",
"last_accessed_on": "1 hour ago",
"percent_achieved": null,
"total_time_spent": "0h 20m",
"certifcate_issued": "No"
},
{
"first_name": "Client",
"last_name": "Admin",
"email": "[email protected]",
"status": "Not Started",
"percent_complete": 0,
"access_status": "Allowed",
"registered_on": "09-Aug-2020",
"started_on": "",
"completed_on": "",
"expire_on": "12-Aug-2023",
"last_accessed_on": "Never",
"percent_achieved": null,
"total_time_spent": "0h 0m",
"certifcate_issued": "Yes"
},
{
"first_name": "Demo",
"last_name": "Student",
"email": "[email protected]",
"status": "Completed",
"percent_complete": 50,
"access_status": "Allowed",
"registered_on": "03-Aug-2020",
"started_on": "03-Aug-2020",
"completed_on": "03-Aug-2020",
"expire_on": "Never",
"last_accessed_on": "6 days ago",
"percent_achieved": 0,
"total_time_spent": "0h 0m",
"certifcate_issued": "Yes"
}
]
}Request
GET
api/course/reports/course-detailed
Query Parameters
course_id string
ID of the course.
group_id string optional
ID of the group. Example:
page_size string
The number of the submissions you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on students name or emaila and status of the course.
Get Course
Retrieves the course details based on the course ID specified.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/course/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/course/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "course 1",
"slug": "course-1",
"featuredImageUrl": null,
"instructions": null,
"credits": null,
"minPassingPercentage": null,
"gradingRule": "no_grading",
"durationRule": "unlimited",
"durationSpecificDate": null,
"durationDays": null,
"status": "publish",
"certificateTemplates": [
1
],
"associatedProduct": [],
"hasAssociatedProduct": false,
"modules": [
{
"module_id": 1,
"name": "test",
"type": "text",
"icon": "<i class=\"el-icon-tickets\"><\/i>",
"is_locked": false,
"drip_rules": "immediately",
"drip_fixed_date": null,
"drip_interval": null,
"drip_interval_unit": "day",
"drip_calculation_reference": "registration_date",
"minSpentHour": 0,
"minSpentMinutes": 0
}
],
"categories": [],
"gradeModules": []
}Request
GET
api/course/{id}
URL Parameters
id string
The ID of the course.
Create Course
To create a course, you need to use this request with provided parameters.
Example request:
curl -X POST \
"https://demo.aomlms.com/api/course" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"Course 1","instructions":"Some Instruction","slug":"course-1","featuredImageUrl":"img_path","completionRedirectionUrl":"redirection_path","credits":70,"minPassingPercentage":75,"gradingRule":"no_grading","durationRule":"unlimited","status":"publish","certificateTemplates":[1],"modules":[{"module_id":1,"name":"test","type":"text","icon":"<i class=\"el-icon-tickets\"><\/i>","is_locked":false,"drip_rules":"immediately","drip_fixed_date":null,"drip_interval":null,"drip_interval_unit":"day","drip_calculation_reference":"registration_date","minSpentHour":0,"minSpentMinutes":0}],"certificateExpiresAfter":3,"certificateExpiresAfterGracePeriod":30,"categories":[1,2],"gradeModules":[]}'
const url = new URL(
"https://demo.aomlms.com/api/course"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "Course 1",
"instructions": "Some Instruction",
"slug": "course-1",
"featuredImageUrl": "img_path",
"completionRedirectionUrl": "redirection_path",
"credits": 70,
"minPassingPercentage": 75,
"gradingRule": "no_grading",
"durationRule": "unlimited",
"status": "publish",
"certificateTemplates": [
1
],
"modules": [
{
"module_id": 1,
"name": "test",
"type": "text",
"icon": "<i class=\"el-icon-tickets\"><\/i>",
"is_locked": false,
"drip_rules": "immediately",
"drip_fixed_date": null,
"drip_interval": null,
"drip_interval_unit": "day",
"drip_calculation_reference": "registration_date",
"minSpentHour": 0,
"minSpentMinutes": 0
}
],
"certificateExpiresAfter": 3,
"certificateExpiresAfterGracePeriod": 30,
"categories": [
1,
2
],
"gradeModules": []
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 1,
"message": "Course saved successfully"
}Request
POST
api/course
URL Parameters
id string
ID of the course.
Body Parameters
name string
Name of the course.
instructions string optional
Instruction for the course.
slug string
Slug for the course.
featuredImageUrl string optional
Image for the course.
completionRedirectionUrl string optional
After course completion redirection url(If blank, it will redirect to dashboard).
credits integer optional
Credit after course completion, used in certificates.
minPassingPercentage number optional
Minimum passing percenatage for students.
gradingRule string
Grading criteria for the course. Grading rule options: no_grading, avg_all_modules or avg_specific_modules.
durationRule string
Access duration for the course. Duration rule options: unlimited, on_specific_date, x_days_after_start or x_days_after_enrollment.
status string
Course is in Draft or Publish mode. Status options: draft or publish.
certificateTemplates array optional
Certificates attached to this course.
modules array optional
All modules related to this course.
certificateExpiresAfter integer optional
The number of months a certificate is valid for before it expires. Leave blank or zero for a permanent certificate.
certificateExpiresAfterGracePeriod integer optional
The number of days before certificate expiration that a student can recertify..
categories array optional
Categories for this course.
gradeModules array optional
Modules that will be used for grading users.
Update Course
Updates course details using provided parameters.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/course/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"Course 1","slug":"course-1","featuredImageUrl":"img_path","completionRedirectionUrl":"redirection_path","credits":70,"minPassingPercentage":75,"gradingRule":"no_grading","durationRule":"unlimited","status":"publish","certificateTemplates":[1],"modules":[{"module_id":1,"name":"test","type":"text","icon":"<i class=\"el-icon-tickets\"><\/i>","is_locked":false,"drip_rules":"immediately","drip_fixed_date":null,"drip_interval":null,"drip_interval_unit":"day","drip_calculation_reference":"registration_date","minSpentHour":0,"minSpentMinutes":0}],"certificateExpiresAfter":3,"certificateExpiresAfterGracePeriod":30,"categories":[1,2],"gradeModules":[]}'
const url = new URL(
"https://demo.aomlms.com/api/course/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "Course 1",
"slug": "course-1",
"featuredImageUrl": "img_path",
"completionRedirectionUrl": "redirection_path",
"credits": 70,
"minPassingPercentage": 75,
"gradingRule": "no_grading",
"durationRule": "unlimited",
"status": "publish",
"certificateTemplates": [
1
],
"modules": [
{
"module_id": 1,
"name": "test",
"type": "text",
"icon": "<i class=\"el-icon-tickets\"><\/i>",
"is_locked": false,
"drip_rules": "immediately",
"drip_fixed_date": null,
"drip_interval": null,
"drip_interval_unit": "day",
"drip_calculation_reference": "registration_date",
"minSpentHour": 0,
"minSpentMinutes": 0
}
],
"certificateExpiresAfter": 3,
"certificateExpiresAfterGracePeriod": 30,
"categories": [
1,
2
],
"gradeModules": []
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 1,
"message": "Course updated successfully"
}Request
PUT
api/course/{id}
URL Parameters
id string
ID of the course.
Body Parameters
name string
Name of the course.
slug string
Slug for the course.
featuredImageUrl string optional
Image for the course.
completionRedirectionUrl string optional
After course completion redirection url(If blank, it will redirect to dashboard).
credits integer optional
Credit after course completion, used in certificates.
minPassingPercentage number optional
Minimum passing percenatage for students.
gradingRule string
Grading criteria for the course. Grading rule options: no_grading, avg_all_modules or avg_specific_modules.
durationRule string
Access duration for the course. Duration rule options: unlimited, on_specific_date, x_days_after_start or x_days_after_enrollment.
status string
Course is in Draft or Publish mode. Status options: draft or publish.
certificateTemplates array optional
Certificates attached to this course.
modules array optional
All modules related to this course.
certificateExpiresAfter integer optional
The number of months a certificate is valid for before it expires. Leave blank or zero for a permanent certificate.
certificateExpiresAfterGracePeriod integer optional
The number of days before certificate expiration that a student can recertify..
categories array optional
Categories for this course.
gradeModules array optional
Modules that will be used for grading users.
Update Slug
Updates the slug of the course. Example - old-awesome-course to new-awesome-course
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/course/update-slug/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"slug":"Awesome-course"}'
const url = new URL(
"https://demo.aomlms.com/api/course/update-slug/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"slug": "Awesome-course"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
"Awesome-course"Request
PUT
api/course/update-slug/{id}
URL Parameters
id string
The ID of the course.
Body Parameters
slug required optional
New slug for the course.
Course Lookup
Retrieves all the course details. Helps while showing course names in dropdown elements. You can apply filters using search_term parameter.
Example request:
curl -X POST \
"https://demo.aomlms.com/api/course/lookup?group_id=1&search_term=esse" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/course/lookup"
);
let params = {
"group_id": "1",
"search_term": "esse",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"value": 1,
"label": "course 1"
}
]Request
POST
api/course/lookup
URL Parameters
id string
ID of the course.
Query Parameters
group_id string optional
ID of the group.
search_term string optional
returns filtered data.
Delete Course
To delete a course, you need to use this request. Returns number of course deleted(if multiple selected) and number of not-deleted due to existing enrollment of students
Example request:
curl -X POST \
"https://demo.aomlms.com/api/course/delete" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"delete_ids":[1]}'
const url = new URL(
"https://demo.aomlms.com/api/course/delete"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"delete_ids": [
1
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "2 course(s) deleted 1 course(s) not deleted as it has enrollments. Please remove the students from the course and try again."
}Request
POST
api/course/delete
Body Parameters
delete_ids array
All course IDs which needs to be deleted.
Quick Edit
Updates the details in bulk for a specified course. Parameters is provided which needs to be updated.
Example request:
curl -X POST \
"https://demo.aomlms.com/api/course/quickEdit" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"course_ids":[1,2],"author_id":1,"categories_id":[1,2]}'
const url = new URL(
"https://demo.aomlms.com/api/course/quickEdit"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"course_ids": [
1,
2
],
"author_id": 1,
"categories_id": [
1,
2
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Courses updated Successfully"
}Request
POST
api/course/quickEdit
Body Parameters
course_ids array
All course IDs which needs to be updated.
author_id integer optional
Set the instructor/Author for the course.
categories_id array optional
Category IDs in which course will be added.
Drip Option Lookup
Retrieves all the drip options for the courses. Helps showing options in dropdowns elements
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/courses/drip/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/courses/drip/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"options": [
{
"db_value": "immediately",
"display_value": "Immediately"
},
{
"db_value": "fixed_date",
"display_value": "On a Fixed Date"
},
{
"db_value": "specific_interval",
"display_value": "At Fixed Intervals"
}
],
"intervals": [
{
"db_value": "day",
"display_value": "Day(s)"
},
{
"db_value": "week",
"display_value": "Week(s)"
},
{
"db_value": "month",
"display_value": "Month(s)"
}
],
"calculation_ref": [
{
"db_value": "registration_date",
"display_value": "Enrollment Date"
},
{
"db_value": "started_date",
"display_value": "Course Start Date"
}
]
}
]Request
GET
api/courses/drip/lookup
Course Status Lookup
Retrieves all the status options for the courses. Helps showing options in dropdowns elements
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/courses/status/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/courses/status/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"db_value": "Not Started",
"display_value": "Not Started"
},
{
"db_value": "In Progress",
"display_value": "In Progress"
},
{
"db_value": "Completed",
"display_value": "Completed"
}
]Request
GET
api/courses/status/lookup
Grading Rules Lookup
Retrieves all the grading rules for the courses. Helps showing options in dropdowns elements
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/courses/grading-rules/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/courses/grading-rules/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"db_value": "no_grading",
"display_value": "No Grading"
},
{
"db_value": "avg_all_modules",
"display_value": "Average of all Quiz\/Assignment\/Discussions\/Scorm"
},
{
"db_value": "avg_specific_modules",
"display_value": "Average of specific Quiz\/Assignment\/Discussions\/Scorm"
}
]Request
GET
api/courses/grading-rules/lookup
Duration Rules Lookup
Retrieves all the duration rules for the courses. Helps showing options in dropdowns elements
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/courses/duration-rules/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/courses/duration-rules/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"db_value": "unlimited",
"display_value": "Unlimited"
},
{
"db_value": "on_specific_date",
"display_value": "Till Specific Date"
},
{
"db_value": "x_days_after_start",
"display_value": "Till X day(s) after a student start the course"
},
{
"db_value": "x_days_after_enrollment",
"display_value": "Till X day(s) after a student is registered to the course"
}
]Request
GET
api/courses/duration-rules/lookup
Course Activities
Retrieves all the activities performed by the students on the course. Details will be returned in paginated mode. You can apply filters also using search_params parameter.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/course-activities?course_id=1&page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C%22direction%22%3A%22desc%22%7D&search_param=%7B%22user_id%22%3A3%2C%22activityName%22%3A%22%22%2C%22dates%22%3A%5B%5D%7D&context=admin" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/course-activities"
);
let params = {
"course_id": "1",
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at","direction":"desc"}",
"search_param": "{"user_id":3,"activityName":"","dates":[]}",
"context": "admin",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"courseName": "course 1",
"featuredImage": null,
"recordsTotal": 40,
"recordsFiltered": 10,
"records": [
{
"id": 10,
"verb": "ACCESSED",
"created_at": "Aug 03, 2020 10:07 AM",
"message": "Demo Student has accessed course 1",
"student": "Demo Student"
},
{
"id": 9,
"verb": "ACHIEVED CERTIFICATE",
"created_at": "Aug 03, 2020 10:02 AM",
"message": "Demo Student has achieved certificate for course 1",
"student": "Demo Student"
},
{
"id": 8,
"verb": "COMPLETED",
"created_at": "Aug 03, 2020 10:02 AM",
"message": "course 1 was completed",
"student": "Demo Student"
},
{
"id": 7,
"verb": "COMPLETED",
"created_at": "Aug 03, 2020 10:02 AM",
"message": "course 1 was completed",
"student": "Demo Student"
},
{
"id": 6,
"verb": "ACHIEVED CERTIFICATE",
"created_at": "Aug 03, 2020 10:02 AM",
"message": "Demo Student has achieved certificate for course 1",
"student": "Demo Student"
},
{
"id": 5,
"verb": "COMPLETED",
"created_at": "Aug 03, 2020 10:02 AM",
"message": "course 1 was completed",
"student": "Demo Student"
},
{
"id": 4,
"verb": "COMPLETED",
"created_at": "Aug 03, 2020 10:02 AM",
"message": "course 1 was completed",
"student": "Demo Student"
},
{
"id": 3,
"verb": "STARTED",
"created_at": "Aug 03, 2020 10:02 AM",
"message": "Demo Student has started test",
"student": "Demo Student"
},
{
"id": 2,
"verb": "STARTED",
"created_at": "Aug 03, 2020 10:01 AM",
"message": "Demo Student has started course 1",
"student": "Demo Student"
},
{
"id": 1,
"verb": "ENROLLED",
"created_at": "Aug 03, 2020 10:00 AM",
"message": "Demo Student is enrolled to course 1",
"student": "Demo Student"
}
]
}Request
GET
api/course-activities
Query Parameters
course_id string
ID of the course.
page_size string
The number of the submissions you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
for searching items based on Course category ids, course name and role names.
context string
Context for the request.
api/course-progress/edit/{id}
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/course-progress/edit/{id}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/course-progress/edit/{id}"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/course-progress/edit/{id}
api/course-progress/update/{id}
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/course-progress/update/{id}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/course-progress/update/{id}"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Request
PUT
api/course-progress/update/{id}
Course Name
Retrieves the course name.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/course/name/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/course/name/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"course_name": "course 1"
}Request
GET
api/course/name/{id}
URL Parameters
id string
ID of the course.
Enroll Students
To enroll students in a course, you need to use this request.
Example request:
curl -X POST \
"https://demo.aomlms.com/api/course/enroll/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"studentIds":[1,2],"groupId":4}'
const url = new URL(
"https://demo.aomlms.com/api/course/enroll/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"studentIds": [
1,
2
],
"groupId": 4
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "2 student(s) enrolled successfully"
}Request
POST
api/course/enroll/{id}
URL Parameters
id string
ID of the course.
Body Parameters
studentIds array
All Students IDs needs to be enrolled in this course.
groupId integer optional
Students needs to be added in this course group.
Remove Students
To removes users from a course, you need to use this request.
Example request:
curl -X POST \
"https://demo.aomlms.com/api/course/remove/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"enrollmentIds":[8,7],"groupId":4}'
const url = new URL(
"https://demo.aomlms.com/api/course/remove/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"enrollmentIds": [
8,
7
],
"groupId": 4
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "2 student(s) removed successfully"
}Request
POST
api/course/remove/{id}
URL Parameters
id string
ID of the course.
Body Parameters
enrollmentIds array
Course Registration/Enrollment IDs needs to be removed from this course.
groupId integer optional
Students needs to be removed from this course group.
Reset Progress
To reset the progress of students for course, you need to use this request
Example request:
curl -X POST \
"https://demo.aomlms.com/api/course/reset/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"enrollmentIds":[9,6]}'
const url = new URL(
"https://demo.aomlms.com/api/course/reset/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"enrollmentIds": [
9,
6
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "2 student(s) progress is reset successfully"
}Request
POST
api/course/reset/{id}
URL Parameters
id string
ID of the course.
Body Parameters
enrollmentIds array
Course Registration/Enrollment IDs needs progress to be reset.
Revoke Access
To revokes the access of course from students, you need to use this request.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/course/revoke/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"enrollmentIds":[9,6]}'
const url = new URL(
"https://demo.aomlms.com/api/course/revoke/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"enrollmentIds": [
9,
6
]
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "2 student(s) access has been revoked successfully"
}Request
PUT
api/course/revoke/{id}
URL Parameters
id string
ID of the course.
Body Parameters
enrollmentIds array
Course Registration/Enrollment IDs needs access to be revoked from this course.
Grant Access
To grants the access of course to students, you need to use this request.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/course/grant/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"enrollmentIds":[9,6]}'
const url = new URL(
"https://demo.aomlms.com/api/course/grant/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"enrollmentIds": [
9,
6
]
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "2 student(s) access has been granted successfully"
}Request
PUT
api/course/grant/{id}
URL Parameters
id string
ID of the course.
Body Parameters
enrollmentIds array
Course Registration/Enrollment IDs needs access to be granted to this course.
Set Expiry
To update the expiry date for the students of a course, you need to use this request.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/course/setExpiry/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"enrollmentIds":[9,6],"expiryDate":"[9, 6]"}'
const url = new URL(
"https://demo.aomlms.com/api/course/setExpiry/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"enrollmentIds": [
9,
6
],
"expiryDate": "[9, 6]"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Expiration date is sucessfully updated for 2 student(s) "
}Request
PUT
api/course/setExpiry/{id}
URL Parameters
id string
ID of the course.
Body Parameters
enrollmentIds array
Course Registration/Enrollment IDs needs setting expiry date for course.
expiryDate date optional
Date on which the course is going to be expired.
Assign Certificate
To assign certificate to the user for the course, you need to use this request.
Example request:
curl -X POST \
"https://demo.aomlms.com/api/course/assignCertificate/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"enrollmentIds":[9,6]}'
const url = new URL(
"https://demo.aomlms.com/api/course/assignCertificate/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"enrollmentIds": [
9,
6
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"isSucess": true,
"message": "Certificate assigned sucessfully to 2 student(s)"
}Request
POST
api/course/assignCertificate/{id}
URL Parameters
id string
ID of the course.
Body Parameters
enrollmentIds array
Course Registration/Enrollment IDs needs assigning certificates.
Activities Lookup
Retrieves all the activities/events name performed by students in a course. Helps showing options in dropdowns elements
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/activities/verb/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/activities/verb/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"db_value": "ENROLLED",
"display_value": "ENROLLED"
},
{
"db_value": "STARTED",
"display_value": "STARTED"
},
{
"db_value": "ACCESSED",
"display_value": "ACCESSED"
},
{
"db_value": "COMPLETED",
"display_value": "COMPLETED"
},
{
"db_value": "SUBMITTED",
"display_value": "SUBMITTED"
},
{
"db_value": "EVALUATED",
"display_value": "EVALUATED"
},
{
"db_value": "REJECTED",
"display_value": "REJECTED"
},
{
"db_value": "RETAKE",
"display_value": "RETAKE"
},
{
"db_value": "ACHIEVED CERTIFICATE",
"display_value": "ACHIEVED CERTIFICATE"
},
{
"db_value": "RESET",
"display_value": "RESET"
},
{
"db_value": "REMOVED",
"display_value": "REMOVED"
},
{
"db_value": "REVOKED",
"display_value": "REVOKED"
},
{
"db_value": "GRANTED",
"display_value": "GRANTED"
},
{
"db_value": "UPDATED EXPIRY DATE",
"display_value": "UPDATED EXPIRY DATE"
}
]Request
GET
api/activities/verb/lookup
Gradebook Data
Retrieves all the progress achieved by a student on the course. Details will be returned in paginated mode. You can use the userId parameter to get details for different students.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/progress/course/1?userId=3" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/progress/course/1"
);
let params = {
"userId": "3",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "course 1",
"modules": [
{
"module_id": 1,
"name": "test",
"slug": "test",
"type": "text",
"icon": "<i class=\"el-icon-tickets\"><\/i>",
"status_row_id": 1,
"status": "Completed",
"started_on": "2020-08-03T10:02:33.000000Z",
"completed_on": "2020-08-03T10:02:41.000000Z",
"last_accessed_on": "6 days ago",
"total_time_spent": {
"hours": 0,
"minutes": 0,
"seconds": 6,
"totalSeconds": 6
},
"completion_percentage": 100,
"no_of_times_accessed": 1,
"totalMarks": null,
"obtainedMarks": null
},
{
"module_id": 4,
"name": "assign",
"slug": "assign",
"type": "assignment",
"icon": "<i class=\"el-icon-edit-outline\"><\/i>",
"status_row_id": -1,
"status": "Not Started",
"started_on": "",
"completed_on": "",
"last_accessed_on": "Never",
"total_time_spent": "",
"points_awarded": "",
"completion_percentage": 0,
"no_of_times_accessed": 0,
"totalMarks": 50,
"obtainedMarks": null
}
],
"id": 1,
"userId": 3,
"permalink": "http:\/\/localhost:8000\/course\/course-1",
"featuredImageUrl": null,
"instructions": null,
"accessStatus": "Allowed",
"status": "Completed",
"completionPercentage": 50,
"timeSpent": {
"hours": 0,
"minutes": 0,
"seconds": 6,
"totalSeconds": 6
},
"enrollmentDate": "03 Aug 2020",
"isExpired": false,
"daysToExpire": "Unlimited days",
"lastAccessed": "6 days ago",
"isCertificateAvailable": true,
"totalMarks": 50,
"obtainedMarks": 0,
"percentage": 0
}Request
GET
api/progress/course/{id}
URL Parameters
id string
Course registration ID for the student of the course you want to see progress.
Query Parameters
userId string
ID of the user.
Enrolled Users Lookup
Retrieves all the user details enrolled in a course. You can apply filter using group_id and search_term.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/enrolled/course/1?group_id=1&search_term=accusamus" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/enrolled/course/1"
);
let params = {
"group_id": "1",
"search_term": "accusamus",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"id": 3,
"full_name": "Demo Student",
"email": "[email protected]"
},
{
"id": 4,
"full_name": "John Doe",
"email": "[email protected]"
}
]Request
GET
api/enrolled/course/{id}
URL Parameters
id string
ID of the course.
Query Parameters
group_id string optional
ID of the group.
search_term string optional
returns filtered data.
Clone
To clone a course, you create a cloned object for a specific course. The newly generated cloned course will help to let you change the content of the course with or without letting affect the real course.
Example request:
curl -X POST \
"https://demo.aomlms.com/api/course/clone" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"course_id":1,"course_name":"course 1","isDeepCopy":false}'
const url = new URL(
"https://demo.aomlms.com/api/course/clone"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"course_id": 1,
"course_name": "course 1",
"isDeepCopy": false
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Course Cloned Successfully"
}Request
POST
api/course/clone
Body Parameters
course_id integer
ID of the course to be cloned.
course_name string
Name of the course about to be cloned.
isDeepCopy boolean
If true, content will be affected in real course if changes made in cloned course.
api/courses/type/lookup
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/courses/type/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/courses/type/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/courses/type/lookup
Launch
To launch the course, you need to use this request. It will set all the progress and status of the course modules.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/courses/launch?registrationId=12" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/courses/launch"
);
let params = {
"registrationId": "12",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "course 1",
"modules": [
{
"module_id": 1,
"name": "test",
"slug": "test",
"type": "text",
"icon": "<i class=\"el-icon-tickets\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": true,
"status_row_id": -1,
"status": "Not Started",
"started_on": "",
"completed_on": "",
"last_accessed_on": "Never",
"total_time_spent": "",
"points_awarded": "",
"completion_percentage": 0,
"no_of_times_accessed": 0
}
],
"permalink": "http:\/\/localhost:8000\/course\/course-1",
"featuredImageUrl": null,
"instructions": null,
"accessStatus": "Allowed",
"status": "In Progress",
"completionPercentage": 0,
"timeSpent": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"totalSeconds": 0
},
"enrollmentDate": "10 Aug 2020",
"isExpired": false,
"daysToExpire": "Unlimited days",
"lastAccessed": "1 minute ago"
}Request
GET
api/courses/launch
Query Parameters
registrationId string
Course registration ID of the student.
Discount Coupons
A Coupon is used by the students to reduce ther price by some discount, provided by the Instructor. It helps for adding/updating/editing discount coupons applied on products.
Coupons Tabular List
Returns all the coupons in a tabular list format in paginated mode. You can apply filter using search_param via code(coupon code).
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/coupons/tabularlist?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22code%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/coupons/tabularlist"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"code":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"id": 1,
"code": "code75",
"type": "percent_amount",
"value": 1500,
"total_limit": 12,
"expired_at": "Aug 26, 2020"
}
]
}Request
GET
api/coupons/tabularlist
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on field names.
Coupon Lookup
Retrieves all the coupons. Helps while showing coupons in form elements like dropdown. You can apply filters using search_term(coupons) parameter. (See Parameter)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/coupons/lookup?search_term=soluta" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/coupons/lookup"
);
let params = {
"search_term": "soluta",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"id": 1,
"code": "code75"
}
]Request
GET
api/coupons/lookup
Query Parameters
search_term string
You need to provide coupons or substring of the coupons to search.
Coupon Types Lookup
Retrieves all types of the coupons. Helps showing options in form elements like dropdowns.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/coupons/type/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/coupons/type/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"db_value": "fixed_amount",
"display_value": "Fixed cart discount"
},
{
"db_value": "percent_amount",
"display_value": "Percentage Discount"
}
]Request
GET
api/coupons/type/lookup
Create Coupon
To create a coupon, you need to use this request. (See parameters) Created coupons can be used by the students to get some discount while purchasing the course.
Returns : id of the coupon created and successfull message
Example request:
curl -X POST \
"https://demo.aomlms.com/api/coupon/create" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"code":"code75","notes":"Discount upto 75%","value":"1500","type":"percent_amount","usage_limit":1200,"expiry":"2020-08-26","allowed_emails":"null"}'
const url = new URL(
"https://demo.aomlms.com/api/coupon/create"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"code": "code75",
"notes": "Discount upto 75%",
"value": "1500",
"type": "percent_amount",
"usage_limit": 1200,
"expiry": "2020-08-26",
"allowed_emails": "null"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 1,
"message": "Coupon created successfully"
}Request
POST
api/coupon/create
Body Parameters
code string
Code for the coupon.
notes string optional
Notes for the coupon.
value numeric
Value of the coupon(discount price or percentage).
type string
Types of the coupon. Type options: fixed_amount or percent_amount.
usage_limit integer optional
How many times this coupon can be used?.
expiry date optional
On this date, this coupon will get expired.
allowed_emails string optional
All allowed email comma seprated.
Retrieve Coupon
Retrieves the details of the specified coupon. Helps in fetching coupon using its ID. (See Parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/coupon/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/coupon/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"code": "code75",
"type": "percent_amount",
"value": 1500,
"usage_limit": 12,
"expiry": "2020-08-26",
"allowed_emails": null,
"note_privacy": null,
"notes": "Discount upto 75%",
"allowed_products": [],
"excluded_products": [],
"allowed_product_categories": []
}Request
GET
api/coupon/{id}
URL Parameters
id string
ID of the coupon you want to fetch the details of.
Update Coupon
Updates the details of a specified coupon. (See parameters) Coupons can be used by the students to get some discount while purchasing the course.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/coupon/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"code":"code75","notes":"Discount upto 75%","value":"1500","type":"percent_amount","usage_limit":2000,"expiry":"2020-08-26","allowed_emails":"null"}'
const url = new URL(
"https://demo.aomlms.com/api/coupon/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"code": "code75",
"notes": "Discount upto 75%",
"value": "1500",
"type": "percent_amount",
"usage_limit": 2000,
"expiry": "2020-08-26",
"allowed_emails": "null"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Coupon updated successfully"
}Request
PUT
api/coupon/{id}
URL Parameters
id string
ID of the coupon.
Body Parameters
code string
code for the coupon.
notes string optional
Notes for the coupon.
value numeric
Value of the coupon(discount price or percentage).
type string
Types of the coupon. Type options: fixed_amount or percent_amount.
usage_limit integer optional
How many times this coupon can be used?.
expiry date optional
On this date, this coupon will get expired.
allowed_emails string optional
All allowed email comma seprated.
Delete Coupon
To delete a coupon, you need to use this request. Returns number of coupons deleted(if multiple selected) and also not deleted. (See Response)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/coupon/delete" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"delete_ids":[1,12,15]}'
const url = new URL(
"https://demo.aomlms.com/api/coupon/delete"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"delete_ids": [
1,
12,
15
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "2 coupon(s) deleted 1 coupon(s) not deleted as they are associated with orders"
}Request
POST
api/coupon/delete
Body Parameters
delete_ids array
All coupon IDs which needs to be deleted.
Discussions
A Discussion module is used as course content and a platform where students can have discussions. Helps to perform CRUD operation to and for discussion modules.
Discussion modules Tabular List
Returns all the discussion modules in a tabular list format in paginated mode. You can apply filter using search_param via associatedCourse(modules used in course) and moduleName.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/modules/discussion?page_size=50&page_number=5&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22associatedCourse%22%3A%22%22%2C%22moduleName%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/modules/discussion"
);
let params = {
"page_size": "50",
"page_number": "5",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"associatedCourse":"","moduleName":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"id": 13,
"name": "First-discussion",
"slug": "first-discussion",
"type": "discussion",
"totalPoints": 20,
"icon": "<i class=\"el-icon-chat-line-round\"><\/i>",
"author": "Aom Staff",
"created_at": "Aug 11, 2020 05:25 AM"
}
]
}Request
GET
api/modules/discussion
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on field names.
Create Discussion Module
To create a discussion module, you need to use this request. (See parameters) Created discussion modules can be used in the course as course content/lesson.
Returns : id of the discussion created and successfull message
Example request:
curl -X POST \
"https://demo.aomlms.com/api/modules/discussion" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"First-discussion","content":"A brief description","should_be_evaluated":true,"totalPoints":20,"minComments":3}'
const url = new URL(
"https://demo.aomlms.com/api/modules/discussion"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "First-discussion",
"content": "A brief description",
"should_be_evaluated": true,
"totalPoints": 20,
"minComments": 3
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 13,
"message": "Module saved successfully"
}Request
POST
api/modules/discussion
Body Parameters
name string
Name of the discussion module.
content string
Content for the discussion modules that students will see.
should_be_evaluated boolean
If true, the discussion will be graded on course evaluation.
totalPoints integer optional
Total points a student can get by completing this discussion.
minComments integer optional
At least these many comments should be provided by the student to pass the discussion(required if should_be_evaluated is true).
Update Discussion Module
Update the details of specified discussion module. (See Response) Discussion modules can be used in the course as course content/lesson.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/modules/discussion/{id}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"First-discussion","content":"An updatedbrief description","should_be_evaluated":true,"totalPoints":20,"minComments":5}'
const url = new URL(
"https://demo.aomlms.com/api/modules/discussion/{id}"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "First-discussion",
"content": "An updatedbrief description",
"should_be_evaluated": true,
"totalPoints": 20,
"minComments": 5
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Module updated successfully"
}Request
PUT
api/modules/discussion/{id}
Body Parameters
name string
Name of the discussion module.
content string
Content for the discussion modules that students will see.
should_be_evaluated boolean
If true, the discussion will be graded on course evaluation.
totalPoints integer optional
Total points a student can get by completing this discussion.
minComments integer optional
At least these many comments should be provided by the student to pass the discussion(required if should_be_evaluated is true).
Retrieve Discussion modules
Retrieves the details of the specified discussion module. Helps in fetching discussion module using its ID. (See Parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/modules/discussion/13" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/modules/discussion/13"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "First-discussion",
"slug": "first-discussion",
"content": "A Brief Description",
"totalPoints": 20,
"should_be_evaluated": true,
"minComments": 3
}Request
GET
api/modules/discussion/{id}
URL Parameters
id string
ID of the discussion module you want to fetch the details of.
Retrieve Detailed Discussion Module Info
Retrieves details of discussion module in depth as well as different modules details that are being used as course content for the same course the current discussion module is attached to. Returns related fields value. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/module/discussion/details?registrationId=1&moduleId=13" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/module/discussion/details"
);
let params = {
"registrationId": "1",
"moduleId": "13",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "First-discussion",
"slug": "first-discussion",
"content": "A Brief Description",
"courseName": "course 1",
"courseSlug": "http:\/\/localhost:8000\/course\/course-1",
"url": null,
"totalPoints": 20,
"shouldBeEvaluated": true,
"min_time_spent": 0,
"otherModules": [
{
"module_id": 1,
"name": "test",
"slug": "test",
"type": "text",
"icon": "<i class=\"el-icon-tickets\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": 1,
"status": "Completed",
"started_on": "2020-08-03T10:02:33.000000Z",
"completed_on": "2020-08-03T10:02:41.000000Z",
"last_accessed_on": "11 hours ago",
"total_time_spent": {
"hours": 0,
"minutes": 0,
"seconds": 6,
"totalSeconds": 6
},
"completion_percentage": 100,
"no_of_times_accessed": 3
},
{
"module_id": 4,
"name": "assign",
"slug": "assign",
"type": "assignment",
"icon": "<i class=\"el-icon-edit-outline\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": true,
"status_row_id": -1,
"status": "Not Started",
"started_on": "",
"completed_on": "",
"last_accessed_on": "Never",
"total_time_spent": "",
"points_awarded": "",
"completion_percentage": 0,
"no_of_times_accessed": 0
},
{
"module_id": 7,
"name": "First-quiz",
"slug": "first-quiz",
"type": "quiz",
"icon": "<i class=\"el-icon-discover\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": -1,
"status": "Not Started",
"started_on": "",
"completed_on": "",
"last_accessed_on": "Never",
"total_time_spent": "",
"points_awarded": "",
"completion_percentage": 0,
"no_of_times_accessed": 0
},
{
"module_id": 9,
"name": "My-video-lesson",
"slug": "my-video-lesson",
"type": "video",
"icon": "<i class=\"el-icon-video-play\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": 4,
"status": "In Progress",
"started_on": "2020-08-10T20:04:14.000000Z",
"completed_on": null,
"last_accessed_on": "9 hours ago",
"total_time_spent": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"totalSeconds": null
},
"completion_percentage": 0,
"no_of_times_accessed": 1
},
{
"module_id": 10,
"name": "Essay on LMS",
"slug": "essay-on-lms",
"type": "assignment",
"icon": "<i class=\"el-icon-edit-outline\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": 5,
"status": "Completed",
"started_on": "2020-08-11T02:47:32.000000Z",
"completed_on": "2020-08-11T02:47:32.000000Z",
"last_accessed_on": "2 hours ago",
"total_time_spent": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"totalSeconds": null
},
"completion_percentage": 100,
"no_of_times_accessed": 2
},
{
"module_id": 12,
"name": "New-Webinar",
"slug": "new-webinar",
"type": "webinar",
"icon": "<i class=\"el-icon-date\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": -1,
"status": "Not Started",
"started_on": "",
"completed_on": "",
"last_accessed_on": "Never",
"total_time_spent": "",
"points_awarded": "",
"completion_percentage": 0,
"no_of_times_accessed": 0
},
{
"module_id": 13,
"name": "First-discussion",
"slug": "first-discussion",
"type": "discussion",
"icon": "<i class=\"el-icon-chat-line-round\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": -1,
"status": "Not Started",
"started_on": "",
"completed_on": "",
"last_accessed_on": "Never",
"total_time_spent": "",
"points_awarded": "",
"completion_percentage": 0,
"no_of_times_accessed": 0
}
],
"launchCheck": {
"canbeLaunched": true,
"errTitle": "",
"errDesc": ""
},
"prevSlug": "new-webinar",
"nextSlug": "",
"currentUserId": 3,
"currentStudentAvatar": "<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"40\" height=\"40\" viewBox=\"0 0 40 40\"><circle cx=\"20\" cy=\"20\" r=\"20\" stroke=\"background\" stroke-width=\"0\" fill=\"#4CAF50\" \/><text x=\"20\" y=\"20\" font-size=\"14\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">DS<\/text><\/svg>",
"currentUserName": "Demo Student",
"status": "In Progress",
"statusRowId": 6,
"timeSpent": null
}Request
GET
api/module/discussion/details
Query Parameters
registrationId string
ID of the course Registration for which this module is attached to.
moduleId string
ID of the discussion module.
Retrieve Comments
Retrieves the comments posted by students in the disussion. Helps in showing all the comments student have posted in the specified discussion in one place. (See Response) You can apply filters using search_param via nameOrEmail(student email or name) and registrationId(student course registration id)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/module/discussion/loadComments?page_size=50&page_number=4&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22nameOrEmail%22%3A%22%22%2C%22registrationId%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/module/discussion/loadComments"
);
let params = {
"page_size": "50",
"page_number": "4",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"nameOrEmail":"","registrationId":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"id": 1,
"comment": "My first comment",
"userAvatar": "<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"40\" height=\"40\" viewBox=\"0 0 40 40\"><circle cx=\"20\" cy=\"20\" r=\"20\" stroke=\"background\" stroke-width=\"0\" fill=\"#00BCD4\" \/><text x=\"20\" y=\"20\" font-size=\"14\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">AS<\/text><\/svg>",
"userFullName": "Aom Staff",
"date": "Aug 11, 2020 05:56 AM",
"replies": []
}
]
}Request
GET
api/module/discussion/loadComments
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on field names.
Post Comment
Posts a comment in a discussion. Updates the status of discussion to submitted if student has posted minimum numner of posts for the discussion per user.. (See Parameters)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/module/discussion/postComment" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"statusRowId":4,"currentUserId":1,"comment":"My first comment","parentId":2}'
const url = new URL(
"https://demo.aomlms.com/api/module/discussion/postComment"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"statusRowId": 4,
"currentUserId": 1,
"comment": "My first comment",
"parentId": 2
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"status": "In Progress",
"message": "Comment Posted"
}Request
POST
api/module/discussion/postComment
Body Parameters
statusRowId integer
ID of the ModuleStatus Row belongs to current discussion module.
currentUserId integer
ID of the user who commented.
comment string
Comment posted by the user for current discussion.
parentId integer optional
Parent ID of the discussion. Example:
Retrieve Discussion Submission Details
Retrieves the submission details of the duscussion the student have taken participation. Helps to get discussion and its submission in one place. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/module/discussion/submissions?statusRowId=7" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/module/discussion/submissions"
);
let params = {
"statusRowId": "7",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"courseId": 1,
"courseName": "course 1",
"discussionName": "First-discussion",
"status": "In Progress",
"content": "A Brief Description",
"totalPoints": 20,
"userAvatar": "<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"40\" height=\"40\" viewBox=\"0 0 40 40\"><circle cx=\"20\" cy=\"20\" r=\"20\" stroke=\"background\" stroke-width=\"0\" fill=\"#00BCD4\" \/><text x=\"20\" y=\"20\" font-size=\"14\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">AS<\/text><\/svg>",
"userFullName": "Aom Staff",
"comments": [
{
"id": 1,
"comment": "My first comment",
"date": "Aug 11, 2020 05:56 AM"
}
],
"replies": []
}Request
GET
api/module/discussion/submissions
Query Parameters
statusRowId string
ID of the Module status of the current discussion submission.
Evaluate Discussion
Evaluates the discussion from Instructor side. Updates the status of discussion to completed if Instructor thinks student's submission is upto the marks. (See Parameters)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/module/discussion/evaluate" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"statusRowId":"7","evaluation":"{instructorMessage : 'You comments look good', pointsAwarded: '50' }"}'
const url = new URL(
"https://demo.aomlms.com/api/module/discussion/evaluate"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"statusRowId": "7",
"evaluation": "{instructorMessage : 'You comments look good', pointsAwarded: '50' }"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Discussion evaluated successfully"
}Request
POST
api/module/discussion/evaluate
Body Parameters
statusRowId required optional
ID of the Module status of the current discussion.
evaluation required optional
Evaluation data by the Instructor(Completed or not).
ECommerce Orders
An ECommerce Order is made by the students when they purchase a product hence course. It helps in managing orders and performing CRUD operation on orders.
Order Tabular List
Returns all the orders in a tabular list format in paginated mode. You can apply filter using search_param via user(purchased by) and status(status of the order).
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/orders/tabularlist?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22user%22%3A%5B%5D%2C%22status%22%3A%5B%5D%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/orders/tabularlist"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"user":[],"status":[]}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"currencySymbol": "$",
"records": [
{
"id": 1,
"status": "PENDING_PAYMENT",
"total": "3001.00",
"isTestOrder": false,
"customer": "Demo Student",
"created_at": "Aug 25, 2020 12:00 AM"
}
]
}Request
GET
api/orders/tabularlist
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
for searching items based on field names.
Retrieve/Download Order Invoice
Retrieves the details of a specified order and returns as downloaded pdf file.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/order/download?orderId=1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/order/download"
);
let params = {
"orderId": "1",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
"pdf file"Request
GET
api/order/download
Query Parameters
orderId string
Order Id for which you need Invoice.
Export Order
Retrieves all the orders made till date and exports it to excel format for letting users download it as excel file. You can use the response for plotting graphs
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/order/export?filters=%7B%22dateRange%22%3A%5B%222020-07-31T18%3A30%3A00.000Z%22%2C%222020-08-30T18%3A30%3A00.000Z%22%5D%2C%22users%22%3A%5B3%5D%2C%22coupons%22%3A%5B%5D%2C%22products%22%3A%5B1%5D%2C%22status%22%3A%5B%22PENDING_PAYMENT%22%5D%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/order/export"
);
let params = {
"filters": "{"dateRange":["2020-07-31T18:30:00.000Z","2020-08-30T18:30:00.000Z"],"users":[3],"coupons":[],"products":[1],"status":["PENDING_PAYMENT"]}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
"orders-text.xlsx"Request
GET
api/order/export
Query Parameters
filters string
All the filters after which you need order details in a excel file (filters like date-range, product, customer name, payment status, coupon used, etc).
Retrieve Yearly Sales
Retrieves the details of yearly based order sales made from students and returns in tabular form. You can use the response for plotting graphs
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/order/reports/yearsales?year=2019" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/order/reports/yearsales"
);
let params = {
"year": "2019",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"labels": [
"Jan",
"Feb",
"Mar",
"Apr",
"May",
"Jun",
"Jul",
"Aug",
"Sep",
"Oct",
"Nov",
"Dec"
],
"totalIncome": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"totalOrders": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"currency": {
"display_name": "United States (US) dollar",
"symbol": "$"
},
"sumIncome": 0,
"sumTotalOrder": 0
}Request
GET
api/order/reports/yearsales
Query Parameters
year string
Year for which you need sales information.
Retrieve Monthly Sales
Retrieves the details of monthly based order sales for this year made from students and returns in tabular form. You can use the response for plotting graphs
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/order/reports/monthlysales?selectedMonth=8-2020" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/order/reports/monthlysales"
);
let params = {
"selectedMonth": "8-2020",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"labels": [
"Aug-01",
"Aug-02",
"Aug-03",
"Aug-04",
"Aug-05",
"Aug-06",
"Aug-07",
"Aug-08",
"Aug-09",
"Aug-10",
"Aug-11",
"Aug-12",
"Aug-13",
"Aug-14",
"Aug-15",
"Aug-16",
"Aug-17",
"Aug-18",
"Aug-19",
"Aug-20",
"Aug-21",
"Aug-22",
"Aug-23",
"Aug-24",
"Aug-25",
"Aug-26",
"Aug-27",
"Aug-28",
"Aug-29",
"Aug-30",
"Aug-31"
],
"totalIncome": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"totalOrders": [
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0,
0
],
"currency": {
"display_name": "United States (US) dollar",
"symbol": "$"
},
"sumIncome": 0,
"sumTotalOrder": 0
}Request
GET
api/order/reports/monthlysales
Query Parameters
selectedMonth string
Month for which you need sales information(month_number-year).
Retrieve Product Breakdown Sales
Retrieves the details of product break-down based order sales for this year made from students and returns in tabular form. You can use the response for plotting graphs
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/order/reports/productbreakdown?selectedDateRange=2022-08-21" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/order/reports/productbreakdown"
);
let params = {
"selectedDateRange": "2022-08-21",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"labels": [
"Product-1"
],
"totalIncome": [
0
],
"totalOrders": [
0
],
"currency": {
"display_name": "United States (US) dollar",
"symbol": "$"
},
"sumIncome": 0,
"sumTotalOrder": 0
}Request
GET
api/order/reports/productbreakdown
Query Parameters
selectedDateRange string
Date Range for which you need sales information(year-month-date).
Order Status Lookup
Retrieves all the statuses of the order the platform offers completed, cancelled, failed, etc. Helps showing options in form elements like dropdowns.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/order/status/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/order/status/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"db_value": "PENDING_PAYMENT",
"display_value": "Payment Pending"
},
{
"db_value": "COMPLETED",
"display_value": "Completed"
},
{
"db_value": "CANCELLED",
"display_value": "Cancelled"
},
{
"db_value": "REFUNDED",
"display_value": "Refunded"
},
{
"db_value": "FAILED",
"display_value": "Failed"
}
]Request
GET
api/order/status/lookup
Delete Order
To delete a order, you need to use this request. Returns number of orders deleted. (See Response)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/order/delete" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"delete_ids":[1,5]}'
const url = new URL(
"https://demo.aomlms.com/api/order/delete"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"delete_ids": [
1,
5
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "2 order(s) deleted"
}Request
POST
api/order/delete
Body Parameters
delete_ids array
All order IDs which needs to be deleted.
Create Order
To create a order, you need to use this request. (See parameters) Created order can be used as purchasing product by students.
Returns : id of the order created and successfull message
Example request:
curl -X POST \
"https://demo.aomlms.com/api/order/create" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"orderDate":"2020-08-25 0:00:00","status":"PENDING_PAYMENT","customerId":3,"billingAddressId":3500,"orderItems":[],"orderNotes":[],"taxAmount":"null","otherFee":"null"}'
const url = new URL(
"https://demo.aomlms.com/api/order/create"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"orderDate": "2020-08-25 0:00:00",
"status": "PENDING_PAYMENT",
"customerId": 3,
"billingAddressId": 3500,
"orderItems": [],
"orderNotes": [],
"taxAmount": "null",
"otherFee": "null"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 1,
"message": "Order created successfully"
}Request
POST
api/order/create
Body Parameters
orderDate date
Ordering date.
status string
Different status for the orders like pending, completed, failed, etc. Status options: PENDING_PAYMENT, COMPLETED, CANCELLED, REFUNDED or FAILED.
customerId integer
Ordered by this user Id.
billingAddressId integer optional
Billing address Id.
orderItems array
All added item for this order purchased together.
orderNotes array optional
Notes either public or private while creating course(to remeber something, like normal note).
taxAmount numeric optional
Tax amount.
otherFee numeric optional
Other extra fees.
Retrieve Order
Retrieves the details of the specified order. Helps in fetching order using its ID. (See Parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/order/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/order/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"orderDate": "Aug 25, 2020 12:00 AM",
"status": "PENDING_PAYMENT",
"customerId": 3,
"billingAddressId": null,
"taxAmount": "0.00",
"otherFee": "0.00",
"isTestOrder": false,
"total": "3001.00",
"sub_total": "3001.00",
"currency": {
"display_name": "United States (US) dollar",
"symbol": "$"
},
"shopAddress": {
"shop_address_1": "1234 Lorem Ipsum Drive",
"shop_address_2": "",
"shop_city": "New Jersey",
"shop_country": "US",
"shop_state": "",
"shop_zipcode": "08053",
"shop_name": "Academy of mine",
"shop_logo": "http:\/\/localhost:8000\/images\/aom-logo.svg"
},
"billingAddress": {
"id": -1,
"isDefault": false,
"fullName": "",
"addressLine1": "",
"addressLine2": "",
"zipcode": "",
"city": "",
"state": "",
"country": ""
},
"orderNotes": [
{
"id": 1,
"data": "note-1",
"type": "PRIVATE",
"created_on": "Aug 11, 2020 05:36 PM"
}
],
"orderItems": [
{
"product_id": 1,
"product_title": "Product-1",
"price": "3001.00",
"quantity": 1,
"total": "3001.00"
}
]
}Request
GET
api/order/{id}
URL Parameters
id string
ID of the order you want to fetch the details of.
Update Order
Updates the details of a specified order. (See parameters) Orders can be used as purchasing products by students.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/order/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"orderDate":"2020-08-25 0:00:00","status":"COMPLETED","customerId":3,"billingAddressId":3500,"orderItems":[],"orderNotes":[],"taxAmount":"null","otherFee":"null"}'
const url = new URL(
"https://demo.aomlms.com/api/order/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"orderDate": "2020-08-25 0:00:00",
"status": "COMPLETED",
"customerId": 3,
"billingAddressId": 3500,
"orderItems": [],
"orderNotes": [],
"taxAmount": "null",
"otherFee": "null"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Order updated successfully"
}Request
PUT
api/order/{id}
URL Parameters
id string
ID of the order.
Body Parameters
orderDate date
Ordering date.
status string
Different status for the orders like pending, completed, failed, etc. Status options: PENDING_PAYMENT, COMPLETED, CANCELLED, REFUNDED or FAILED.
customerId integer
Ordered by this user Id.
billingAddressId integer optional
Billing address Id.
orderItems array
All added item for this order purchased together.
orderNotes array optional
Notes either public or private while creating course(to remeber something, like normal note).
taxAmount numeric optional
Tax amount.
otherFee numeric optional
Other extra fees.
Create Order Notes
To create a order note, you need to use this request. (See parameters) Created order notes can be used as remebering assets for Instructor while creating/editing order.
Returns : id, type and data of the order notes created. (See Response)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/order-note/create" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"data":"This order is just for testing purpose","orderId":1,"type":"PRIVATE"}'
const url = new URL(
"https://demo.aomlms.com/api/order-note/create"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"data": "This order is just for testing purpose",
"orderId": 1,
"type": "PRIVATE"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"id": 1,
"data": "note-1",
"type": "PRIVATE",
"created_on": "Aug 11, 2020 05:36 PM"
},
{
"id": 2,
"data": "New notes",
"type": "PRIVATE",
"created_on": "Aug 11, 2020 06:04 PM"
}
]Request
POST
api/order-note/create
Body Parameters
data string
Actual content of the note.
orderId integer
ID of the order in which this note is being created.
type string
Type of the note. Type options: Public or Private.
Delete Order Note
To delete a order note, you need to use this request. Returns all order notes left after this note gets deleted. (See Response)
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/order-note/delete/2" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/order-note/delete/2"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"id": 1,
"data": "note-1",
"type": "PRIVATE",
"created_on": "Aug 11, 2020 05:36 PM"
}
]Request
PUT
api/order-note/delete/{id}
URL Parameters
id string
Order Note ID which needs to be deleted.
ECommerce Payments
Endpoints for managing ecommerce Payment Gateways. Payment gateways will be used when your users are purchasing products.
Retrieve Payment gateways
Retrieves all payment gateways details supported by the platform. (See Parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/settings/payment-gateway" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/settings/payment-gateway"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"records": [
{
"id": 1,
"name": "Stripe",
"logo_url": "\/images\/stripe-logo.svg",
"is_enabled": true,
"support_recurring_payments": false
},
{
"id": 2,
"name": "Authorize .NET CIM",
"logo_url": "\/images\/anet-logo.svg",
"is_enabled": false,
"support_recurring_payments": false
}
]
}Request
GET
api/settings/payment-gateway
Update Gateway Status
Updates the payment gateway status(enabled or disabled) to receive payment from students/users.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/paymentmethod/updateStatus" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"id":1,"status":false}'
const url = new URL(
"https://demo.aomlms.com/api/paymentmethod/updateStatus"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"id": 1,
"status": false
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Settings Updated"
}Request
PUT
api/paymentmethod/updateStatus
Body Parameters
id integer
ID of the Payement Gateway.
status boolean
Whether this payment gateway is enabled or not.
Update Stripe Settings
Updates the settings for Stripe payment gateway. Setting needs to be updated is mentioned in parameter. (See Parameter)
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/settings/stripe" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"gatewayEnabled":true,"paymentTitle":"Pay by Credit or Debit Card","livePublishableKey":"laborum","liveSecretKey":"nulla"}'
const url = new URL(
"https://demo.aomlms.com/api/settings/stripe"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"gatewayEnabled": true,
"paymentTitle": "Pay by Credit or Debit Card",
"livePublishableKey": "laborum",
"liveSecretKey": "nulla"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Settings Updated"
}Request
PUT
api/settings/stripe
Body Parameters
gatewayEnabled boolean
Enable status of stripe gateway.
paymentTitle string optional
Payment title for the payments.
livePublishableKey string optional
Live publishable key value. Example:
liveSecretKey string optional
Live secret key value. Example:
Retrieve Stripe Settings
Retrieves all the settings for Stripe payment gateway. Helps in mainting the data and enable status of the stripe settings.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/settings/stripe" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/settings/stripe"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"gatewayEnabled": false,
"paymentTitle": "Pay by Credit or Debit Card",
"livePublishableKey": "",
"liveSecretKey": ""
}Request
GET
api/settings/stripe
Update AuthorizeNet Settings
Updates the settings for AuthorizeNet payment gateway. Setting needs to be updated is mentioned in parameter. (See Parameter)
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/settings/authorizenet" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"gatewayEnabled":true,"paymentTitle":"Pay via Authorize.NET","transactionKey":"no","loginId":"ex","clientId":"inventore"}'
const url = new URL(
"https://demo.aomlms.com/api/settings/authorizenet"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"gatewayEnabled": true,
"paymentTitle": "Pay via Authorize.NET",
"transactionKey": "no",
"loginId": "ex",
"clientId": "inventore"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Settings Updated"
}Request
PUT
api/settings/authorizenet
Body Parameters
gatewayEnabled boolean
Enable status of AuthorizeNet gateway.
paymentTitle string optional
Payment title for the payments.
transactionKey string optional
Transaction key value.
loginId string optional
Login Id from AuthorizeNet. Example:
clientId string optional
Client Id from AuthorizeNet. Example:
Retrieve AuthorizeNet Settings
Retrieves all the settings for AuthorizeNet payment gateway. Helps in maintaining the data and enable status of the AuthorizeNet settings.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/settings/authorizenet" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/settings/authorizenet"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"gatewayEnabled": false,
"paymentTitle": "Pay via Authorize.NET",
"loginId": "",
"transactionKey": "no",
"clientId": ""
}Request
GET
api/settings/authorizenet
Update BrainTree Settings
Updates the settings for BrainTree payment gateway. Setting needs to be updated is mentioned in parameter. (See Parameter)
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/settings/braintree" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"gatewayEnabled":true,"paymentTitle":"Pay by Credit or Debit Card","merchantId":"sit","publicKey":"non","privateKey":"mollitia"}'
const url = new URL(
"https://demo.aomlms.com/api/settings/braintree"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"gatewayEnabled": true,
"paymentTitle": "Pay by Credit or Debit Card",
"merchantId": "sit",
"publicKey": "non",
"privateKey": "mollitia"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Settings Updated"
}Request
PUT
api/settings/braintree
Body Parameters
gatewayEnabled boolean
Enable status of stripe gateway.
paymentTitle string optional
Payment title for the payments.
merchantId string optional
Merchant Id value. Example:
publicKey string optional
Public Key value. Example:
privateKey string optional
Private key value. Example:
Retrieve Braintree Settings
Retrieves all the settings for Braintree payment gateway. Helps in mainting the data and enable status of the Braintree settings.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/settings/braintree" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/settings/braintree"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"gatewayEnabled": false,
"paymentTitle": "Pay by Credit or Debit Card",
"merchantId": "",
"publicKey": "",
"privateKey": ""
}Request
GET
api/settings/braintree
api/settings/paypal
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/settings/paypal" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/settings/paypal"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/settings/paypal
api/settings/paypal
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/settings/paypal" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/settings/paypal"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Request
PUT
api/settings/paypal
ECommerce Products
A Product will be reached to your students. Course has to be attached to products so that students can purchase your courses. Helps in performing CRUD operations for and to products.
Retrieve Product Catalog
Retrieves the details for the product catalogs in paginated form to show this to students as course catalog so that they can purchase the product hence course. (See Parameters) You can apply filter using search_param via title(product title) and categories.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/products/catalog?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22title%22%3A%22%22%2C%22categories%22%3A%5B%5D%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/products/catalog"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"title":"","categories":[]}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"id": 1,
"title": "Product-1",
"slug": "product-1",
"featuredImage": null,
"displayPrice": "<del>$3500 <\/del><span>$3001<\/span>",
"status": "IN-STOCK",
"label": "SALE",
"canBePurchased": true,
"seo_description": null
}
]
}Request
GET
api/products/catalog
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on field names.
api/products/calendar-catalog
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/products/calendar-catalog" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/products/calendar-catalog"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"records": []
}Request
GET
api/products/calendar-catalog
Retrieve Product
Retrieves the details of the specified product. Helps in fetching product using its ID. (See Parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/product/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/product/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"title": "Product-1",
"slug": "product-1",
"description": "Course 1 product",
"featuredImageUrl": null,
"regular_price": 3500,
"type": "SIMPLE",
"sale_price": 3001,
"saleStartDate": null,
"saleEndDate": null,
"status": "IN-STOCK",
"expiry": "2020-10-29",
"taxIncluded": false,
"taxBasedOn": "CUSTOMER-BILLING-ADDR",
"seo_title": null,
"seo_description": null,
"displayPrice": "<del>$3500 <\/del><span>$3001<\/span>",
"canBePurchased": true,
"label": "SALE",
"categories": [],
"courses": [
{
"value": 1,
"label": "course 1"
}
],
"courseCategories": []
}Request
GET
api/product/{id}
URL Parameters
id string
ID of the product you want to fetch the details of.
api/products/get-class-dates
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/products/get-class-dates" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/products/get-class-dates"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (500):
{
"message": "Server Error"
}Request
GET
api/products/get-class-dates
Retrieve Products
Retrieves the details of all products. Helps in fetching entire products in the account. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/products" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/products"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"id": 1,
"title": "Product-1",
"slug": "product-1",
"description": "Course 1 product",
"featured_image_url": null,
"regular_price": 3500,
"sale_price": 3001,
"sale_price_from": null,
"sale_price_to": null,
"status": "IN-STOCK",
"type": "SIMPLE",
"price_frequency": null,
"site-wide-membership": null,
"expired_at": "2020-10-29 00:00:00",
"price_includes_tax": false,
"tax_rate_based_on": "CUSTOMER-BILLING-ADDR",
"seo_title": null,
"seo_description": null,
"created_by": 1,
"updated_by": null,
"deleted_by": null,
"created_at": "2020-08-11 14:12:27",
"updated_at": "2020-08-11 14:12:27",
"deleted_at": null
}
]Request
GET
api/products
Product Types Lookup
Retrieves all the types of the product the platform offers. Helps showing options in form elements like dropdowns.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/product/type/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/product/type/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"db_value": "SIMPLE",
"display_value": "Simple"
},
{
"db_value": "SUBSCRIPTION",
"display_value": "Subscription"
}
]Request
GET
api/product/type/lookup
Update Slug
Updates the slug of the product. Example - old-awesome-product to new-awesome-product
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/products/update-slug/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"slug":"new-product-1"}'
const url = new URL(
"https://demo.aomlms.com/api/products/update-slug/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"slug": "new-product-1"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
"new-product-1"Request
PUT
api/products/update-slug/{id}
URL Parameters
id string
The ID of the product.
Body Parameters
slug required optional
New slug for the product.
Product Status Lookup
Retrieves all the statuses of the product the platform offers like in-stock, out-of-stock, coming-soon. Helps showing options in form elements like dropdowns.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/product/status/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/product/status/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"db_value": "COMING-SOON",
"display_value": "Coming Soon"
},
{
"db_value": "IN-STOCK",
"display_value": "In Stock"
},
{
"db_value": "OUT-OF-STOCK",
"display_value": "Out of Stock"
}
]Request
GET
api/product/status/lookup
Product Tabular List
Returns all the products in a tabular list format in paginated mode. You can apply filter using search_param via title, productStatus(in-stock, out-of-stock, etc) and productCategoryIds.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/products/tabularlist?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22title%22%3A%22%22%2C%22productStatus%22%3A%5B%5D%2C%22productCategoryIds%22%3A%5B%5D%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/products/tabularlist"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"title":"","productStatus":[],"productCategoryIds":[]}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"id": 1,
"title": "Product-1",
"regular_price": 3500,
"type": "SIMPLE",
"status": "IN-STOCK",
"created_at": "Aug 11, 2020 02:12 PM"
}
]
}Request
GET
api/products/tabularlist
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
Searching items based on field names.
Product Lookup
Retrieves all the products in list format. Helps while showing products in form elements like dropdown. You can apply filters using search_term parameter. (See Parameter)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/products/lookup?search_term=dolores" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/products/lookup"
);
let params = {
"search_term": "dolores",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"id": 1,
"title": "Product-1"
}
]Request
GET
api/products/lookup
Query Parameters
search_term string
You need to provide products title or substring of the products title to search.
Create Product
To create a product, you need to use this request. (See parameters) Created product can be used while attaching course to product so that you can sell the course to students.
Returns : id of the product created and successfull message
Example request:
curl -X POST \
"https://demo.aomlms.com/api/product/create" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"title":"Product-1","description":"Course 1 product","featuredImageUrl":"https:\/\/www.aom-images.com\/product.jpeg","regular_price":"3500","type":"SIMPLE","sale_price":"3001","saleStartDate":"null","saleEndDate":"null","status":"IN-STOCK","expiry_date":"2020-10-29 0:00:00","categories":[],"courses":[],"courseCategories":[],"seo_title":"awesome-product","seo_description":"includes many good courses","subscription_price":"3500","price_frequency":"WEEKLY","free_trial_value":"5","free_trial_frequency":"Months","catalog_rank":"5","subscription_expire_after":"null"}'
const url = new URL(
"https://demo.aomlms.com/api/product/create"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"title": "Product-1",
"description": "Course 1 product",
"featuredImageUrl": "https:\/\/www.aom-images.com\/product.jpeg",
"regular_price": "3500",
"type": "SIMPLE",
"sale_price": "3001",
"saleStartDate": "null",
"saleEndDate": "null",
"status": "IN-STOCK",
"expiry_date": "2020-10-29 0:00:00",
"categories": [],
"courses": [],
"courseCategories": [],
"seo_title": "awesome-product",
"seo_description": "includes many good courses",
"subscription_price": "3500",
"price_frequency": "WEEKLY",
"free_trial_value": "5",
"free_trial_frequency": "Months",
"catalog_rank": "5",
"subscription_expire_after": "null"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 1,
"message": "Product created successfully"
}Request
POST
api/product/create
Body Parameters
title string
Name of the product.
description string
Description for the product.
featuredImageUrl string optional
Featured Image for the product.
regular_price numeric
Regular price for the Simple product.
type string
Type of the product. Type options: SIMPLE or SUBSCRIPTION.
sale_price numeric optional
Selling price for the product.
saleStartDate date optional
Sale start date for the product.
saleEndDate date optional
Sale end date for the product.
status string
Status for the product. Status options: COMING-SOON, IN-STOCK or OUT-OF-STOCK.
expiry_date date optional
On this date this product will get expired.
categories array optional
Category for this product.
courses array optional
Courses that you want to attach to this product.
courseCategories array optional
This category related courses will be attached to this product.
seo_title string optional
SEO title for the product.
seo_description string optional
SEO description for the product.
subscription_price numeric
Subscription price for the product for the product type Subscription.
price_frequency string
Price Frequency to be charged for Subscription product. Price Frequency Options: DAILY, WEEKLY, MONTHLY or YEARLY.
free_trial_value numeric optional
Free Trail for the Subscription product.
free_trial_frequency string optional
Free Trail Frequency for the subscription product in which the product will be available for free. Free Trail Frequency Options: DAYS, WEEKS, MONTHS, YEARS.
catalog_rank numeric optional
The order in which you want to display the product in product catalog. 1 is the highest rank.
subscription_expire_after date optional
On this date this subscription product will get expired.
Update Product
Updates the details of a specified product. (See parameters) Product can be used while attaching course to product so that you can sell the course to students.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/product/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"title":"Product-1","description":"Course 1 product","featuredImageUrl":"https:\/\/www.aom-images.com\/product.jpeg","regular_price":"3500","type":"SIMPLE","sale_price":"3001","saleStartDate":"null","saleEndDate":"null","status":"IN-STOCK","expiry":"2020-10-29 0:00:00","categories":[],"courses":[],"courseCategories":[],"seo_title":"awesome-product","seo_description":"includes many good courses","subscription_price":"3500","price_frequency":"WEEKLY","free_trial_value":"5","free_trial_frequency":"Months","catalog_rank":"5","subscription_expire_after":"null"}'
const url = new URL(
"https://demo.aomlms.com/api/product/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"title": "Product-1",
"description": "Course 1 product",
"featuredImageUrl": "https:\/\/www.aom-images.com\/product.jpeg",
"regular_price": "3500",
"type": "SIMPLE",
"sale_price": "3001",
"saleStartDate": "null",
"saleEndDate": "null",
"status": "IN-STOCK",
"expiry": "2020-10-29 0:00:00",
"categories": [],
"courses": [],
"courseCategories": [],
"seo_title": "awesome-product",
"seo_description": "includes many good courses",
"subscription_price": "3500",
"price_frequency": "WEEKLY",
"free_trial_value": "5",
"free_trial_frequency": "Months",
"catalog_rank": "5",
"subscription_expire_after": "null"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Product updated successfully"
}Request
PUT
api/product/{id}
URL Parameters
id string
ID of the product.
Body Parameters
title string
Name of the product.
description string
Description for the product.
featuredImageUrl string optional
Featured Image for the product.
regular_price numeric
Regular price for the Simple product.
type string
Type of the product. Type options: SIMPLE or SUBSCRIPTION.
sale_price numeric optional
Selling price for the product.
saleStartDate date optional
Sale start date for the product.
saleEndDate date optional
Sale end date for the product.
status string
Status for the product. Status options: COMING-SOON, IN-STOCK or OUT-OF-STOCK.
expiry date optional
On this date this product will get expired.
categories array optional
Category for this product.
courses array optional
Courses that you want to attach to this product.
courseCategories array optional
This category related courses will be attached to this product.
seo_title string optional
SEO title for the product.
seo_description string optional
SEO description for the product.
subscription_price numeric
Subscription price for the product for the product type Subscription.
price_frequency string
Price Frequency to be charged for Subscription product. Price Frequency Options: DAILY, WEEKLY, MONTHLY or YEARLY.
free_trial_value numeric optional
Free Trail for the Subscription product.
free_trial_frequency string optional
Free Trail Frequency for the subscription product in which the product will be available for free. Free Trail Frequency Options: DAYS, WEEKS, MONTHS, YEARS.
catalog_rank numeric optional
The order in which you want to display the product in product catalog. 1 is the highest rank.
subscription_expire_after date optional
On this date this subscription product will get expired.
Delete Product
To delete a product, you need to use this request. Returns number of products deleted. (See Response)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/product/delete" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"delete_ids":[1,5]}'
const url = new URL(
"https://demo.aomlms.com/api/product/delete"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"delete_ids": [
1,
5
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "2 product(s) deleted"
}Request
POST
api/product/delete
Body Parameters
delete_ids array
All product IDs which needs to be deleted.
Retrieve Product Price
Retrieves the price of the specified product. Helps in fetching product price using its ID. (See Parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/product/price/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/product/price/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"price": 3001
}Request
GET
api/product/price/{id}
URL Parameters
id string
ID of the product you want to fetch the price of.
Quick Edit
Updates the details in bulk for a specified product. Parameters is provided which needs to be updated. (See Parameters)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/product/quickEdit" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"product_ids":[3,2],"outofstock":true}'
const url = new URL(
"https://demo.aomlms.com/api/product/quickEdit"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"product_ids": [
3,
2
],
"outofstock": true
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Questions updated Successfully"
}Request
POST
api/product/quickEdit
Body Parameters
product_ids array
All product IDs which needs to be updated.
outofstock boolean optional
If true, it updates the status of the course as out-of-stock.
Product Free Trial Interval Lookup For Products
Retrieves how often the amount will be deducted in subscription of the product, the platform offers. Helps showing options in form elements like dropdowns.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/product/freeTrial/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/product/freeTrial/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"db_value": "DAYS",
"display_value": "Days"
},
{
"db_value": "WEEKS",
"display_value": "Weeks"
},
{
"db_value": "MONTHS",
"display_value": "Months"
},
{
"db_value": "YEARS",
"display_value": "Years"
}
]Request
GET
api/product/freeTrial/lookup
Product Price Frequency Lookup for Subscriptions
Retrieves how often the amount will be deducted in subscription of the product, the platform offers. Helps showing options in form elements like dropdowns.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/product/subscription-price-frequency/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/product/subscription-price-frequency/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"db_value": "DAILY",
"display_value": "Per day"
},
{
"db_value": "WEEKLY",
"display_value": "Per week"
},
{
"db_value": "MONTHLY",
"display_value": "Per month"
},
{
"db_value": "YEARLY",
"display_value": "Per year"
}
]Request
GET
api/product/subscription-price-frequency/lookup
ECommerce
Endpoints for managing ecommerce settings. Getting and setting items status and values for the platform and the products.
Country Lookup
Retrieves all the countries in list format. Helps while showing countries in form elements like dropdown.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/countries/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/countries/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"AF": "Afghanistan",
"AL": "Albania",
"DZ": "Algeria",
"AS": "American Samoa",
"AD": "Andorra",
"AO": "Angola",
"AI": "Anguilla",
"AQ": "Antarctica",
"AG": "Antigua and Barbuda",
"AR": "Argentina",
"AM": "Armenia",
"AW": "Aruba",
"AU": "Australia",
"AT": "Austria",
"AZ": "Azerbaijan",
"BS": "Bahamas",
"BH": "Bahrain",
"BD": "Bangladesh",
"BB": "Barbados",
"BY": "Belarus",
"BE": "Belgium",
"PW": "Belau",
"BZ": "Belize",
"BJ": "Benin",
"BM": "Bermuda",
"BT": "Bhutan",
"BO": "Bolivia",
"BQ": "Bonaire, Saint Eustatius and Saba",
"BA": "Bosnia and Herzegovina",
"BW": "Botswana",
"BV": "Bouvet Island",
"BR": "Brazil",
"IO": "British Indian Ocean Territory",
"BN": "Brunei",
"BG": "Bulgaria",
"BF": "Burkina Faso",
"BI": "Burundi",
"KH": "Cambodia",
"CM": "Cameroon",
"CA": "Canada",
"CV": "Cape Verde",
"KY": "Cayman Islands",
"CF": "Central African Republic",
"TD": "Chad",
"CL": "Chile",
"CN": "China",
"CX": "Christmas Island",
"CC": "Cocos (Keeling) Islands",
"CO": "Colombia",
"KM": "Comoros",
"CG": "Congo (Brazzaville)",
"CD": "Congo (Kinshasa)",
"CK": "Cook Islands",
"CR": "Costa Rica",
"HR": "Croatia",
"CU": "Cuba",
"CW": "Curaçao",
"CY": "Cyprus",
"CZ": "Czech Republic",
"DK": "Denmark",
"DJ": "Djibouti",
"DM": "Dominica",
"DO": "Dominican Republic",
"EC": "Ecuador",
"EG": "Egypt",
"SV": "El Salvador",
"GQ": "Equatorial Guinea",
"ER": "Eritrea",
"EE": "Estonia",
"ET": "Ethiopia",
"FK": "Falkland Islands",
"FO": "Faroe Islands",
"FJ": "Fiji",
"FI": "Finland",
"FR": "France",
"GF": "French Guiana",
"PF": "French Polynesia",
"TF": "French Southern Territories",
"GA": "Gabon",
"GM": "Gambia",
"GE": "Georgia",
"DE": "Germany",
"GH": "Ghana",
"GI": "Gibraltar",
"GR": "Greece",
"GL": "Greenland",
"GD": "Grenada",
"GP": "Guadeloupe",
"GU": "Guam",
"GT": "Guatemala",
"GG": "Guernsey",
"GN": "Guinea",
"GW": "Guinea-Bissau",
"GY": "Guyana",
"HT": "Haiti",
"HM": "Heard Island and McDonald Islands",
"HN": "Honduras",
"HK": "Hong Kong",
"HU": "Hungary",
"IS": "Iceland",
"IN": "India",
"ID": "Indonesia",
"IR": "Iran",
"IQ": "Iraq",
"IE": "Ireland",
"IM": "Isle of Man",
"IL": "Israel",
"IT": "Italy",
"CI": "Ivory Coast",
"JM": "Jamaica",
"JP": "Japan",
"JE": "Jersey",
"JO": "Jordan",
"KZ": "Kazakhstan",
"KE": "Kenya",
"KI": "Kiribati",
"KW": "Kuwait",
"KG": "Kyrgyzstan",
"LA": "Laos",
"LV": "Latvia",
"LB": "Lebanon",
"LS": "Lesotho",
"LR": "Liberia",
"LY": "Libya",
"LI": "Liechtenstein",
"LT": "Lithuania",
"LU": "Luxembourg",
"MO": "Macao",
"MK": "North Macedonia",
"MG": "Madagascar",
"MW": "Malawi",
"MY": "Malaysia",
"MV": "Maldives",
"ML": "Mali",
"MT": "Malta",
"MH": "Marshall Islands",
"MQ": "Martinique",
"MR": "Mauritania",
"MU": "Mauritius",
"YT": "Mayotte",
"MX": "Mexico",
"FM": "Micronesia",
"MD": "Moldova",
"MC": "Monaco",
"MN": "Mongolia",
"ME": "Montenegro",
"MS": "Montserrat",
"MA": "Morocco",
"MZ": "Mozambique",
"MM": "Myanmar",
"NA": "Namibia",
"NR": "Nauru",
"NP": "Nepal",
"NL": "Netherlands",
"NC": "New Caledonia",
"NZ": "New Zealand",
"NI": "Nicaragua",
"NE": "Niger",
"NG": "Nigeria",
"NU": "Niue",
"NF": "Norfolk Island",
"MP": "Northern Mariana Islands",
"KP": "North Korea",
"NO": "Norway",
"OM": "Oman",
"PK": "Pakistan",
"PS": "Palestinian Territory",
"PA": "Panama",
"PG": "Papua New Guinea",
"PY": "Paraguay",
"PE": "Peru",
"PH": "Philippines",
"PN": "Pitcairn",
"PL": "Poland",
"PT": "Portugal",
"PR": "Puerto Rico",
"QA": "Qatar",
"RE": "Reunion",
"RO": "Romania",
"RU": "Russia",
"RW": "Rwanda",
"BL": "Saint Barthélemy",
"SH": "Saint Helena",
"KN": "Saint Kitts and Nevis",
"LC": "Saint Lucia",
"MF": "Saint Martin (French part)",
"SX": "Saint Martin (Dutch part)",
"PM": "Saint Pierre and Miquelon",
"VC": "Saint Vincent and the Grenadines",
"SM": "San Marino",
"ST": "São Tomé and Príncipe",
"SA": "Saudi Arabia",
"SN": "Senegal",
"RS": "Serbia",
"SC": "Seychelles",
"SL": "Sierra Leone",
"SG": "Singapore",
"SK": "Slovakia",
"SI": "Slovenia",
"SB": "Solomon Islands",
"SO": "Somalia",
"ZA": "South Africa",
"GS": "South Georgia\/Sandwich Islands",
"KR": "South Korea",
"SS": "South Sudan",
"ES": "Spain",
"LK": "Sri Lanka",
"SD": "Sudan",
"SR": "Suriname",
"SJ": "Svalbard and Jan Mayen",
"SZ": "Swaziland",
"SE": "Sweden",
"CH": "Switzerland",
"SY": "Syria",
"TW": "Taiwan",
"TJ": "Tajikistan",
"TZ": "Tanzania",
"TH": "Thailand",
"TL": "Timor-Leste",
"TG": "Togo",
"TK": "Tokelau",
"TO": "Tonga",
"TT": "Trinidad and Tobago",
"TN": "Tunisia",
"TR": "Turkey",
"TM": "Turkmenistan",
"TC": "Turks and Caicos Islands",
"TV": "Tuvalu",
"UG": "Uganda",
"UA": "Ukraine",
"AE": "United Arab Emirates",
"GB": "United Kingdom",
"US": "United States",
"UM": "United States (US) Minor Outlying Islands",
"UY": "Uruguay",
"UZ": "Uzbekistan",
"VU": "Vanuatu",
"VA": "Vatican",
"VE": "Venezuela",
"VN": "Vietnam",
"VG": "Virgin Islands (British)",
"VI": "Virgin Islands (US)",
"WF": "Wallis and Futuna",
"EH": "Western Sahara",
"WS": "Samoa",
"YE": "Yemen",
"ZM": "Zambia",
"ZW": "Zimbabwe"
}Request
GET
api/countries/lookup
States Lookup
Retrieves all the states in list format. Helps while showing states in form elements like dropdown.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/states/lookup?countryCode=IN" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/states/lookup"
);
let params = {
"countryCode": "IN",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"AP": "Andhra Pradesh",
"AR": "Arunachal Pradesh",
"AS": "Assam",
"BR": "Bihar",
"CT": "Chhattisgarh",
"GA": "Goa",
"GJ": "Gujarat",
"HR": "Haryana",
"HP": "Himachal Pradesh",
"JK": "Jammu and Kashmir",
"JH": "Jharkhand",
"KA": "Karnataka",
"KL": "Kerala",
"MP": "Madhya Pradesh",
"MH": "Maharashtra",
"MN": "Manipur",
"ML": "Meghalaya",
"MZ": "Mizoram",
"NL": "Nagaland",
"OR": "Orissa",
"PB": "Punjab",
"RJ": "Rajasthan",
"SK": "Sikkim",
"TN": "Tamil Nadu",
"TS": "Telangana",
"TR": "Tripura",
"UK": "Uttarakhand",
"UP": "Uttar Pradesh",
"WB": "West Bengal",
"AN": "Andaman and Nicobar Islands",
"CH": "Chandigarh",
"DN": "Dadra and Nagar Haveli",
"DD": "Daman and Diu",
"DL": "Delhi",
"LD": "Lakshadeep",
"PY": "Pondicherry (Puducherry)"
}Request
GET
api/states/lookup
Query Parameters
countryCode string
Country code of which you need state details(like IN, US, etc).
Currency Lookup
Retrieves all the currencies in list format. Helps while showing states in form elements like dropdown.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/currency/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/currency/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"AED": {
"display_name": "United Arab Emirates dirham",
"symbol": "د.إ"
},
"AFN": {
"display_name": "Afghan afghani",
"symbol": "؋"
},
"ALL": {
"display_name": "Albanian lek",
"symbol": "L"
},
"AMD": {
"display_name": "Armenian dram",
"symbol": "AMD"
},
"ANG": {
"display_name": "Netherlands Antillean guilder",
"symbol": "ƒ"
},
"AOA": {
"display_name": "Angolan kwanza",
"symbol": "Kz"
},
"ARS": {
"display_name": "Argentine peso",
"symbol": "$"
},
"AUD": {
"display_name": "Australian dollar",
"symbol": "$"
},
"AWG": {
"display_name": "Aruban florin",
"symbol": "Afl."
},
"AZN": {
"display_name": "Azerbaijani manat",
"symbol": "AZN"
},
"BAM": {
"display_name": "Bosnia and Herzegovina convertible mark",
"symbol": "KM"
},
"BBD": {
"display_name": "Barbadian dollar",
"symbol": "$"
},
"BDT": {
"display_name": "Bangladeshi taka",
"symbol": "৳ "
},
"BGN": {
"display_name": "Bulgarian lev",
"symbol": "лв."
},
"BHD": {
"display_name": "Bahraini dinar",
"symbol": ".د.ب"
},
"BIF": {
"display_name": "Burundian franc",
"symbol": "Fr"
},
"BMD": {
"display_name": "Bermudian dollar",
"symbol": "$"
},
"BND": {
"display_name": "Brunei dollar",
"symbol": "$"
},
"BOB": {
"display_name": "Bolivian boliviano",
"symbol": "Bs."
},
"BRL": {
"display_name": "Brazilian real",
"symbol": "R$"
},
"BSD": {
"display_name": "Bahamian dollar",
"symbol": "$"
},
"BTC": {
"display_name": "Bitcoin",
"symbol": "฿"
},
"BTN": {
"display_name": "Bhutanese ngultrum",
"symbol": "Nu."
},
"BWP": {
"display_name": "Botswana pula",
"symbol": "P"
},
"BYR": {
"display_name": "Belarusian ruble (old)",
"symbol": "Br"
},
"BYN": {
"display_name": "Belarusian ruble",
"symbol": "Br"
},
"BZD": {
"display_name": "Belize dollar",
"symbol": "$"
},
"CAD": {
"display_name": "Canadian dollar",
"symbol": "$"
},
"CDF": {
"display_name": "Congolese franc",
"symbol": "Fr"
},
"CHF": {
"display_name": "Swiss franc",
"symbol": "CHF"
},
"CLP": {
"display_name": "Chilean peso",
"symbol": "$"
},
"CNY": {
"display_name": "Chinese yuan",
"symbol": "¥"
},
"COP": {
"display_name": "Colombian peso",
"symbol": "$"
},
"CRC": {
"display_name": "Costa Rican colón",
"symbol": "₡"
},
"CUC": {
"display_name": "Cuban convertible peso",
"symbol": "$"
},
"CUP": {
"display_name": "Cuban peso",
"symbol": "$"
},
"CVE": {
"display_name": "Cape Verdean escudo",
"symbol": "$"
},
"CZK": {
"display_name": "Czech koruna",
"symbol": "Kč"
},
"DJF": {
"display_name": "Djiboutian franc",
"symbol": "Fr"
},
"DKK": {
"display_name": "Danish krone",
"symbol": "DKK"
},
"DOP": {
"display_name": "Dominican peso",
"symbol": "RD$"
},
"DZD": {
"display_name": "Algerian dinar",
"symbol": "د.ج"
},
"EGP": {
"display_name": "Egyptian pound",
"symbol": "EGP"
},
"ERN": {
"display_name": "Eritrean nakfa",
"symbol": "Nfk"
},
"ETB": {
"display_name": "Ethiopian birr",
"symbol": "Br"
},
"EUR": {
"display_name": "Euro",
"symbol": "€"
},
"FJD": {
"display_name": "Fijian dollar",
"symbol": "$"
},
"FKP": {
"display_name": "Falkland Islands pound",
"symbol": "£"
},
"GBP": {
"display_name": "Pound sterling",
"symbol": "£"
},
"GEL": {
"display_name": "Georgian lari",
"symbol": "₾"
},
"GGP": {
"display_name": "Guernsey pound",
"symbol": "£"
},
"GHS": {
"display_name": "Ghana cedi",
"symbol": "₵"
},
"GIP": {
"display_name": "Gibraltar pound",
"symbol": "£"
},
"GMD": {
"display_name": "Gambian dalasi",
"symbol": "D"
},
"GNF": {
"display_name": "Guinean franc",
"symbol": "Fr"
},
"GTQ": {
"display_name": "Guatemalan quetzal",
"symbol": "Q"
},
"GYD": {
"display_name": "Guyanese dollar",
"symbol": "$"
},
"HKD": {
"display_name": "Hong Kong dollar",
"symbol": "$"
},
"HNL": {
"display_name": "Honduran lempira",
"symbol": "L"
},
"HRK": {
"display_name": "Croatian kuna",
"symbol": "kn"
},
"HTG": {
"display_name": "Haitian gourde",
"symbol": "G"
},
"HUF": {
"display_name": "Hungarian forint",
"symbol": "Ft"
},
"IDR": {
"display_name": "Indonesian rupiah",
"symbol": "Rp"
},
"ILS": {
"display_name": "Israeli new shekel",
"symbol": "₪"
},
"IMP": {
"display_name": "Manx pound",
"symbol": "£"
},
"INR": {
"display_name": "Indian rupee",
"symbol": "₹"
},
"IQD": {
"display_name": "Iraqi dinar",
"symbol": "ع.د"
},
"IRR": {
"display_name": "Iranian rial",
"symbol": "﷼"
},
"IRT": {
"display_name": "Iranian toman",
"symbol": "تومان"
},
"ISK": {
"display_name": "Icelandic króna",
"symbol": "kr."
},
"JEP": {
"display_name": "Jersey pound",
"symbol": "£"
},
"JMD": {
"display_name": "Jamaican dollar",
"symbol": "$"
},
"JOD": {
"display_name": "Jordanian dinar",
"symbol": "د.ا"
},
"JPY": {
"display_name": "Japanese yen",
"symbol": "¥"
},
"KES": {
"display_name": "Kenyan shilling",
"symbol": "KSh"
},
"KGS": {
"display_name": "Kyrgyzstani som",
"symbol": "сом"
},
"KHR": {
"display_name": "Cambodian riel",
"symbol": "៛"
},
"KMF": {
"display_name": "Comorian franc",
"symbol": "Fr"
},
"KPW": {
"display_name": "North Korean won",
"symbol": "₩"
},
"KRW": {
"display_name": "South Korean won",
"symbol": "₩"
},
"KWD": {
"display_name": "Kuwaiti dinar",
"symbol": "د.ك"
},
"KYD": {
"display_name": "Cayman Islands dollar",
"symbol": "$"
},
"KZT": {
"display_name": "Kazakhstani tenge",
"symbol": "KZT"
},
"LAK": {
"display_name": "Lao kip",
"symbol": "₭"
},
"LBP": {
"display_name": "Lebanese pound",
"symbol": "ل.ل"
},
"LKR": {
"display_name": "Sri Lankan rupee",
"symbol": "රු"
},
"LRD": {
"display_name": "Liberian dollar",
"symbol": "$"
},
"LSL": {
"display_name": "Lesotho loti",
"symbol": "L"
},
"LYD": {
"display_name": "Libyan dinar",
"symbol": "ل.د"
},
"MAD": {
"display_name": "Moroccan dirham",
"symbol": "د.م."
},
"MDL": {
"display_name": "Moldovan leu",
"symbol": "MDL"
},
"MGA": {
"display_name": "Malagasy ariary",
"symbol": "Ar"
},
"MKD": {
"display_name": "Macedonian denar",
"symbol": "ден"
},
"MMK": {
"display_name": "Burmese kyat",
"symbol": "Ks"
},
"MNT": {
"display_name": "Mongolian tögrög",
"symbol": "₮"
},
"MOP": {
"display_name": "Macanese pataca",
"symbol": "P"
},
"MRU": {
"display_name": "Mauritanian ouguiya",
"symbol": "UM"
},
"MUR": {
"display_name": "Mauritian rupee",
"symbol": "₨"
},
"MVR": {
"display_name": "Maldivian rufiyaa",
"symbol": ".ރ"
},
"MWK": {
"display_name": "Malawian kwacha",
"symbol": "MK"
},
"MXN": {
"display_name": "Mexican peso",
"symbol": "$"
},
"MYR": {
"display_name": "Malaysian ringgit",
"symbol": "RM"
},
"MZN": {
"display_name": "Mozambican metical",
"symbol": "MT"
},
"NAD": {
"display_name": "Namibian dollar",
"symbol": "N$"
},
"NGN": {
"display_name": "Nigerian naira",
"symbol": "₦"
},
"NIO": {
"display_name": "Nicaraguan córdoba",
"symbol": "C$"
},
"NOK": {
"display_name": "Norwegian krone",
"symbol": "kr"
},
"NPR": {
"display_name": "Nepalese rupee",
"symbol": "₨"
},
"NZD": {
"display_name": "New Zealand dollar",
"symbol": "$"
},
"OMR": {
"display_name": "Omani rial",
"symbol": "ر.ع."
},
"PAB": {
"display_name": "Panamanian balboa",
"symbol": "B\/."
},
"PEN": {
"display_name": "Sol",
"symbol": "S\/"
},
"PGK": {
"display_name": "Papua New Guinean kina",
"symbol": "K"
},
"PHP": {
"display_name": "Philippine peso",
"symbol": "₱"
},
"PKR": {
"display_name": "Pakistani rupee",
"symbol": "₨"
},
"PLN": {
"display_name": "Polish złoty",
"symbol": "zł"
},
"PRB": {
"display_name": "Transnistrian ruble",
"symbol": "р."
},
"PYG": {
"display_name": "Paraguayan guaraní",
"symbol": "₲"
},
"QAR": {
"display_name": "Qatari riyal",
"symbol": "ر.ق"
},
"RON": {
"display_name": "Romanian leu",
"symbol": "lei"
},
"RSD": {
"display_name": "Serbian dinar",
"symbol": "дин."
},
"RUB": {
"display_name": "Russian ruble",
"symbol": "₽"
},
"RWF": {
"display_name": "Rwandan franc",
"symbol": "Fr"
},
"SAR": {
"display_name": "Saudi riyal",
"symbol": "ر.س"
},
"SBD": {
"display_name": "Solomon Islands dollar",
"symbol": "$"
},
"SCR": {
"display_name": "Seychellois rupee",
"symbol": "₨"
},
"SDG": {
"display_name": "Sudanese pound",
"symbol": "ج.س."
},
"SEK": {
"display_name": "Swedish krona",
"symbol": "kr"
},
"SGD": {
"display_name": "Singapore dollar",
"symbol": "$"
},
"SHP": {
"display_name": "Saint Helena pound",
"symbol": "£"
},
"SLL": {
"display_name": "Sierra Leonean leone",
"symbol": "Le"
},
"SOS": {
"display_name": "Somali shilling",
"symbol": "Sh"
},
"SRD": {
"display_name": "Surinamese dollar",
"symbol": "$"
},
"SSP": {
"display_name": "South Sudanese pound",
"symbol": "£"
},
"STN": {
"display_name": "São Tomé and Príncipe dobra",
"symbol": "Db"
},
"SYP": {
"display_name": "Syrian pound",
"symbol": "ل.س"
},
"SZL": {
"display_name": "Swazi lilangeni",
"symbol": "L"
},
"THB": {
"display_name": "Thai baht",
"symbol": "฿"
},
"TJS": {
"display_name": "Tajikistani somoni",
"symbol": "ЅМ"
},
"TMT": {
"display_name": "Turkmenistan manat",
"symbol": "m"
},
"TND": {
"display_name": "Tunisian dinar",
"symbol": "د.ت"
},
"TOP": {
"display_name": "Tongan paʻanga",
"symbol": "T$"
},
"TRY": {
"display_name": "Turkish lira",
"symbol": "₺"
},
"TTD": {
"display_name": "Trinidad and Tobago dollar",
"symbol": "$"
},
"TWD": {
"display_name": "New Taiwan dollar",
"symbol": "NT$"
},
"TZS": {
"display_name": "Tanzanian shilling",
"symbol": "Sh"
},
"UAH": {
"display_name": "Ukrainian hryvnia",
"symbol": "₴"
},
"UGX": {
"display_name": "Ugandan shilling",
"symbol": "UGX"
},
"USD": {
"display_name": "United States (US) dollar",
"symbol": "$"
},
"UYU": {
"display_name": "Uruguayan peso",
"symbol": "$"
},
"UZS": {
"display_name": "Uzbekistani som",
"symbol": "UZS"
},
"VEF": {
"display_name": "Venezuelan bolívar",
"symbol": "Bs F"
},
"VES": {
"display_name": "Bolívar soberano",
"symbol": "Bs.S"
},
"VND": {
"display_name": "Vietnamese đồng",
"symbol": "₫"
},
"VUV": {
"display_name": "Vanuatu vatu",
"symbol": "Vt"
},
"WST": {
"display_name": "Samoan tālā",
"symbol": "T"
},
"XAF": {
"display_name": "Central African CFA franc",
"symbol": "CFA"
},
"XCD": {
"display_name": "East Caribbean dollar",
"symbol": "$"
},
"XOF": {
"display_name": "West African CFA franc",
"symbol": "CFA"
},
"XPF": {
"display_name": "CFP franc",
"symbol": "Fr"
},
"YER": {
"display_name": "Yemeni rial",
"symbol": "﷼"
},
"ZAR": {
"display_name": "South African rand",
"symbol": "R"
},
"ZMW": {
"display_name": "Zambian kwacha",
"symbol": "ZK"
}
}Request
GET
api/currency/lookup
Retrieve General Ecommerce Settings
Retrieves the details of the general ecommerce settings. Helps in fetching items of the ecommerce settings, like country, city, address, location, etc(See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/settings/ecommerce/general" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/settings/ecommerce/general"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"addressLine1": "1234 Lorem Ipsum Drive",
"addressLine2": "",
"country": "US",
"state": "",
"city": "New Jersey",
"zipcode": "08053",
"selling_location": "all_countries",
"some_countries_excluded": "",
"some_countries": "",
"enableTaxes": "no",
"enableCoupons": "no",
"currency": "USD"
}Request
GET
api/settings/ecommerce/general
Set General Ecommerce Settings
To save the general Ecommerce settings with updated values, you need to use this request. (See parameters)
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/settings/ecommerce/general" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"addressLine1":"1234 Lorem Ipsum Drive","addressLine2":"modi","city":"New Jersey","state":"vero","country":"country","currency":"USD","enableCoupons":"no","enableTaxes":"no","zipcode":"08053","selling_location":"all_countries"}'
const url = new URL(
"https://demo.aomlms.com/api/settings/ecommerce/general"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"addressLine1": "1234 Lorem Ipsum Drive",
"addressLine2": "modi",
"city": "New Jersey",
"state": "vero",
"country": "country",
"currency": "USD",
"enableCoupons": "no",
"enableTaxes": "no",
"zipcode": "08053",
"selling_location": "all_countries"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Settings Updated"
}Request
PUT
api/settings/ecommerce/general
Body Parameters
addressLine1 string
Address line1 of user.
addressLine2 string optional
Address line2 of user. Example:
city string
City of the user.
state string
State of the user. Example:
country string
Country of the user.
currency string
Currency of the user's country.
enableCoupons string
If yes, coupons gets enabled for users.
enableTaxes string
If yes, taxes gets enabled for users.
zipcode string
Zipcode of the location of users.
selling_location string optional
Selling location.
Retrieves Shop Base Currency
Retrieves the currency set in the Ecommerce settings.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/get-shop-base-currency" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/get-shop-base-currency"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"display_name": "United States (US) dollar",
"symbol": "$"
}Request
GET
api/get-shop-base-currency
Endpoints
Display a listing of the resource.
Example request:
curl -X POST \
"https://demo.aomlms.com/api/dbmod" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/dbmod"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Request
POST
api/dbmod
api/class/tabularlist
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/class/tabularlist" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/class/tabularlist"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/class/tabularlist
api/class/get-class-schedules
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/class/get-class-schedules" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/class/get-class-schedules"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/class/get-class-schedules
api/class/create
Example request:
curl -X POST \
"https://demo.aomlms.com/api/class/create" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/class/create"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Request
POST
api/class/create
api/class/edit
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/class/edit" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/class/edit"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/class/edit
api/class/update
Example request:
curl -X POST \
"https://demo.aomlms.com/api/class/update" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/class/update"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Request
POST
api/class/update
api/class/get-course-classes
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/class/get-course-classes" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/class/get-course-classes"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/class/get-course-classes
api/class/enroll/{id}
Example request:
curl -X POST \
"https://demo.aomlms.com/api/class/enroll/{id}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/class/enroll/{id}"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Request
POST
api/class/enroll/{id}
api/class/enrolled-students
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/class/enrolled-students" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/class/enrolled-students"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/class/enrolled-students
api/class/update-class-status
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/class/update-class-status" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/class/update-class-status"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/class/update-class-status
api/class/remove/{id}
Example request:
curl -X POST \
"https://demo.aomlms.com/api/class/remove/{id}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/class/remove/{id}"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Request
POST
api/class/remove/{id}
api/class/assignCertificate/{id}
Example request:
curl -X POST \
"https://demo.aomlms.com/api/class/assignCertificate/{id}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/class/assignCertificate/{id}"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Request
POST
api/class/assignCertificate/{id}
api/class/study-material
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/class/study-material" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/class/study-material"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/class/study-material
api/class/delete
Example request:
curl -X POST \
"https://demo.aomlms.com/api/class/delete" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/class/delete"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Request
POST
api/class/delete
api/class/webinar/details
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/class/webinar/details" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/class/webinar/details"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/class/webinar/details
api/class/reports/class-detailed
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/class/reports/class-detailed" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/class/reports/class-detailed"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/class/reports/class-detailed
api/class/reports/overview
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/class/reports/overview" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/class/reports/overview"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/class/reports/overview
api/class/webinar/launch
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/class/webinar/launch" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/class/webinar/launch"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/class/webinar/launch
api/locations/lookup
Example request:
curl -X POST \
"https://demo.aomlms.com/api/locations/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/locations/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Request
POST
api/locations/lookup
api/location/create
Example request:
curl -X POST \
"https://demo.aomlms.com/api/location/create" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/location/create"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Request
POST
api/location/create
api/location/tabularlist
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/location/tabularlist" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/location/tabularlist"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/location/tabularlist
api/location/{id}
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/location/{id}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/location/{id}"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/location/{id}
api/location/{id}
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/location/{id}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/location/{id}"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Request
PUT
api/location/{id}
api/location/delete
Example request:
curl -X POST \
"https://demo.aomlms.com/api/location/delete" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/location/delete"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Request
POST
api/location/delete
api/badges/tabularlist
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/badges/tabularlist" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/badges/tabularlist"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/badges/tabularlist
api/badge/create
Example request:
curl -X POST \
"https://demo.aomlms.com/api/badge/create" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/badge/create"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Request
POST
api/badge/create
api/badges/defaultBadgeLookUp
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/badges/defaultBadgeLookUp" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/badges/defaultBadgeLookUp"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/badges/defaultBadgeLookUp
api/badge/{id}
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/badge/{id}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/badge/{id}"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/badge/{id}
api/badge/{id}
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/badge/{id}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/badge/{id}"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Request
PUT
api/badge/{id}
api/badge/delete
Example request:
curl -X POST \
"https://demo.aomlms.com/api/badge/delete" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/badge/delete"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Request
POST
api/badge/delete
api/badge/share
Example request:
curl -X POST \
"https://demo.aomlms.com/api/badge/share" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/badge/share"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Request
POST
api/badge/share
api/leaderboard/tabularlist
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/leaderboard/tabularlist" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/leaderboard/tabularlist"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/leaderboard/tabularlist
api/leaderboard/create
Example request:
curl -X POST \
"https://demo.aomlms.com/api/leaderboard/create" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/leaderboard/create"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Request
POST
api/leaderboard/create
api/leaderboard/{id}
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/leaderboard/{id}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/leaderboard/{id}"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/leaderboard/{id}
api/leaderboard/{id}
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/leaderboard/{id}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/leaderboard/{id}"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Request
PUT
api/leaderboard/{id}
api/leaderboard/delete/{id}
Example request:
curl -X POST \
"https://demo.aomlms.com/api/leaderboard/delete/{id}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/leaderboard/delete/{id}"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Request
POST
api/leaderboard/delete/{id}
api/gamification_events/tabularlist
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/gamification_events/tabularlist" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/gamification_events/tabularlist"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/gamification_events/tabularlist
api/gamification_events/eventTypeLookUp
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/gamification_events/eventTypeLookUp" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/gamification_events/eventTypeLookUp"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/gamification_events/eventTypeLookUp
api/gamification_event/create
Example request:
curl -X POST \
"https://demo.aomlms.com/api/gamification_event/create" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/gamification_event/create"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Request
POST
api/gamification_event/create
api/gamification_event/{id}
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/gamification_event/{id}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/gamification_event/{id}"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/gamification_event/{id}
api/gamification_event/{id}
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/gamification_event/{id}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/gamification_event/{id}"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Request
PUT
api/gamification_event/{id}
api/gamification_event/delete/{id}
Example request:
curl -X POST \
"https://demo.aomlms.com/api/gamification_event/delete/{id}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/gamification_event/delete/{id}"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Request
POST
api/gamification_event/delete/{id}
Front End Webhook API
Endpoints for Front end Marketing Pages. Send automated notifications to external system when some action happens.
Webhook Actions Lookup
Retrieves all the events for the webhook actions. Helps showing options in dropdowns elements
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/integrations/webhook/eventLookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/integrations/webhook/eventLookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"db_value": "new_account_created",
"display_value": "New Account Created"
},
{
"db_value": "course_enrolled",
"display_value": "Enrolled in a course"
},
{
"db_value": "quiz_submission",
"display_value": "Submitted a Quiz"
},
{
"db_value": "assigment_submission",
"display_value": "Submitted an assignment"
},
{
"db_value": "assigment_evaluation",
"display_value": "Evaluated an assignment"
},
{
"db_value": "assigment_rejection",
"display_value": "Rejected an assignment"
},
{
"db_value": "discussion_submission",
"display_value": "Submitted a discussion"
},
{
"db_value": "new_order",
"display_value": "New Order Placed"
},
{
"db_value": "failed_order",
"display_value": "Order Failed"
},
{
"db_value": "refunded_order",
"display_value": "Order Refunded"
},
{
"db_value": "pending_payment",
"display_value": "Payment Pending"
},
{
"db_value": "new_announcement",
"display_value": "New Announcement"
},
{
"db_value": "course_completed",
"display_value": "Course Completed"
}
]Request
GET
api/integrations/webhook/eventLookup
Create Webhook
To create a Webhook, you need to use this request. Provide url and select event and it will be created. (See parameters)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/webhook/create" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"url":"https:\/\/example.aom","description":"It will use to collect new user data.","eventList":"New Account Created"}'
const url = new URL(
"https://demo.aomlms.com/api/webhook/create"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"url": "https:\/\/example.aom",
"description": "It will use to collect new user data.",
"eventList": "New Account Created"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": "2",
"message": "Webhook saved successfully"
}Request
POST
api/webhook/create
Body Parameters
url string
Endpoint to send the data.
description string optional
Description of the event that is being created.
eventList string
Event from the option list. Event options: new_account_created, course_enrolled, quiz_submission, assigment_submission, assigment_evaluation, assigment_rejection, discussion_submission, new_order, failed_order, refunded_order, pending_payment, new_announcement or course_completed.
Webhook Actions Tabular List
Returns all the Webhook created in a tabular list format. You can apply filter using search_param.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/webhooks?order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22search_param%22%3A%22new_account_created%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/webhooks"
);
let params = {
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"search_param":"new_account_created"}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 4,
"recordsFiltered": 3,
"records": [
{
"id": 3,
"url": "https:\/\/example.aom.com",
"events": "New Account Created",
"description": "User new account created",
"author": "Client Admin",
"created_at": "Aug 10, 2020 12:43 PM"
},
{
"id": 4,
"url": "https:\/\/example.aom.com",
"events": "Enrolled in a course",
"description": "User enrolled in a course",
"author": "Client Admin",
"created_at": "Aug 10, 2020 12:43 PM"
}
]
}Request
GET
api/webhooks
Query Parameters
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on Events.
Update Webhook
Updates a webhook using parameters mentioned. (See parameters) Updates the webhook details using webhook ID.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/webhook/3" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"url":"https:\/\/example.aom","description":"It will use to collect new user data.","eventList":"New Account Created"}'
const url = new URL(
"https://demo.aomlms.com/api/webhook/3"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"url": "https:\/\/example.aom",
"description": "It will use to collect new user data.",
"eventList": "New Account Created"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": "4",
"message": "Webhook updated successfully"
}Request
PUT
api/webhook/{id}
URL Parameters
id string
ID of the webhook.
Body Parameters
url string
Endpoint to send the data.
description string optional
Description of the event that is being created.
eventList string
Event from the option list. Event options: new_account_created, course_enrolled, quiz_submission, assigment_submission, assigment_evaluation, assigment_rejection, discussion_submission, new_order, failed_order, refunded_order, pending_payment, new_announcement or course_completed.
Delete Webhook
To delete a webhook, you need to use this request.
Example request:
curl -X DELETE \
"https://demo.aomlms.com/api/webhook/delete/[1]" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/webhook/delete/[1]"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "DELETE",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Webhook deleted successfully"
}Request
DELETE
api/webhook/delete/{id}
URL Parameters
id string
Webhook ID which needs to be deleted.
Webhook log Tabular List
Returns all the webhook log in a tabular list format in paginated mode.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/webhook/logs/{id}?page_size=9&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/webhook/logs/{id}"
);
let params = {
"page_size": "9",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 4,
"recordsFiltered": 1,
"records": [
{
"id": 4,
"event": "New Account Created",
"status": "success",
"created_at": "Aug 10, 2020 01:58 PM"
}
]
}Request
GET
api/webhook/logs/{id}
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
General Settings
General Settings helps in managing general platform settings like site name, timezone, emails etc
Retrieve General Email Settings
Retrieves the details of the general email items. Helps in fetching items of the email settings, items like header, sender name, sender email, etc(See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/settings/emails/general" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/settings/emails/general"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"fromName": "Academy of Mine",
"fromEmail": "[email protected]",
"replyToEmail": "[email protected]",
"templateDesign": "default",
"headerLogo": "Default",
"customHeaderLogoURL": "",
"headerBgColor": "#6b15b6",
"bgColor": "#ffffff",
"bodyBgColor": "#f6f9fc",
"bodyTextColor": "#1b1e24"
}Request
GET
api/settings/emails/general
Set General Email Settings
To save the general email settings with updated values, you need to use this request. (See parameters)
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/settings/emails/general" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"fromName":"Academy of Mine","fromEmail":"[email protected]","replyToEmail":"[email protected]","templateDesign":"default","headerLogo":"Default","customHeaderLogoURL":"null","headerBgColor":"#6b15b6","bgColor":"#ffffff","bodyBgColor":"#f6f9fc","bodyTextColor":"#1b1e24"}'
const url = new URL(
"https://demo.aomlms.com/api/settings/emails/general"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"fromName": "Academy of Mine",
"fromEmail": "[email protected]",
"replyToEmail": "[email protected]",
"templateDesign": "default",
"headerLogo": "Default",
"customHeaderLogoURL": "null",
"headerBgColor": "#6b15b6",
"bgColor": "#ffffff",
"bodyBgColor": "#f6f9fc",
"bodyTextColor": "#1b1e24"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Settings Updated"
}Request
PUT
api/settings/emails/general
Body Parameters
fromName string
Sender name of the email.
fromEmail string
Sender email.
replyToEmail string
Reply email for emails.
templateDesign string
Template design.
headerLogo string
Header logo of the email.
customHeaderLogoURL string optional
Custom header logo.
headerBgColor string
Header background color of the email(in hex form).
bgColor string
Background color of the email.
bodyBgColor string
Body background color of the email.
bodyTextColor string
Text color of email body.
Set General Email Settings
To save the general email settings with updated values, you need to use this request. (See parameters)
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/settings/edit-template" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"content":"Hi This email is from AOM.","enabled":true,"subject":"This is subject","recipients":"null","heading":"New Account Created","type":"new_account_creation"}'
const url = new URL(
"https://demo.aomlms.com/api/settings/edit-template"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"content": "Hi This email is from AOM.",
"enabled": true,
"subject": "This is subject",
"recipients": "null",
"heading": "New Account Created",
"type": "new_account_creation"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Template Updated Successfully"
}Request
PUT
api/settings/edit-template
Body Parameters
content string optional
Content of the email(body).
enabled boolean
If true, this email format is enabled to sent email on events.
subject string
Subject for email.
recipients string
Email recipients.
heading string
Heading of the email.
type string
Which email format is about to get sent.
Retrieve General Settings
Retrieves the details of the general items. Helps in fetching items of the settings, items like site title, admin email, date and time format(See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/settings/general" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/settings/general"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"siteTitle": "Academy of mine",
"adminEmail": "[email protected]",
"siteLanguage": "en",
"timeZone": "0",
"dateFormat": "M d, Y",
"timeFormat": "h:i A",
"privateSite": "no",
"customTimeZone": "",
"homePage": "1",
"productCatalogPage": "2",
"cartPage": "5",
"checkoutPage": "4",
"termConditionPage": "2",
"termConditionText": "I have read and agree to the website.",
"privacyPolicyPage": "3",
"privacyPolicyText": "Your personal data will be used to process your order, support your experience throughout this website, and for other purposes described in our privacy policy."
}Request
GET
api/settings/general
api/settings/customTimezone
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/settings/customTimezone" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/settings/customTimezone"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/settings/customTimezone
Update General Settings
To update the general settings with updated values, you need to use this request. (See parameters)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/settings/general" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"siteTitle":"Academy of mine","adminEmail":"[email protected]","siteLanguage":"en","timeZone":"null","dateFormat":"M d, Y","timeFormat":"h:i A","privateSite":"no","customTimeZone":"id","homePage":"1","productCatalogPage":2,"cartPage":5,"checkoutPage":"4","termConditionPage":3,"termConditionText":"I have read and agree to the website term.","privacyPolicyPage":2,"privacyPolicyText":"Your personal data will be used to process your order, support your experience throughout this website, and for other purposes described in our privacy policy."}'
const url = new URL(
"https://demo.aomlms.com/api/settings/general"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"siteTitle": "Academy of mine",
"adminEmail": "[email protected]",
"siteLanguage": "en",
"timeZone": "null",
"dateFormat": "M d, Y",
"timeFormat": "h:i A",
"privateSite": "no",
"customTimeZone": "id",
"homePage": "1",
"productCatalogPage": 2,
"cartPage": 5,
"checkoutPage": "4",
"termConditionPage": 3,
"termConditionText": "I have read and agree to the website term.",
"privacyPolicyPage": 2,
"privacyPolicyText": "Your personal data will be used to process your order, support your experience throughout this website, and for other purposes described in our privacy policy."
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Settings Updated"
}Request
POST
api/settings/general
Body Parameters
siteTitle string
Title of the site.
adminEmail string
Email of the admin.
siteLanguage string
Language of the site.
timeZone string
Timezone of the site.
dateFormat string
Format of the date for site.
timeFormat string
Format of the time for site.
privateSite string
Is the site private or not.
customTimeZone string
Custom timezone for site. Example:
homePage string optional
int Homepage for site(page Id).
productCatalogPage integer
Product catalog page for site(page Id).
cartPage integer
Cart page for site(page Id).
checkoutPage string
Checkout page for site(page Id).
termConditionPage integer
Term and Condition page for the site(page Id).
termConditionText string
Term and Condition Text of the site.
privacyPolicyPage integer
Privacy Policy page for the site(page Id).
privacyPolicyText string
Privacy Policy Text of the site.
Retrieve Branding Settings
Retrieves the details of the brand settings. Helps in fetching items of the brand settings, items like primary color, body color, logo footer text(See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/settings/branding" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/settings/branding"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"brandColors": {
"primaryColor": "#6b15b6",
"bodyBgColor": "#f6f9fc",
"bodyColor": "#1b1e24"
},
"logo": "",
"logoMini": "",
"topBarEmail": "[email protected]",
"topBarPhone": "+1-202-555-0189",
"footerText": "Copyright © Your Company Name - All rights reserved."
}Request
GET
api/settings/branding
Update Branding Settings
To update the branding settings with updated values, you need to use this request. (See parameters)
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/settings/branding" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"brandColors":"{primaryColor: \"#6b15b6\", bodyBgColor: \"#f6f9fc\", bodyColor: \"#1b1e24\"}","footerText":"Copyright © Your Company Name - All rights reserved.","logo":"sed","logoMini":"non","shouldCompileTheme":false,"topBarEmail":"[email protected]","topBarPhone":"1234567890"}'
const url = new URL(
"https://demo.aomlms.com/api/settings/branding"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"brandColors": "{primaryColor: \"#6b15b6\", bodyBgColor: \"#f6f9fc\", bodyColor: \"#1b1e24\"}",
"footerText": "Copyright © Your Company Name - All rights reserved.",
"logo": "sed",
"logoMini": "non",
"shouldCompileTheme": false,
"topBarEmail": "[email protected]",
"topBarPhone": "1234567890"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Branding Settings Updated"
}Request
PUT
api/settings/branding
Body Parameters
brandColors array
Brand colors for the site(body, background, primary colors).
footerText string
Footer text for the site.
logo string optional
Logo for the site. Example:
logoMini string optional
Mini Logo for the site. Example:
shouldCompileTheme boolean
Should the theme be compiled.
topBarEmail string
Topbar email for site.
topBarPhone string
Topbar phone number for site.
Retrieve Custom Stylings
Retrieves the details of the custom styles being added in the platform.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/settings/customstyle" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/settings/customstyle"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"custom_css": ""
}Request
GET
api/settings/customstyle
Set Custom Stylings
To set or update the custom stylings with updated values, you need to use this request. (See parameters)
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/settings/customstyle" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"custom_css":"body: {color: red;}"}'
const url = new URL(
"https://demo.aomlms.com/api/settings/customstyle"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"custom_css": "body: {color: red;}"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Custom Styling Saved Successfully"
}Request
PUT
api/settings/customstyle
Body Parameters
custom_css string optional
Custom styling CSS code snippets.
Update Email Status
Updates the status of the email if the selected area of the email format as enabled or not. If disabled, the students will not get any email from this platform for selected email format area(account, lms, ecommerce, etc) and type (account creation, enrollments, etc)
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/settings/update-state" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"area":"account","isEnabled":false,"type":"new_account_creation"}'
const url = new URL(
"https://demo.aomlms.com/api/settings/update-state"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"area": "account",
"isEnabled": false,
"type": "new_account_creation"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{}Request
PUT
api/settings/update-state
Body Parameters
area string
Which email format is going to get enabled or disabled.
isEnabled boolean
If true, the select email format area will get enabled otherwise disabled.
type string
Which type of email format will get disabled or enabled.
Retrieve Course| Product| Users
Search bar in home page to show profession hint,industry hint and state hint as well. Retrieves all details regarding courses, product and users for homepage.
Example request:
curl -X POST \
"https://demo.aomlms.com/api/generic-search" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/generic-search"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"label": "Courses",
"options": [
{
"label": "Manage - course 1",
"value": "\/dashboard\/course\/manage\/1"
},
{
"label": "Manage - Awesome Course",
"value": "\/dashboard\/course\/manage\/2"
},
{
"label": "Manage - course 1_copy",
"value": "\/dashboard\/course\/manage\/3"
}
]
},
{
"label": "Users",
"options": [
{
"label": "Aom Staff([email protected])",
"value": "\/dashboard\/user\/edit\/1"
},
{
"label": "Client Admin([email protected])",
"value": "\/dashboard\/user\/edit\/2"
},
{
"label": "Demo Student([email protected])",
"value": "\/dashboard\/user\/edit\/3"
},
{
"label": "John Doe([email protected])",
"value": "\/dashboard\/user\/edit\/12"
},
{
"label": "Fake FName Fake LName([email protected])",
"value": "\/dashboard\/user\/edit\/13"
},
{
"label": "Fake FName 2 Fake LName 2([email protected])",
"value": "\/dashboard\/user\/edit\/14"
}
]
},
{
"label": "Courses",
"options": [
{
"label": "Edit - course 1",
"value": "\/dashboard\/course\/edit\/1"
},
{
"label": "Edit - Awesome Course",
"value": "\/dashboard\/course\/edit\/2"
},
{
"label": "Edit - course 1_copy",
"value": "\/dashboard\/course\/edit\/3"
}
]
},
{
"label": "Products",
"options": [
{
"label": "Product-1",
"value": "\/dashboard\/product\/edit\/1"
}
]
},
{
"label": "Modules",
"options": [
{
"label": "test",
"value": "\/dashboard\/modules\/edit\/1"
},
{
"label": "assignment 1",
"value": "\/dashboard\/modules\/edit\/2"
},
{
"label": "Video Module Name",
"value": "\/dashboard\/modules\/edit\/3"
},
{
"label": "assign",
"value": "\/dashboard\/modules\/edit\/4"
},
{
"label": "The Fundamentals of LMS",
"value": "\/dashboard\/modules\/edit\/5"
},
{
"label": "Getting Started",
"value": "\/dashboard\/modules\/edit\/6"
},
{
"label": "First-quiz",
"value": "\/dashboard\/modules\/edit\/7"
},
{
"label": "Quiz-2",
"value": "\/dashboard\/modules\/edit\/8"
},
{
"label": "My-video-lesson",
"value": "\/dashboard\/modules\/edit\/9"
},
{
"label": "Essay on LMS",
"value": "\/dashboard\/modules\/edit\/10"
},
{
"label": "File-based-Assignment",
"value": "\/dashboard\/modules\/edit\/11"
},
{
"label": "New-Webinar",
"value": "\/dashboard\/modules\/edit\/12"
},
{
"label": "First-discussion",
"value": "\/dashboard\/modules\/edit\/13"
},
{
"label": "Lesson-1",
"value": "\/dashboard\/modules\/edit\/14"
},
{
"label": "Feedback",
"value": "\/dashboard\/modules\/edit\/15"
}
]
}
]Request
POST
api/generic-search
api/settings/gamification
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/settings/gamification" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/settings/gamification"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/settings/gamification
api/settings/gamification
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/settings/gamification" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/settings/gamification"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Request
PUT
api/settings/gamification
Groups
A group can be used to couple course and seats for admins. Endpoints helps in performing CRUD operation for and to groups
Group Tabular List
Returns all the groups in a tabular list format in paginated mode. You can apply filter using search_param via adminNameorEmail and groupName.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/groups/tabularlist?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22adminNameorEmail%22%3A%22%22%2C%22groupName%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/groups/tabularlist"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"adminNameorEmail":"","groupName":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"id": 1,
"name": "New-group",
"referralCode": "ref-code123",
"createdBy": "Aom Staff",
"createdAt": "Aug 11, 2020",
"admins": "John Doe",
"totalStudents": 0
}
]
}Request
GET
api/groups/tabularlist
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
for searching items based on field names.
Group Lookup
Retrieves all the groups in list format. Helps while showing groups in form elements like dropdown.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/groups/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/groups/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"id": 1,
"name": "New-group"
}
]Request
GET
api/groups/lookup
Retrieve Group Students List
Returns all the students related to this group in a tabular list format in paginated mode. You can apply filter using search_param via nameOrEmail.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/group/students/1?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22nameOrEmail%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/group/students/1"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"nameOrEmail":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"groupName": "New-group",
"recordsTotal": 2,
"recordsFiltered": 2,
"records": [
{
"id": 13,
"first_name": "Fake FName",
"last_name": "Fake LName",
"email": "[email protected]",
"avatar": "<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"40\" height=\"40\" viewBox=\"0 0 40 40\"><circle cx=\"20\" cy=\"20\" r=\"20\" stroke=\"background\" stroke-width=\"0\" fill=\"#00BCD4\" \/><text x=\"20\" y=\"20\" font-size=\"14\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">FF<\/text><\/svg>",
"stats": {
"notStarted": 1,
"inProgress": 0,
"completed": 0,
"total": 1
},
"last_login": "Never"
},
{
"id": 14,
"first_name": "Fake FName 2",
"last_name": "Fake LName 2",
"email": "[email protected]",
"avatar": "<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"40\" height=\"40\" viewBox=\"0 0 40 40\"><circle cx=\"20\" cy=\"20\" r=\"20\" stroke=\"background\" stroke-width=\"0\" fill=\"#03A9F4\" \/><text x=\"20\" y=\"20\" font-size=\"14\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">FF<\/text><\/svg>",
"stats": {
"notStarted": 1,
"inProgress": 0,
"completed": 0,
"total": 1
},
"last_login": "Never"
}
]
}Request
GET
api/group/students/{id}
URL Parameters
id string
ID of the group.
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on field names.
Retrieve Group Course List
Returns all the courses related to this group in a tabular list format in paginated mode. You can apply filter using search_param via name(course name).
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/group/courses/1?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22nameOrEmail%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/group/courses/1"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"nameOrEmail":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"groupName": "New-group",
"recordsTotal": 1,
"recordsFiltered": 1,
"records": []
}Request
GET
api/group/courses/{id}
URL Parameters
id string
ID of the group.
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on field names.
Create Group
To create a group, you need to use this request. (See parameters) Created group is being used as to couple course to students with limited seats.
Returns : id of the group created and successfull message
Example request:
curl -X POST \
"https://demo.aomlms.com/api/group/create" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"New-group","referralCode":"ref-code123","brandColor":"null","logoUrl":"null","userAddChoice":"newUser","existingUserId":0,"courseSeats":[],"membershipSeat":"[{id: 1, name: \"membership-plan 1\", seats: 120}]"}'
const url = new URL(
"https://demo.aomlms.com/api/group/create"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "New-group",
"referralCode": "ref-code123",
"brandColor": "null",
"logoUrl": "null",
"userAddChoice": "newUser",
"existingUserId": 0,
"courseSeats": [],
"membershipSeat": "[{id: 1, name: \"membership-plan 1\", seats: 120}]"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 1,
"message": "Group created successfully"
}Request
POST
api/group/create
Body Parameters
name string
Name of the group.
referralCode string
Referral code for the course.
brandColor string optional
Brand color for the group.
logoUrl string optional
Logo URL for the group images.
userAddChoice string
Type of user adding option(newUser or existingUser).
existingUserId integer optional
Existing user Id.
courseSeats array optional
The courses which are being added to this group and how many seats for each course.
membershipSeat object optional
which membership is being added to this group and how many seats for the membership.
Retrieve Group
Retrieves the details of the specified group. Helps in fetching group using its ID. (See Parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/group/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/group/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "New-group",
"referralCode": "ref-code123",
"brandColor": null,
"logoUrl": null,
"admins": [
{
"id": 12,
"fullName": "John Doe",
"email": "[email protected]",
"avatar": "<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"40\" height=\"40\" viewBox=\"0 0 40 40\"><circle cx=\"20\" cy=\"20\" r=\"20\" stroke=\"background\" stroke-width=\"0\" fill=\"#03A9F4\" \/><text x=\"20\" y=\"20\" font-size=\"14\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">JD<\/text><\/svg>"
}
],
"courseSeats": [
{
"id": 1,
"courseId": 1,
"courseName": "course 1",
"totalSeats": 120,
"usedSeats": 0
}
],
"catalogUrl": "\/course-catalog"
}Request
GET
api/group/{id}
URL Parameters
id string
ID of the group you want to fetch the details of.
Update Group
Updates the details of a specified group. (See parameters) Group is being used as to couple course to students with limited seats.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/group/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"New-group","referralCode":"ref-code123","brandColor":"null","logoUrl":"null","userAddChoice":"newUser","existingUserId":0,"courseSeats":[],"membershipSeat":"[{id: 1, name: \"membership-plan 2\", seats: 110}]"}'
const url = new URL(
"https://demo.aomlms.com/api/group/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "New-group",
"referralCode": "ref-code123",
"brandColor": "null",
"logoUrl": "null",
"userAddChoice": "newUser",
"existingUserId": 0,
"courseSeats": [],
"membershipSeat": "[{id: 1, name: \"membership-plan 2\", seats: 110}]"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 1,
"message": "Group created successfully"
}Request
PUT
api/group/{id}
URL Parameters
id string
ID of the group.
Body Parameters
name string
Name of the group.
referralCode string
Referral code for the course.
brandColor string optional
Brand color for the group.
logoUrl string optional
Logo URL for the group images.
userAddChoice string
Type of user adding option(newUser or existingUser).
existingUserId integer optional
Existing user Id.
courseSeats array optional
The courses which are being added to this group and how many seats for each course.
membershipSeat object optional
which membership is being added to this group and how many seats for the membership.
Update Group Registration And Login Slug
Updates the slug using parameters mentioned. (See parameters)
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/group/update-slug/3" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"area":"login","login_slug":"group-login","registration_slug":"group-registration"}'
const url = new URL(
"https://demo.aomlms.com/api/group/update-slug/3"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"area": "login",
"login_slug": "group-login",
"registration_slug": "group-registration"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Slug updated successfully"
}Request
PUT
api/group/update-slug/{id}
URL Parameters
id string
ID of the group.
Body Parameters
area string
Login or Registration.
login_slug string
Login slug of the group.
registration_slug string
Registration slug of the group.
Group Admin Permissions Lookup
Retrieves all the operations a group admin can perform in list format. Helps while creating group to set permissions for group admins.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/group-permissions" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/group-permissions"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"db_value": "can_view_course_activities",
"display_value": "Can View Course Activities"
},
{
"db_value": "can_view_course_submissions",
"display_value": "Can View Course Submissions"
},
{
"db_value": "can_remove_student_from_course",
"display_value": "Can Remove Student from the Course"
},
{
"db_value": "can_revoke_student_access_from_course",
"display_value": "Can Revoke Students Access from the Course"
},
{
"db_value": "can_grant_student_access_to_course",
"display_value": "Can Grant Access to Course"
},
{
"db_value": "can_reset_student_progress_in_course",
"display_value": "Can Reset Students Progress"
},
{
"db_value": "can_assign_certificate_to_student",
"display_value": "Can Assign Certificate to Student"
},
{
"db_value": "can_update_expiration_date",
"display_value": "Can Update Course Expiration Date"
},
{
"db_value": "can_enroll_student_in_a_course",
"display_value": "Can Enroll Student in a Course"
},
{
"db_value": "can_bulk_enroll_students",
"display_value": "Can Bulk Enroll Students in a Course"
},
{
"db_value": "can_view_student_profile",
"display_value": "Can View Students Profile"
},
{
"db_value": "can_view_student_orders",
"display_value": "Can View Students Orders"
},
{
"db_value": "can_view_student_activities",
"display_value": "Can View Students Activities"
},
{
"db_value": "can_view_student_certificates",
"display_value": "Can View Students Certificates"
},
{
"db_value": "can_switch_to_user",
"display_value": "Can Switch to a user"
},
{
"db_value": "can_view_student_progress",
"display_value": "Can View Students Progress"
},
{
"db_value": "can_download_certificate",
"display_value": "Can Download Students Certificates"
},
{
"db_value": "can_delete_student",
"display_value": "Can Delete a student"
},
{
"db_value": "can_lock_student_account",
"display_value": "Can Lock a Students Account"
},
{
"db_value": "can_view_student_courses",
"display_value": "Can View Students Courses"
},
{
"db_value": "can_update_student_password",
"display_value": "Can Update Students Password"
},
{
"db_value": "can_update_student_personal_details",
"display_value": "Can Update Students Personal Details"
},
{
"db_value": "can_view_student_address",
"display_value": "Can View Student Address"
},
{
"db_value": "can_update_student_address",
"display_value": "Can Update Students Address"
},
{
"db_value": "can_add_student_address",
"display_value": "Can Add a New Billing Address for Student"
},
{
"db_value": "can_view_as_student",
"display_value": "Can have the ability to view the platform as Student"
},
{
"db_value": "can_remove_student_certificate",
"display_value": "Can Remove Students Certificate"
},
{
"db_value": "can_edit_student_certificate",
"display_value": "Can Edit Students Certificate"
},
{
"db_value": "can_enroll_student",
"display_value": "Can Enroll Single Student"
},
{
"db_value": "can_update_group_basic_detail",
"display_value": "Can Update Groups Basic Details"
},
{
"db_value": "can_update_group_admin",
"display_value": "Can Update Group Admin"
}
]Request
GET
api/group-permissions
Group Admin Permissions
Retrieves all the operations a group admin can perform as set by admin.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/get/group-permissions" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/get/group-permissions"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"db_value": "can_view_course_activities",
"display_value": "Can View Course Activities"
},
{
"db_value": "can_view_course_submissions",
"display_value": "Can View Course Submissions"
},
{
"db_value": "can_remove_student_from_course",
"display_value": "Can Remove Student from the Course"
},
{
"db_value": "can_revoke_student_access_from_course",
"display_value": "Can Revoke Students Access from the Course"
},
{
"db_value": "can_grant_student_access_to_course",
"display_value": "Can Grant Access to Course"
},
{
"db_value": "can_reset_student_progress_in_course",
"display_value": "Can Reset Students Progress"
},
{
"db_value": "can_assign_certificate_to_student",
"display_value": "Can Assign Certificate to Student"
},
{
"db_value": "can_update_expiration_date",
"display_value": "Can Update Course Expiration Date"
},
{
"db_value": "can_enroll_student_in_a_course",
"display_value": "Can Enroll Student in a Course"
},
{
"db_value": "can_bulk_enroll_students",
"display_value": "Can Bulk Enroll Students in a Course"
},
{
"db_value": "can_view_student_profile",
"display_value": "Can View Students Profile"
},
{
"db_value": "can_view_student_orders",
"display_value": "Can View Students Orders"
},
{
"db_value": "can_view_student_activities",
"display_value": "Can View Students Activities"
},
{
"db_value": "can_view_student_certificates",
"display_value": "Can View Students Certificates"
},
{
"db_value": "can_switch_to_user",
"display_value": "Can Switch to a user"
},
{
"db_value": "can_view_student_progress",
"display_value": "Can View Students Progress"
},
{
"db_value": "can_download_certificate",
"display_value": "Can Download Students Certificates"
},
{
"db_value": "can_delete_student",
"display_value": "Can Delete a student"
},
{
"db_value": "can_lock_student_account",
"display_value": "Can Lock a Students Account"
},
{
"db_value": "can_view_student_courses",
"display_value": "Can View Students Courses"
},
{
"db_value": "can_update_student_password",
"display_value": "Can Update Students Password"
},
{
"db_value": "can_update_student_personal_details",
"display_value": "Can Update Students Personal Details"
},
{
"db_value": "can_view_student_address",
"display_value": "Can View Student Address"
},
{
"db_value": "can_update_student_address",
"display_value": "Can Update Students Address"
},
{
"db_value": "can_add_student_address",
"display_value": "Can Add a New Billing Address for Student"
},
{
"db_value": "can_view_as_student",
"display_value": "Can have the ability to view the platform as Student"
},
{
"db_value": "can_remove_student_certificate",
"display_value": "Can Remove Students Certificate"
},
{
"db_value": "can_edit_student_certificate",
"display_value": "Can Edit Students Certificate"
},
{
"db_value": "can_enroll_student",
"display_value": "Can Enroll Single Student"
},
{
"db_value": "can_update_group_basic_detail",
"display_value": "Can Update Groups Basic Details"
},
{
"db_value": "can_update_group_admin",
"display_value": "Can Update Group Admin"
}
]Request
GET
api/get/group-permissions
Update Group Admin Permissions
Updates a Group Admin Permissions using parameters mentioned.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/group-permission/update" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"permissions":"https:\/\/example.aom"}'
const url = new URL(
"https://demo.aomlms.com/api/group-permission/update"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"permissions": "https:\/\/example.aom"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Group Permission Updated Successfully."
}Request
PUT
api/group-permission/update
Body Parameters
permissions array
Send Group Permission in array format .
Group Membership Course Tabular List
Returns all the courses of a membership in a group.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/group/membership/courses/1?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22nameOrEmail%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/group/membership/courses/1"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"nameOrEmail":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"groupName": "Group One",
"membership": {
"id": 1,
"name": "Membership"
},
"recordsTotal": 4,
"recordsFiltered": 4,
"records": [
{
"id": 1,
"name": "Professional Development and Training",
"total_seats": 2,
"used_seats": 0,
"stats": {
"notStarted": 0,
"inProgress": 0,
"completed": 0,
"total": 0
},
"last24hCount": 0,
"membershipId": 1
},
{
"id": 2,
"name": "Advanced Professional Development",
"total_seats": 2,
"used_seats": 0,
"stats": {
"notStarted": 0,
"inProgress": 0,
"completed": 0,
"total": 0
},
"last24hCount": 0,
"membershipId": 1
},
{
"id": 3,
"name": "Introduction to Continuing Education",
"total_seats": 2,
"used_seats": 0,
"stats": {
"notStarted": 0,
"inProgress": 0,
"completed": 0,
"total": 0
},
"last24hCount": 0,
"membershipId": 1
},
{
"id": 4,
"name": "Training your Employees for the modern world",
"total_seats": 2,
"used_seats": 0,
"stats": {
"notStarted": 0,
"inProgress": 0,
"completed": 0,
"total": 0
},
"last24hCount": 0,
"membershipId": 1
}
]
}Request
GET
api/group/membership/courses/{id}
URL Parameters
id string
ID of the group.
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on field names.
Group Membership Module Tabular List
Returns all the modules of a membership in a group.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/group/membership/modules/1?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22nameOrEmail%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/group/membership/modules/1"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"nameOrEmail":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"groupName": "Group One",
"membership": {
"id": 1,
"name": "Membership"
},
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"id": 1,
"name": "Introduction Text Module",
"type": "text"
}
]
}Request
GET
api/group/membership/modules/{id}
URL Parameters
id string
ID of the group.
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on field names.
Hubspot Integration
It allows you to track student activity and progress in the LMS, and trigger changes in HubSpot data accordingly.
Hubspot Event Lookup
Retrieves all the events for the hubspot actions. Helps showing options in dropdowns elements
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/integrations/hubspot/eventLookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/integrations/hubspot/eventLookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"db_value": "new_account_created",
"display_value": "New Account Created",
"crud_op": "Create",
"hubspot_crud": "[{'db_value' => 'hubspot_contact'},{'display_value'=> 'HubSpot Contact'}]"
},
{
"db_value": "Account Updated",
"display_value": "Account Updated",
"crud_op": "Update",
"hubspot_crud": "[['db_value' => 'hubspot_contact', 'display_value'=> 'HubSpot Contact']]"
},
{
"db_value": "course_enrolled",
"display_value": "Enrolled in a course",
"crud_op": "Update",
"hubspot_crud": "[['db_value' => 'hubspot_contact', 'display_value'=> 'HubSpot Contact']]"
},
{
"db_value": "course_completed",
"display_value": "Course Completed",
"crud_op": "Update",
"hubspot_crud": "[['db_value' => 'hubspot_contact', 'display_value'=> 'HubSpot Contact']]"
},
{
"db_value": "course_started",
"display_value": "Course Started",
"crud_op": "Update",
"hubspot_crud": "[['db_value' => 'hubspot_contact', 'display_value'=> 'HubSpot Contact']]"
},
{
"db_value": "course_progress",
"display_value": "Course Progress Tracking",
"crud_op": "Update",
"hubspot_crud": "[['db_value' => 'hubspot_deal', 'display_value'=> 'HubSpot Deal']]"
}
]Request
GET
api/integrations/hubspot/eventLookup
Hubspot Field Lookup
Retrieves all the fields for the hubspot. Helps showing options in dropdowns elements
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/integrations/hubspot/fieldLookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"type":"contact"}'
const url = new URL(
"https://demo.aomlms.com/api/integrations/hubspot/fieldLookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"type": "contact"
}
fetch(url, {
method: "GET",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"lms_fields": [
{
"db_value": "email"
},
{
"db_value": "last_name"
},
{
"db_value": "first_name"
},
{
"db_value": "last_login_ip"
},
{
"db_value": "is_disabled"
}
]
},
{
"hubspot_fields": [
{
"db_value": "email"
},
{
"db_value": "last_name"
},
{
"db_value": "first_name"
}
]
},
{
"courses": []
}
]Request
GET
api/integrations/hubspot/fieldLookup
Body Parameters
type string
Type to get the data, it can either be contact or deal.
Create Hubspot Action
To create a Hubspot Action, you need to use this request. Provide event,action and object and it will be created. (See parameters)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/hubspot/action/create" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"event":"New Account Created","action":"create.","object":"Hubspot Deal"}'
const url = new URL(
"https://demo.aomlms.com/api/hubspot/action/create"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"event": "New Account Created",
"action": "create.",
"object": "Hubspot Deal"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Action created Successfully"
}Request
POST
api/hubspot/action/create
Body Parameters
event string
Event in which you want to send data.
action string
Action will be create of the event by default.
object string
Select the object from the dropdown list from either Hubspot Deal or Hubspot Contact.
Save Hubspot Mapping
To save a Hubspot Mapping, you need to use this request. Provide type and it will be created. (See parameters)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/hubspot/mapping/save" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"type":"hubspot_contact"}'
const url = new URL(
"https://demo.aomlms.com/api/hubspot/mapping/save"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"type": "hubspot_contact"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"is_success": true,
"message": "Mapping saved Successfully"
}Request
POST
api/hubspot/mapping/save
Body Parameters
type string
Type for which you want to save mapping.
Retrieve Hubspot Mapping
Retrieves the details of the hubspot mapping. Helps in fetching hubspot mapping using its type. (See Parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/hubspot/mappings" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"type":"hubspot_contact"}'
const url = new URL(
"https://demo.aomlms.com/api/hubspot/mappings"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"type": "hubspot_contact"
}
fetch(url, {
method: "GET",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"type": "hubspot_contact",
"userFieldProperties": [],
"courseFieldProperties": []
}Request
GET
api/hubspot/mappings
Body Parameters
type required optional
Type of the hupspot mapping you want to fetch the details of.
Hubspot Tabular List
Returns all the hubspot details in a tabular list. You can apply filter using search_param via events.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/hubspots?order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22name%22%3A%22%22%2C%22scormTypes%22%3A%5B%5D%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/hubspots"
);
let params = {
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"name":"","scormTypes":[]}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"id": 1,
"event": "New Account Created",
"object": "",
"action": "",
"event_display_value": "",
"author": "Aom Staff",
"created_at": "Aug 03, 2020 11:03 AM"
}
]
}Request
GET
api/hubspots
Query Parameters
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on field names.
Update Hubspot Action
To update a Hubspot Action, you need to use this request. Provide id, event, action and object and it will be updated. (See parameters)
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/hubspot/3" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"event":"New Account Created","action":"create.","object":"Hubspot Deal"}'
const url = new URL(
"https://demo.aomlms.com/api/hubspot/3"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"event": "New Account Created",
"action": "create.",
"object": "Hubspot Deal"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 1,
"message": "Hubspot updated successfully"
}Request
PUT
api/hubspot/{id}
URL Parameters
id string
ID of the hubspot action.
Body Parameters
event string
Event in which you want to send data.
action string
Action will be create of the event by default.
object string
Select the object from the dropdown list from either Hubspot Deal or Hubspot Contact.
Delete Hubspot
To delete a Hubspot, you need to use this request.
Example request:
curl -X POST \
"https://demo.aomlms.com/api/hubspot/action/delete/[1]" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/hubspot/action/delete/[1]"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Hubspot deleted successfully"
}Request
POST
api/hubspot/action/delete/{id}
URL Parameters
id string
Hubspot ID which needs to be deleted.
Hubspot Log Tabular List
Returns all the Hubspot log in a tabular list format in paginated mode.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/hubspot/logs/50?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/hubspot/logs/50"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"id": 1,
"event": "new_account_created",
"data": [],
"status": "success",
"errorMessage": "",
"created_at": "Aug 03, 2020 09:56 AM",
"showData": false
}
]
}Request
GET
api/hubspot/logs/{id}
URL Parameters
id string
ID of the Hubspot action.
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
Integrations
An integration can be used by admins to integrate this platform to other platforms. Endpoints helps in performing CRUD operation for and to integration.
System Integration Listing
Retrieves all the integrations in list format. Helps while showing integrations in tab formats.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/integrations/listing" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/integrations/listing"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"id": 1,
"name": "Google Analytics",
"identifier": "google-analytics",
"description": "The tracking code area that google suit needs to collect data on page sessions and view.",
"logo_url": "\/images\/google-analytics.svg",
"is_enabled": false,
"implementer_class": null,
"created_by": 1,
"updated_by": 1,
"created_at": null,
"updated_at": null
},
{
"id": 2,
"name": "Facebook Pixel",
"identifier": "fb-pixel",
"description": "The pixel code area provided in your Facebook Developer account meant for tracking the page view.",
"logo_url": "\/images\/Facebook.svg",
"is_enabled": false,
"implementer_class": null,
"created_by": 1,
"updated_by": 1,
"created_at": null,
"updated_at": null
},
{
"id": 3,
"name": "Custom JavaScript",
"identifier": "custom-js",
"description": "The code area for some putting some tiny little piece of code for external applications.",
"logo_url": "\/images\/javascript.svg",
"is_enabled": false,
"implementer_class": null,
"created_by": 1,
"updated_by": 1,
"created_at": null,
"updated_at": null
},
{
"id": 4,
"name": "Google Single Sign On",
"identifier": "google-sso",
"description": "Single sign-on (SSO) lets users sign in using their managed Google account credentials.",
"logo_url": "\/images\/google-logo.svg",
"is_enabled": false,
"implementer_class": null,
"created_by": 1,
"updated_by": 1,
"created_at": null,
"updated_at": null
},
{
"id": 5,
"name": "Zoom Meetings",
"identifier": "zoom-meetings",
"description": "Zoom is a web-based video conferencing tool. Set the API details to use it in your webinars.",
"logo_url": "\/images\/zoom-logo.svg",
"is_enabled": false,
"implementer_class": null,
"created_by": 1,
"updated_by": 1,
"created_at": null,
"updated_at": null
},
{
"id": 6,
"name": "Webhooks",
"identifier": "webhook",
"description": "Send automated notifications to external system when something happens.",
"logo_url": "\/images\/webhooks.svg",
"is_enabled": false,
"implementer_class": null,
"created_by": 1,
"updated_by": 1,
"created_at": null,
"updated_at": null
},
{
"id": 7,
"name": "REST API Access",
"identifier": "rest-api-access",
"description": "Now you can leverage REST-Full services. Enable this feature to work with different apps.",
"logo_url": "\/images\/api.svg",
"is_enabled": true,
"implementer_class": null,
"created_by": 1,
"updated_by": 1,
"created_at": null,
"updated_at": "2022-05-09T08:32:34.000000Z"
},
{
"id": 8,
"name": "GoToWebinar",
"identifier": "goto-webinars",
"description": "GoTo is a web-based video conferencing tool. Set the API details to use it in your webinars.",
"logo_url": "\/images\/goto-webinar.svg",
"is_enabled": false,
"implementer_class": null,
"created_by": 1,
"updated_by": 1,
"created_at": null,
"updated_at": null
},
{
"id": 9,
"name": "GoToTraining",
"identifier": "goto-trainings",
"description": "GoTo is a web-based video conferencing tool. Set the API details to use it in your webinars.",
"logo_url": "\/images\/goto-training.svg",
"is_enabled": false,
"implementer_class": null,
"created_by": 1,
"updated_by": 1,
"created_at": null,
"updated_at": null
},
{
"id": 10,
"name": "Single Sign On (OAuth 2.0)",
"identifier": "generic-sso-oauth",
"description": "Single sign-on (SSO OAuth 2.0) is an authentication scheme that allows a user to log in with a single ID and password.",
"logo_url": "\/images\/sso-oauth.svg",
"is_enabled": false,
"implementer_class": null,
"created_by": 1,
"updated_by": 1,
"created_at": null,
"updated_at": null
},
{
"id": 11,
"name": "Single Sign On (SAML 2.0)",
"identifier": "generic-sso-saml",
"description": "Single sign-on (SSO SAML 2.0) is an authentication scheme that allows a user to log in with a single ID and password.",
"logo_url": "\/images\/saml-logo.svg",
"is_enabled": false,
"implementer_class": null,
"created_by": 1,
"updated_by": 1,
"created_at": null,
"updated_at": null
},
{
"id": 12,
"name": "HubSpot",
"identifier": "hubspot",
"description": "HubSpot is an inbound marketing and sales service. Use this integration to sync your hubspot with your LMS platform.",
"logo_url": "\/images\/hubspot.svg",
"is_enabled": false,
"implementer_class": null,
"created_by": 1,
"updated_by": 1,
"created_at": null,
"updated_at": null
},
{
"id": 13,
"name": "MS Teams Meetings",
"identifier": "ms-team-meet",
"description": "Microsoft Teams is a collaboration app that helps your team stay organized and have conversations—all in one place.",
"logo_url": "\/images\/microsoft-teams.svg",
"is_enabled": false,
"implementer_class": null,
"created_by": 1,
"updated_by": 1,
"created_at": null,
"updated_at": null
},
{
"id": 14,
"name": "Shopify",
"identifier": "shopify",
"description": "Shopify is used to hosts your online store. Use this integration to sync your LMS courses with your shopify products.",
"logo_url": "\/images\/shopify.svg",
"is_enabled": false,
"implementer_class": null,
"created_by": 1,
"updated_by": 1,
"created_at": null,
"updated_at": null
},
{
"id": 15,
"name": "Salesforce",
"identifier": "salesforce",
"description": "Salesforce provides customer relationship management service. Use this integration to sync your salesforce with your LMS platform.",
"logo_url": "\/images\/salesforce.svg",
"is_enabled": false,
"implementer_class": null,
"created_by": 1,
"updated_by": 1,
"created_at": null,
"updated_at": null
},
{
"id": 16,
"name": "Accredible",
"identifier": "accredible",
"description": "Accredible is one of the only platforms available that is a full service digital credentialing solution.",
"logo_url": "\/images\/accredible.svg",
"is_enabled": false,
"implementer_class": null,
"created_by": 1,
"updated_by": 1,
"created_at": null,
"updated_at": null
}
]Request
GET
api/integrations/listing
Update Integration Settings
Updates the integration settings for a specified integration. Setting needs to be updated is mentioned in parameter. (See Parameter)
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/integrations/settings/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"is_enabled":true,"settings":"{ga_code: \"<script type=\"text\/javascript\">var a = 12;<\/script>\"}"}'
const url = new URL(
"https://demo.aomlms.com/api/integrations/settings/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"is_enabled": true,
"settings": "{ga_code: \"<script type=\"text\/javascript\">var a = 12;<\/script>\"}"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Settings Updated"
}Request
PUT
api/integrations/settings/{id}
URL Parameters
id string
ID of the integration.
Body Parameters
is_enabled boolean
Whether this integration is enabled or not.
settings array optional
All the setting for this integration(ga_code, zoom).
Retrieve Integration Settings
Retrieves all the integration settings for a specified integration. Helps in mainting the data and enable status of the integration.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/integrations/settings/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/integrations/settings/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "Google Analytics",
"identifier": "google-analytics",
"is_enabled": false,
"settings": {
"ga_code": "<script type=\"text\/javascript\"><\/script>"
}
}Request
GET
api/integrations/settings/{id}
URL Parameters
id string
ID of the integration.
Update Integration Status
Updates the integration status(enabled or disabled) for a specified integration.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/integrations/updateStatus" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"id":4,"status":true}'
const url = new URL(
"https://demo.aomlms.com/api/integrations/updateStatus"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"id": 4,
"status": true
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Settings Updated"
}Request
PUT
api/integrations/updateStatus
Body Parameters
id integer
ID of the integration.
status boolean
Whether this integration is enabled or not.
Retrieve Shopify Product List
Return all the Shopify Product, you need to use this request.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/shopify/product/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/shopify/product/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"id": 1,
"title": "Introduction to Continuing Education"
},
{
"id": 2,
"title": "Professional Training And Education"
}
]Request
GET
api/shopify/product/lookup
Create Shopify Product
To create a Shopify Product, you need to use this request. (See parameters)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/shopify/product/create" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"title":"Professional Training And Education","price":"3000"}'
const url = new URL(
"https://demo.aomlms.com/api/shopify/product/create"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"title": "Professional Training And Education",
"price": "3000"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"success": true,
"message": "Product created successfully",
"product_id": 1,
"product_title": "Professional Training And Education"
}
]Request
POST
api/shopify/product/create
Body Parameters
title string
Title of the product.
price string optional
Price of the product.
Subscribe Shopify Webhook
To subscribe a Shopify Webhook, you need to use this request.
Example request:
curl -X POST \
"https://demo.aomlms.com/api/shopify/webhook/subscribe" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/shopify/webhook/subscribe"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"success": true,
"message": "Webhook Subscription is successful"
}
]Request
POST
api/shopify/webhook/subscribe
Learning Paths
A learning path is a group of courses. This group is created to track milestones or award certificates.
Create Learning Path
To create a learning path, you need to use this request. (See parameters) Created learning paths can be used to award certificates to a user upon a completion of a group of courses. Or it can be used to track progress.
Returns : id of the learning path created and a success message
Example request:
curl -X POST \
"https://demo.aomlms.com/api/learningpath/create" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"Catagory Mastery","courses":[1,5,10],"certificates":[],"prerequisites":[5]}'
const url = new URL(
"https://demo.aomlms.com/api/learningpath/create"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "Catagory Mastery",
"courses": [
1,
5,
10
],
"certificates": [],
"prerequisites": [
5
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 1,
"message": "Learning Path was successfully created"
}Request
POST
api/learningpath/create
Body Parameters
name string
Name for the learning path.
courses array
Courses attached to the learning path.
certificates array optional
The certificate(s) the user recieves upon learning path completion.
prerequisites array optional
Course IDs that should be a prerequisite.
Retrieve Learning Path
Retrieves the details of the specified learning path. Helps in fetching learning path using its ID. (See Parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/learningpath/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/learningpath/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "test",
"courses": [
{
"label": "Advanced Professional Development",
"value": 2
},
{
"label": "Introduction to Continuing Education",
"value": 3
}
],
"prerequisites": {
"2": false,
"3": true
},
"certificates": [
{
"id": 1,
"name": "Default Certificate"
}
]
}Request
GET
api/learningpath/{id}
URL Parameters
id string
ID of the learning path you want to fetch the details of.
Update Learning Path
Updates the details of a specified learning path. (See parameters) Learning Path can be used by the students to get some discount while purchasing the course.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/learningpath/edit/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"Catagory Mastery","courses":[1,5,10],"certificates":[],"prerequisites":[5]}'
const url = new URL(
"https://demo.aomlms.com/api/learningpath/edit/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "Catagory Mastery",
"courses": [
1,
5,
10
],
"certificates": [],
"prerequisites": [
5
]
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Learning Path was successfully updated"
}Request
PUT
api/learningpath/edit/{id}
URL Parameters
id string
ID of the learning path.
Body Parameters
name string
Name for the learning path.
courses array
Courses attached to the learning path.
certificates array optional
The certificate(s) the user recieves upon learning path completion.
prerequisites array optional
Course IDs that should be a prerequisite.
Learning Path Tabular List
Returns all the learning paths in a tabular list format in paginated mode. You can apply filter using search_param via name(learning path name).
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/learningpaths/tabularlist?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22name%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/learningpaths/tabularlist"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"name":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 2,
"recordsFiltered": 2,
"records": [
{
"id": 2,
"name": "test 3",
"certificate_count": 1,
"created_at": "Oct 15, 2021 12:23 PM",
"order_type": "suggestive",
"courses": [
{
"id": 3,
"name": "Introduction to Continuing Education"
},
{
"id": 2,
"name": "Advanced Professional Development"
}
]
},
{
"id": 1,
"name": "test",
"certificate_count": 1,
"created_at": "Oct 13, 2021 03:07 AM",
"order_type": "prerequisite",
"courses": [
{
"id": 2,
"name": "Advanced Professional Development"
},
{
"id": 3,
"name": "Introduction to Continuing Education"
}
]
}
]
}Request
GET
api/learningpaths/tabularlist
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
for searching items based on field names.
Delete Learning Path
To delete a learning path, you need to use this request. Returns number of learning paths deleted(if multiple selected) and also not deleted. (See Response)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/learningpath/delete" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"delete_ids":[1,12,15]}'
const url = new URL(
"https://demo.aomlms.com/api/learningpath/delete"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"delete_ids": [
1,
12,
15
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "2 learning path(s) deleted 1 learning path(s) not delete"
}Request
POST
api/learningpath/delete
Body Parameters
delete_ids array
All coupon IDs which needs to be deleted.
Learning Path Lookup
Helps while showing learning path names in dropdown elements. You can apply filters using search_term parameter.
Example request:
curl -X POST \
"https://demo.aomlms.com/api/learningpath/lookup?search_term=accusamus" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/learningpath/lookup"
);
let params = {
"search_term": "accusamus",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"value": 1,
"label": "Learning Path 1"
}
]Request
POST
api/learningpath/lookup
Query Parameters
search_term string optional
name to search by
Media
Endpoints for handling and managing upload/downloads static files, assets and media
Upload Media
You can upload the files in the platform using this request. Uploaded media files can be used while submission, image display in pages, etc.
Example request:
curl -X POST \
"https://demo.aomlms.com/api/media?resumableChunkNumber=1&resumableChunkSize=10485760&resumableCurrentChunkSize=79531&resumableTotalSize=79531&resumableType=image%2Fpng&resumableIdentifier=79531-default-certificatepng&resumableFilename=default-certificate.png&resumableRelativePath=default-certificate.png&resumableTotalChunks=1&file=%28binary%29" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/media"
);
let params = {
"resumableChunkNumber": "1",
"resumableChunkSize": "10485760",
"resumableCurrentChunkSize": "79531",
"resumableTotalSize": "79531",
"resumableType": "image/png",
"resumableIdentifier": "79531-default-certificatepng",
"resumableFilename": "default-certificate.png",
"resumableRelativePath": "default-certificate.png",
"resumableTotalChunks": "1",
"file": "(binary)",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"id": 2,
"file_name": "default-certificate-8741bc53eb39d4154c232925c0f13088.png",
"file_type": "Images",
"status": "Completed",
"s3_url": "https:\/\/aom-uploads-test.s3.us-west-2.amazonaws.com\/public\/default-certificate-8741bc53eb39d4154c232925c0f13088.png",
"mux_url": null,
"mime_type": "image\/png",
"uploaded_by": "Aom Staff",
"created_at": "Aug 12, 2020 09:02 AM"
}
]
}Request
POST
api/media
Query Parameters
resumableChunkNumber string
Chunk number for the media.
resumableChunkSize string
Chunk size for the media in bits.
resumableCurrentChunkSize string
Current uploading chunk size for the media in bits.
resumableTotalSize string
Total chunk size for the media in bits.
resumableType string
Type of the media in that is going to be uploaded.
resumableIdentifier string
Identifier for the media that is going to be uploaded.
resumableFilename string
Name of the media that is going to be uploaded.
resumableRelativePath string
Relative path of the media that is going to be uploaded.
resumableTotalChunks string
Total chunks.
file string
Binary file.
Media Tabular List
Returns all the media in a tabular list format in paginated mode. You can apply filter using search_param via name(media name).
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/media/tabularlist?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22name%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/media/tabularlist"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"name":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"id": 2,
"file_name": "default-certificate-8741bc53eb39d4154c232925c0f13088.png",
"file_type": "Images",
"status": "Completed",
"s3_url": "https:\/\/aom-uploads-test.s3.us-west-2.amazonaws.com\/public\/default-certificate-8741bc53eb39d4154c232925c0f13088.png",
"mux_url": null,
"mime_type": "image\/png",
"uploaded_by": "Aom Staff",
"created_at": "Aug 12, 2020 09:02 AM"
}
]
}Request
GET
api/media/tabularlist
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on field names.
Delete Media
To delete a media, you need to use this request. Returns number of medias deleted. (See Response)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/media/delete" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"delete_ids":[3]}'
const url = new URL(
"https://demo.aomlms.com/api/media/delete"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"delete_ids": [
3
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "1 media(s) deleted"
}Request
POST
api/media/delete
Body Parameters
delete_ids array
All media IDs which needs to be deleted.
Get Media Status
To get media status, you need to use this request. Returns the status of the uploaded media. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/media/status?media_Id=3" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/media/status"
);
let params = {
"media_Id": "3",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"status": "Completed"
}Request
GET
api/media/status
Query Parameters
media_Id string
Media ID which needs to see status of.
Download Video
To download a video, you need to use this request. (See parameters)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/media/mux/download" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"mux_id":10}'
const url = new URL(
"https://demo.aomlms.com/api/media/mux/download"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"mux_id": 10
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"status": "2",
"downloadUrl": ""
}Request
POST
api/media/mux/download
Body Parameters
mux_id integer
ID of the video which needs to be downloaded.
Memberships
Memberships are used to provide content access to users. Helps in providing course and standalone modules access to students
Lookup
Retrieves all the memberships. Helps in showing membership names in forms elements like dropdown.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/memberships/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/memberships/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"id": 1,
"name": "Membership-plan-1"
}
]Request
GET
api/memberships/lookup
Tabular List
Retrieves all the memberships in a tabular list format with pagination mode. You can apply filter using search_param
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/memberships/tabularlist?page_size=10&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C%22direction%22%3A%22desc%22%7D&search_param=%7B%22name%22%3A%22My-First-Membership%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/memberships/tabularlist"
);
let params = {
"page_size": "10",
"page_number": "1",
"order_by": "{"colName":"created_at","direction":"desc"}",
"search_param": "{"name":"My-First-Membership"}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 4,
"recordsFiltered": 4,
"records": [
{
"id": 4,
"name": "My-First-Membership",
"expired_at": "2021-05-04 23:45:50"
}
]
}Request
GET
api/memberships/tabularlist
Query Parameters
page_size string
The number of the memberships you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
for searching items based on memberships name and role names.
Retrieve Membership
Retrieves the details of the specified membership. Helps in fetching membership using its ID. (See Parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/membership/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/membership/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "Gold-plan",
"courseAccess": "specific",
"moduleAccess": "all",
"expired_at": null,
"courseAccessCategories": [
1,
2
],
"moduleAccessCategories": []
}Request
GET
api/membership/{id}
URL Parameters
id string
ID of the membership you want to fetch the details of.
Create Membership
To create a membership, you need to use this request. (See parameters) Created membership is being used as to couple course and standalone modules for students to launch and view.
Returns : id of the membership created and successfull message
Example request:
curl -X POST \
"https://demo.aomlms.com/api/membership" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"Gold-membership","expired_at":"'2021-10-03 23:59:59'","courseAccess":"all","moduleAccess":"all","courseAccessCategories":[1,2],"moduleAccessCategories":[5,19]}'
const url = new URL(
"https://demo.aomlms.com/api/membership"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "Gold-membership",
"expired_at": "'2021-10-03 23:59:59'",
"courseAccess": "all",
"moduleAccess": "all",
"courseAccessCategories": [
1,
2
],
"moduleAccessCategories": [
5,
19
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 1,
"message": "Membership created successfully"
}Request
POST
api/membership
Body Parameters
name string
Name of the membership.
expired_at string optional
Expire date for the membership.
courseAccess string optional
Access option for courses. {all, no_access, specific} Only these values allowed.
moduleAccess string optional
Access option for modules. {all, no_access, specific} Only these values allowed.
courseAccessCategories array optional
Any course category IDs if you have selected specific in courseAccess parameter.
moduleAccessCategories array optional
Any module category IDs if you have selected specific in moduleAccess parameter.
Update Membership
Updates the details of a specified membership. (See parameters) Membership is being used as to couple courses and standalone modules for students to launch and view.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/membership/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"Gold-membership","expired_at":"'2021-10-03 23:59:59'","courseAccess":"all","moduleAccess":"all","courseAccessCategories":[1,2],"moduleAccessCategories":[5,19]}'
const url = new URL(
"https://demo.aomlms.com/api/membership/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "Gold-membership",
"expired_at": "'2021-10-03 23:59:59'",
"courseAccess": "all",
"moduleAccess": "all",
"courseAccessCategories": [
1,
2
],
"moduleAccessCategories": [
5,
19
]
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 1,
"message": "Membership updated successfully"
}Request
PUT
api/membership/{id}
URL Parameters
id string
ID of the membership.
Body Parameters
name string
Name of the membership.
expired_at string optional
Expire date for the membership.
courseAccess string optional
Access option for courses. {all, no_access, specific} Only these values allowed.
moduleAccess string optional
Access option for modules. {all, no_access, specific} Only these values allowed.
courseAccessCategories array optional
Any course category IDs if you have selected specific in courseAccess parameter.
moduleAccessCategories array optional
Any module category IDs if you have selected specific in moduleAccess parameter.
Quick Edit
Updates the details in bulk for a specified membership. Parameters is provided which needs to be updated. (See Parameters)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/membership/quickEdit" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"membership_ids":[3,2],"expired_at":"2021-01-11 23:45:00"}'
const url = new URL(
"https://demo.aomlms.com/api/membership/quickEdit"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"membership_ids": [
3,
2
],
"expired_at": "2021-01-11 23:45:00"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Memberships updated Successfully"
}Request
POST
api/membership/quickEdit
Body Parameters
membership_ids array
All membership IDs which needs to be updated.
expired_at datetime optional
It will change the expiry date for all selected memberships.
Menus
Menus are used as front end module for this platform. Endpoints for managing menus on marketing front end pages
Retrieve Menus
Retrieves all the menus in list format. Helps while showing menu in front end. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/menus/list" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/menus/list"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"id": 1,
"name": "Main Menu",
"items": [
{
"label": "Home",
"type": "page",
"custom_link": null,
"page_id": 1,
"display_order": 1,
"css_class": null,
"restrictions": null,
"open_in_new_tab": false,
"level": 1,
"isCollapsed": true,
"hyperlink": "\/"
},
{
"label": "Courses",
"type": "page",
"custom_link": null,
"page_id": 2,
"display_order": 2,
"css_class": null,
"restrictions": null,
"open_in_new_tab": false,
"level": 1,
"isCollapsed": true,
"hyperlink": "http:\/\/localhost:8000\/course-catalog"
},
{
"label": "Our Team",
"type": "page",
"custom_link": null,
"page_id": 3,
"display_order": 3,
"css_class": null,
"restrictions": null,
"open_in_new_tab": false,
"level": 1,
"isCollapsed": true,
"hyperlink": "http:\/\/localhost:8000\/about-us"
},
{
"label": "Contact Us",
"type": "page",
"custom_link": null,
"page_id": 6,
"display_order": 4,
"css_class": null,
"restrictions": null,
"open_in_new_tab": false,
"level": 1,
"isCollapsed": true,
"hyperlink": "http:\/\/localhost:8000\/contact-us"
}
]
},
{
"id": 2,
"name": "Top Bar Menu",
"items": [
{
"label": "Dashboard",
"type": "custom_link",
"custom_link": "\/dashboard",
"page_id": null,
"display_order": 1,
"css_class": null,
"restrictions": null,
"open_in_new_tab": false,
"level": 1,
"isCollapsed": true,
"hyperlink": "\/dashboard"
},
{
"label": "Cart",
"type": "page",
"custom_link": null,
"page_id": 5,
"display_order": 2,
"css_class": null,
"restrictions": null,
"open_in_new_tab": false,
"level": 1,
"isCollapsed": true,
"hyperlink": "http:\/\/localhost:8000\/cart"
}
]
},
{
"id": 3,
"name": "Footer Menu",
"items": []
},
{
"id": 4,
"name": "Student Dashboard Sidebar",
"items": []
}
]Request
GET
api/menus/list
Retrieve Menu Items
Retrieves all the items of a specified menu. Helps while showing menu items in front end. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/menus/items/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/menus/items/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"label": "Home",
"type": "page",
"custom_link": null,
"page_id": 1,
"display_order": 1,
"css_class": null,
"restrictions": null,
"open_in_new_tab": false,
"level": 1,
"isCollapsed": true,
"hyperlink": "\/"
},
{
"label": "Courses",
"type": "page",
"custom_link": null,
"page_id": 2,
"display_order": 2,
"css_class": null,
"restrictions": null,
"open_in_new_tab": false,
"level": 1,
"isCollapsed": true,
"hyperlink": "http:\/\/localhost:8000\/course-catalog"
},
{
"label": "Our Team",
"type": "page",
"custom_link": null,
"page_id": 3,
"display_order": 3,
"css_class": null,
"restrictions": null,
"open_in_new_tab": false,
"level": 1,
"isCollapsed": true,
"hyperlink": "http:\/\/localhost:8000\/about-us"
},
{
"label": "Contact Us",
"type": "page",
"custom_link": null,
"page_id": 6,
"display_order": 4,
"css_class": null,
"restrictions": null,
"open_in_new_tab": false,
"level": 1,
"isCollapsed": true,
"hyperlink": "http:\/\/localhost:8000\/contact-us"
}
]Request
GET
api/menus/items/{id}
URL Parameters
id string
ID of the menu.
Save Menu
If admins want to add new menu , you can use this request to make one. Adds new items or updates existing items. (See Response)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/menus" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"menuList":[{"id":1,"name":"Main Menu","items":[{"label":"Home","type":"page","custom_link":null,"page_id":1,"display_order":1,"css_class":null,"restrictions":null,"open_in_new_tab":false,"level":1,"isCollapsed":true,"hyperlink":"\/"},{"label":"Courses","type":"page","custom_link":null,"page_id":2,"display_order":2,"css_class":null,"restrictions":null,"open_in_new_tab":false,"level":1,"isCollapsed":true,"hyperlink":"http:\/\/localhost:8000\/course-catalog"},{"label":"Our Team","type":"page","custom_link":null,"page_id":3,"display_order":3,"css_class":null,"restrictions":null,"open_in_new_tab":false,"level":1,"isCollapsed":true,"hyperlink":"http:\/\/localhost:8000\/about-us"},{"label":"Contact Us","type":"page","custom_link":null,"page_id":6,"display_order":4,"css_class":null,"restrictions":null,"open_in_new_tab":false,"level":1,"isCollapsed":true,"hyperlink":"http:\/\/localhost:8000\/contact-us"}]},{"id":2,"name":"Top Bar Menu","items":[{"label":"Dashboard","type":"custom_link","custom_link":"\/dashboard","page_id":null,"display_order":1,"css_class":null,"restrictions":null,"open_in_new_tab":false,"level":1,"isCollapsed":true,"hyperlink":"\/dashboard"},{"label":"Cart","type":"page","custom_link":null,"page_id":5,"display_order":2,"css_class":null,"restrictions":null,"open_in_new_tab":false,"level":1,"isCollapsed":true,"hyperlink":"http:\/\/localhost:8000\/cart"}]},{"id":3,"name":"Footer Menu","items":[]}]}'
const url = new URL(
"https://demo.aomlms.com/api/menus"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"menuList": [
{
"id": 1,
"name": "Main Menu",
"items": [
{
"label": "Home",
"type": "page",
"custom_link": null,
"page_id": 1,
"display_order": 1,
"css_class": null,
"restrictions": null,
"open_in_new_tab": false,
"level": 1,
"isCollapsed": true,
"hyperlink": "\/"
},
{
"label": "Courses",
"type": "page",
"custom_link": null,
"page_id": 2,
"display_order": 2,
"css_class": null,
"restrictions": null,
"open_in_new_tab": false,
"level": 1,
"isCollapsed": true,
"hyperlink": "http:\/\/localhost:8000\/course-catalog"
},
{
"label": "Our Team",
"type": "page",
"custom_link": null,
"page_id": 3,
"display_order": 3,
"css_class": null,
"restrictions": null,
"open_in_new_tab": false,
"level": 1,
"isCollapsed": true,
"hyperlink": "http:\/\/localhost:8000\/about-us"
},
{
"label": "Contact Us",
"type": "page",
"custom_link": null,
"page_id": 6,
"display_order": 4,
"css_class": null,
"restrictions": null,
"open_in_new_tab": false,
"level": 1,
"isCollapsed": true,
"hyperlink": "http:\/\/localhost:8000\/contact-us"
}
]
},
{
"id": 2,
"name": "Top Bar Menu",
"items": [
{
"label": "Dashboard",
"type": "custom_link",
"custom_link": "\/dashboard",
"page_id": null,
"display_order": 1,
"css_class": null,
"restrictions": null,
"open_in_new_tab": false,
"level": 1,
"isCollapsed": true,
"hyperlink": "\/dashboard"
},
{
"label": "Cart",
"type": "page",
"custom_link": null,
"page_id": 5,
"display_order": 2,
"css_class": null,
"restrictions": null,
"open_in_new_tab": false,
"level": 1,
"isCollapsed": true,
"hyperlink": "http:\/\/localhost:8000\/cart"
}
]
},
{
"id": 3,
"name": "Footer Menu",
"items": []
}
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Menu updated successfully"
}Request
POST
api/menus
Body Parameters
menuList array optional
Menu list which needs to saved in this menu.
Modules
A module is a lesson that you add as course content. Modules could be Text, Video, PDF, SCORM, Quiz, Assignments or Survey. Helps in performing CRUD operation to and for modules.
Create Blank Module
To create a blank module, you need to use this request. (See parameters) Created blank modules can be used while creating a course and adding different module in the same course. (See Parameters)
Returns : id of the module created and icon to for the module(text, video, pdf, scorm, discussion, etc)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/modules/addBlank" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"Lesson-1","type":"text"}'
const url = new URL(
"https://demo.aomlms.com/api/modules/addBlank"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "Lesson-1",
"type": "text"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 14,
"icon": "<i class=\"el-icon-tickets\"><\/i>"
}Request
POST
api/modules/addBlank
Body Parameters
name string
Name of the module that you want to create.
type string
Type of the module(whether its text, video, pdf, assignment etc).
Modules Lookup
Retrieves all the modules. Helps while showing modules names in form elements like dropdown. You can apply filters using search_term parameter. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/modules/lookup?search_term=amet" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/modules/lookup"
);
let params = {
"search_term": "amet",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"id": 7,
"name": "First-quiz",
"type": "quiz",
"value": 7,
"label": "First-quiz",
"icon": "<i class=\"el-icon-discover\"><\/i>"
},
{
"id": 8,
"name": "Quiz-2",
"type": "quiz",
"value": 8,
"label": "Quiz-2",
"icon": "<i class=\"el-icon-discover\"><\/i>"
}
]Request
GET
api/modules/lookup
Query Parameters
search_term string
You need to provide module name or substring of the module name to search for that module.
Retrieve Pending Submissions
This is for admin panel. Returns all the submissions done by the students and haven't evaluated by the instructor. Returns list including total pending count of submissions(assignment, discussion) and details of pending submissions.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/modules/pendingsubmissions" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/modules/pendingsubmissions"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"totalPending": 1,
"data": [
{
"id": 1,
"name": "course 1",
"featured_image_url": null,
"totalSubmission": 1
}
]
}Request
GET
api/modules/pendingsubmissions
Modules Type Lookup
Retrieves all the type of the module that platform supports. Helps while showing module types in form elements like dropdown. Returns a list of all module types. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/modules/type/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/modules/type/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"db_value": "text",
"display_value": "Text"
},
{
"db_value": "video",
"display_value": "Video"
},
{
"db_value": "pdf",
"display_value": "PDF"
},
{
"db_value": "webinar",
"display_value": "Webinar"
},
{
"db_value": "scorm",
"display_value": "SCORM"
},
{
"db_value": "quiz",
"display_value": "Quiz"
},
{
"db_value": "assignment",
"display_value": "Assignment"
},
{
"db_value": "discussion",
"display_value": "Discussion"
},
{
"db_value": "survey",
"display_value": "Survey"
}
]Request
GET
api/modules/type/lookup
FormField Types Lookup
Retrieves all the type of the form fields that platform supports for Survey module. Helps while showing form fields types in form elements like dropdown while creating survey form. Returns a list of all form field types. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/modules/fieldtype/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/modules/fieldtype/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"db_value": "text",
"display_value": "Text"
},
{
"db_value": "textarea",
"display_value": "Text Area"
},
{
"db_value": "rating",
"display_value": "Rating"
},
{
"db_value": "radio",
"display_value": "Single Select"
},
{
"db_value": "checkbox",
"display_value": "Multiple Select"
},
{
"db_value": "dropdown",
"display_value": "Drop Down"
}
]Request
GET
api/modules/fieldtype/lookup
Modules Tabular List
Returns all the modules in a tabular list format in paginated mode. You can apply filter using search_param via moduleTypes(module type), associatedCourse(modules used in course) and moduleName.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/modules/tabularlist?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22moduleTypes%22%3A+%5B%22text%22%5D%2CassociatedCourse%22%3A%22%22%2C%22moduleName%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/modules/tabularlist"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"moduleTypes": ["text"],associatedCourse":"","moduleName":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 14,
"recordsFiltered": 3,
"records": [
{
"id": 14,
"name": "Lesson-1",
"slug": "lesson-1",
"type": "text",
"icon": "<i class=\"el-icon-tickets\"><\/i>",
"author": "Aom Staff",
"created_at": "Aug 11, 2020 06:45 AM"
},
{
"id": 5,
"name": "The Fundamentals of LMS",
"slug": "the-fundamentals-of-lms",
"type": "text",
"icon": "<i class=\"el-icon-tickets\"><\/i>",
"author": "Aom Staff",
"created_at": "Aug 10, 2020 04:59 PM"
},
{
"id": 1,
"name": "test",
"slug": "test",
"type": "text",
"icon": "<i class=\"el-icon-tickets\"><\/i>",
"author": "Aom Staff",
"created_at": "Aug 03, 2020 09:56 AM"
}
]
}Request
GET
api/modules/tabularlist
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
for searching items based on field names.
Update Slug
Updates the slug of the course. Example - old-awesome-course to new-awesome-course
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/modules/update-slug/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"slug":"new-lesson-1"}'
const url = new URL(
"https://demo.aomlms.com/api/modules/update-slug/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"slug": "new-lesson-1"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
"lesson-1"Request
PUT
api/modules/update-slug/{id}
URL Parameters
id string
The ID of the module.
Body Parameters
slug required optional
New slug for the module.
Quick Edit
Updates the details in bulk for a specified module. Parameters is provided which needs to be updated. (See Parameters)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/module/quickEdit" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"module_ids":[5,14],"author_id":1}'
const url = new URL(
"https://demo.aomlms.com/api/module/quickEdit"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"module_ids": [
5,
14
],
"author_id": 1
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Modules updated Successfully"
}Request
POST
api/module/quickEdit
Body Parameters
module_ids array
All module IDs which needs to be updated.
author_id integer optional
Update the instructor/Author for the selected modules.
Delete Module
To delete a module, you need to use this request. Returns number of module deleted(if multiple selected) and also not deleted. (See Response)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/modules/delete" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"delete_ids":[1,12,15]}'
const url = new URL(
"https://demo.aomlms.com/api/modules/delete"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"delete_ids": [
1,
12,
15
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "2 modules(s) deleted 1 modules(s) not deleted as it is used in course(s). Please remove the modules from the course and try again."
}Request
POST
api/modules/delete
Body Parameters
delete_ids array
All module IDs which needs to be deleted.
Quiz Lookup
Retrieves all the quizzes user has ever created. This request helps in showing all the quizzes in form elements like dropdown, etc. Returns list of ID and name of the quizzes. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/quiz/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/quiz/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"value": 1,
"label": "First-quiz"
},
{
"value": 2,
"label": "Quiz-2"
}
]Request
GET
api/quiz/lookup
Pages
Pages are Front end Marketing visuals. Page can be viewed by the different users to interact with this platform. Endpoint helps in managing pages.
Load Layouts
To load layout, you need to use this request. (See parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/pages/layouts" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"context":"page"}'
const url = new URL(
"https://demo.aomlms.com/api/pages/layouts"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"context": "page"
}
fetch(url, {
method: "GET",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": "2",
"name": "Landing Page",
"thumbnail": "\/images\/thumbnails\/landing-thumbnail.jpg",
"type": "saved",
"data": {}
}Request
GET
api/pages/layouts
Body Parameters
context string
Load Layout of page,section,row and module type.
Retrieve Page Layout
Retrieves all code snippet name and the code that is being used for making that snippet that user has ever created in this platform. It is being used by platform core modules like video, pdf, cart component, etc. (See response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/pages/snippets" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/pages/snippets"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"pageHeaderSimple": {
"name": "Simple Page Header",
"html": "<div class=\"header pt-4 mb-4\">\r\n <div class=\"container\">\r\n <h1>The Main Header<\/h1>\r\n <h4>The subheading that should be brief enough to describe the page.<\/h4>\r\n <p class=\"small-divider bg-primary my-4 el-divider\"> <\/p>\r\n <\/div>\r\n <\/div>"
},
"productListing": {
"name": "Product Listing",
"html": "<div class=\"product-listing\">\r\n <div class=\"noneditable bg-light d-flex align-items-center justify-content-center display-in-builder\">\r\n <h1 class=\"text-center\">## Product Listing Block ##<\/h1>\r\n <\/div>\r\n <product-listing-card><\/product-listing-card>\r\n <\/div>"
},
"cartComponent": {
"name": "Shopping Cart Component",
"html": "<div class=\"shopping-cart\">\r\n <div class=\"noneditable bg-light d-flex align-items-center justify-content-center display-in-builder\">\r\n <h1 class=\"text-center\">## Shopping Cart Block ##<\/h1>\r\n <\/div>\r\n <div class=\"container cart-container\">\r\n <shopping-cart :show-checkout-button=\"true\"><\/shopping-cart>\r\n <\/div>\r\n <\/div>"
},
"checkoutComponent": {
"name": "Checkout Component",
"html": "<div class=\"checkout\">\r\n <div class=\"noneditable bg-light d-flex align-items-center justify-content-center display-in-builder\">\r\n <h1 class=\"text-center\">## Checkout Block ##<\/h1><\/div>\r\n <div class=\"container checkout-container\">\r\n <checkout :user-id=\"[%userid%]\"><\/checkout>\r\n <\/div>\r\n <\/div>"
},
"ctafullwidth": {
"name": "Call To Action",
"html": "<div class=\"bg-primary text-white text-center p-4 mt-4\">\r\n <h1 class=\"text-center\"><b> The Title of the CTA ?<\/b><\/h1>\r\n <p class=\"lead text-white text-center mb-4\">Lorem ipsum dolor sit amet, consectetur adipiscing elit.<\/p>\r\n <a href=\"\/contact-us\" class=\"btn btn-light\">CTA Button<\/a>\r\n <\/div>"
},
"contactUs": {
"name": "Contact Us Form",
"html": "<div class=\"contact-form\">\r\n <div class=\"noneditable bg-light d-flex align-items-center justify-content-center display-in-builder\">\r\n <h1 class=\"text-center\">## Contact Us Form Block ##<\/h1>\r\n <\/div>\r\n <contact-us-form><\/contact-us-form>\r\n<\/div>"
},
"video": {
"name": "Video",
"html": "<div class=\"native-video\"><div class=\"noneditable bg-light d-flex align-items-center justify-content-center display-in-builder\">\r\n <h1 class=\"text-center\">## Video Block ##<\/h1><\/div>\r\n <native-hls-player url=\"https:\/\/stream.mux.com\/sTiBBrOuCQlhXOnufEtUcf23kUxpQ00Xp.m3u8\" coverImage=\"https:\/\/aom-uploads-test.s3.us-west-2.amazonaws.com\/public\/democertificate2-035fe38fd060ed9befb82257cd4f96c2.jpg\"><\/native-hls-player>\r\n <\/div>"
},
"pdf": {
"name": "Pdf Document",
"html": "<div class=\"native-pdf\"> <div class=\"noneditable bg-light d-flex align-items-center justify-content-center display-in-builder\">\r\n <h1 class=\"text-center\">## Pdf Document Block ##<\/h1><\/div>\r\n <native-pdf url=\"https:\/\/aom-uploads-test.s3-us-west-2.amazonaws.com\/assignments\/Game_Theory_(Stanford_Encyclopedia_of_Philosophy)_1591614209.pdf\"><\/native-pdf>\r\n <\/div>"
}
}Request
GET
api/pages/snippets
Retrieve Page
Retrieves the details of the specified page. Helps in fetching page using its ID. (See Parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/page/3" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/page/3"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"title": "About Us",
"slug": "about-us",
"content": "<div class=\"header pt-4 mb-4\"><div class=\"container\"><h1><b>About Us<\/b><\/h1><h4>Lorem ipsum dolor sit amet, consectetur adipiscing elit.<\/h4><p class=\"small-divider bg-primary my-4 el-divider\"> <\/p><\/div><\/div><h1 class=\"text-center my-4\"><b>Who we are and what we do<\/b><\/h1><div class=\"container mb-4\"><div class=\"row mb-4\"><div class=\"col col-md-6\"><figure><img class=\"\" src=\"https:\/\/images.pexels.com\/photos\/1036641\/pexels-photo-1036641.jpeg?auto=compress&cs=tinysrgb&dpr=2&h=150&w=800\" data-image=\"40ywulncqlm7\"><\/figure><\/div><div class=\"col col-md-6\">\r\n <div class=\"d-flex align-items-center mb-4\"><p class=\"m-0 mr-3 text-primary\" style=\"font-size: 35px; line-height: 1;\"><i class=\"fas fa-check-circle\"><\/i><\/p>\r\n <h3 class=\"m-0 font-weight-bold\">Cheese on toast airedale the big cheese<\/h3>\r\n <\/div><div class=\"d-flex align-items-center mb-4\"><p class=\"m-0 mr-3 text-primary\" style=\"font-size: 35px; line-height: 1;\"><i class=\"fas fa-check-circle\"><\/i><\/p>\r\n <h3 class=\"m-0 font-weight-bold\"> Danish fontina cheesy grin airedale danish fontina <\/h3>\r\n <\/div><div class=\"d-flex align-items-center mb-4\"><p class=\"m-0 mr-3 text-primary\" style=\"font-size: 35px; line-height: 1;\"><i class=\"fas fa-check-circle\"><\/i><\/p>\r\n <h3 class=\"m-0 font-weight-bold\"> Everyone loves chalk and cheese brie.<\/h3>\r\n <\/div><div class=\"d-flex align-items-center mb-4\"><p class=\"m-0 mr-3 text-primary\" style=\"font-size: 35px; line-height: 1;\"><i class=\"fas fa-check-circle\"><\/i><\/p>\r\n <h3 class=\"m-0 font-weight-bold\">Skate ipsum dolor sit amet, alley oop .<\/h3>\r\n <\/div><div class=\"d-flex align-items-center mb-4\"><p class=\"m-0 mr-3 text-primary\" style=\"font-size: 35px; line-height: 1;\"><i class=\"fas fa-check-circle\"><\/i><\/p>\r\n <h3 class=\"m-0 font-weight-bold\">Those options are already baked<\/h3>\r\n <\/div>\r\n <\/div><\/div><p>Suspendisse malesuada congue posuere. Pellentesque malesuada purus odio, ac porttitor nulla semper ac. Nulla porttitor facilisis purus, a commodo augue bibendum dignissim. Fusce porta tellus eget pulvinar hendrerit. Donec vel mi purus. Nunc consequat a erat vel lacinia. Nulla sollicitudin eros a ante lacinia rutrum. Interdum et malesuada fames ac ante ipsum primis in faucibus. Praesent vel mauris molestie, convallis tellus et, tincidunt tellus. Morbi ligula ligula, luctus at hendrerit a, imperdiet ut est. Cras sit amet massa sit amet est vestibulum volutpat in a urna. Sed suscipit diam eu nisi hendrerit rhoncus. Pellentesque suscipit libero ac urna dictum sagittis. <\/p><p>Suspendisse malesuada congue posuere. Pellentesque malesuada purus odio, ac porttitor nulla semper ac. Nulla porttitor facilisis purus, a commodo augue bibendum dignissim. Fusce porta tellus eget pulvinar hendrerit. Donec vel mi purus. Nunc consequat a erat vel lacinia. Nulla sollicitudin eros a ante lacinia rutrum. Interdum et malesuada fames ac ante ipsum primis in faucibus. Praesent vel mauris molestie, convallis tellus et, tincidunt tellus. Morbi ligula ligula, luctus at hendrerit a, imperdiet ut est. Cras sit amet massa sit amet est vestibulum volutpat in a urna. Sed suscipit diam eu nisi hendrerit rhoncus. Pellentesque suscipit libero ac urna dictum sagittis.<\/p><\/div>\r\n <h1 class=\"text-center pt-5\"><b>Our Team<\/b><\/h1>\r\n <p class=\"text-center\">Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt\r\n ut labore et dolore magna aliqua. Ut enim ad minim<\/p><div class=\"container\"><div class=\"row\"><div class=\"col col-md-4\"><div class=\"card\">\r\n <img class=\"card-img-top\" src=\"https:\/\/images.pexels.com\/photos\/567459\/pexels-photo-567459.jpeg?w=940&h=650&auto=compress&cs=tinysrgb\" alt=\"Card image cap\" data-image=\"oljz29fjzzgw\">\r\n <div class=\"card-body\">\r\n <h2 class=\"card-title\"><b>Philip Freeman<\/b><\/h2>\r\n <p class=\"card-text\">I don't think anybody knows it was Russia that wrote Lorem Ipsum, but I don't know, maybe it was. It could be Russia, but it could also be China. It could also be lots of other people. Ok? Lorem Ipsum is FAKE TEXT!<\/p>\r\n <\/div>\r\n <\/div><\/div><div class=\"col col-md-4\"><div class=\"card\">\r\n <img class=\"card-img-top\" src=\"https:\/\/images.pexels.com\/photos\/325682\/pexels-photo-325682.jpeg?w=940&h=650&auto=compress&cs=tinysrgb\" alt=\"Card image cap\" data-image=\"oljz29fjzzgw\">\r\n <div class=\"card-body\">\r\n <h2 class=\"card-title\"><b>David Smith<\/b><\/h2>\r\n <p class=\"card-text\">I don't think anybody knows it was Russia that wrote Lorem Ipsum, but I don't know, maybe it was. It could be Russia, but it could also be China. It could also be lots of other people. Ok? Lorem Ipsum is FAKE TEXT!<\/p>\r\n <\/div>\r\n <\/div><\/div><div class=\"col col-md-4\"><div class=\"card\">\r\n <img class=\"card-img-top\" src=\"https:\/\/images.pexels.com\/photos\/736716\/pexels-photo-736716.jpeg?auto=compress&cs=tinysrgb&dpr=2&h=650&w=940\" alt=\"Card image cap\" data-image=\"oljz29fjzzgw\">\r\n <div class=\"card-body\">\r\n <h2 class=\"card-title\"><b>Robert D'Costa<\/b><\/h2>\r\n <p class=\"card-text\">I dont think anybody knows it was Russia that wrote Lorem Ipsum, but I don't know, maybe it was. It could be Russia, but it could also be China. It could also be lots of other people. Ok? Lorem Ipsum is FAKE TEXT!<\/p>\r\n \r\n <\/div>\r\n <\/div><\/div><\/div><\/div><div class=\"bg-primary text-white text-center p-4 mt-4\"><h1 class=\"text-center\"><b> Want to know more about us?<\/b><\/h1><p class=\"lead text-white text-center mb-4\">Click the button below to contacts us<\/p><a class=\"btn btn-light\" href=\"\/contact-us\">Contact Us<\/a><\/div>",
"layout": "full_width",
"seo_title": null,
"seo_description": null,
"seo_thumbnail_url": null,
"metas": []
}Request
GET
api/page/{id}
URL Parameters
id string
ID of the page you want to fetch the details of.
Send Contact form response
The request helps in sending contact form responses to the admins and instructors of the platform. Generally this form is filled and sent by the students to enquire something regarding your product, course or the platform.
Example request:
curl -X POST \
"https://demo.aomlms.com/api/contact-form" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"firstName":"John","lastName":"Doe","email":"[email protected]","toEmail":"[email protected]","phoneNo":"1234567890","content":"A question about your course?"}'
const url = new URL(
"https://demo.aomlms.com/api/contact-form"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"firstName": "John",
"lastName": "Doe",
"email": "[email protected]",
"toEmail": "[email protected]",
"phoneNo": "1234567890",
"content": "A question about your course?"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Request
POST
api/contact-form
Body Parameters
firstName string
First Name of the sender.
lastName string optional
Last Name of the sender.
email string
Email of the sender.
toEmail string
Email of the receiver.
phoneNo string
Phone number of the sender.
content string
Content written by the sender.
Page Tabular List
Returns all the pages in a tabular list format in paginated mode. You can apply filter using search_param via pageName.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/pages/tabularlist?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22pageName%22%3A%22%22%7D&type=published" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/pages/tabularlist"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"pageName":""}",
"type": "published",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 6,
"recordsFiltered": 6,
"records": [
{
"id": 1,
"title": "Home Page",
"slug": "",
"author": "Aom Staff",
"identifier": "home",
"created_at": "Aug 03, 2020 09:31 AM"
},
{
"id": 2,
"title": "Product Listing",
"slug": "course-catalog",
"author": "Aom Staff",
"identifier": "catalog",
"created_at": "Aug 03, 2020 09:31 AM"
},
{
"id": 3,
"title": "About Us",
"slug": "about-us",
"author": "Aom Staff",
"identifier": "general",
"created_at": "Aug 03, 2020 09:31 AM"
},
{
"id": 4,
"title": "Checkout",
"slug": "checkout",
"author": "Aom Staff",
"identifier": "checkout",
"created_at": "Aug 03, 2020 09:31 AM"
},
{
"id": 5,
"title": "Cart",
"slug": "cart",
"author": "Aom Staff",
"identifier": "cart",
"created_at": "Aug 03, 2020 09:31 AM"
},
{
"id": 6,
"title": "Contact Us",
"slug": "contact-us",
"author": "Aom Staff",
"identifier": "general",
"created_at": "Aug 03, 2020 09:31 AM"
}
]
}Request
GET
api/pages/tabularlist
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on field names.
type string optional
Type of the page(trashed, published).
Save Layouts
To save layout, you need to use this request. (See parameters)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/pages/layouts" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"Homepage","context":"page","data":"<div class=\\\"header pt-4 mb-4\\\">\\","type":"saved"}'
const url = new URL(
"https://demo.aomlms.com/api/pages/layouts"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "Homepage",
"context": "page",
"data": "<div class=\\\"header pt-4 mb-4\\\">\\",
"type": "saved"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": "2",
"message": "Layout saved successfully"
}Request
POST
api/pages/layouts
Body Parameters
name string
Name of the page.
context string
Save Layout of page,section,row and module type. Context options: page, section, row or module.
data string
HTML content of the page.
type string
Type of the page is saved. Type options: predefined or saved.
Page Dropdown List
Returns page Id and name of the pages that user has ever created. Helps in showing the response in form elements like dropdown. (See response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/pages/dropdownlist?group_id=1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/pages/dropdownlist"
);
let params = {
"group_id": "1",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"id": 1,
"title": "Home Page"
},
{
"id": 2,
"title": "Product Listing"
},
{
"id": 3,
"title": "About Us"
},
{
"id": 4,
"title": "Checkout"
},
{
"id": 5,
"title": "Cart"
},
{
"id": 6,
"title": "Contact Us"
}
]Request
GET
api/pages/dropdownlist
Query Parameters
group_id string
ID of the group.
Timezone Dropdown List
Returns all timezones supported by php. Helps in showing the response in form elements like dropdown. (See response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/pages/timezoneList" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/pages/timezoneList"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
"Africa\/Abidjan",
"Africa\/Accra",
"Africa\/Addis_Ababa",
"Africa\/Algiers",
"Africa\/Asmara",
"..etc"
]Request
GET
api/pages/timezoneList
Page Layout Lookup
Retrieves all the layout lookups in list format. Helps while showing layouts in form elements like dropdown. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/pages/layout/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/pages/layout/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"db_value": "full_width",
"display_value": "Full Width"
},
{
"db_value": "fixed_width",
"display_value": "Fixed width with left\/right margin gaps"
},
{
"db_value": "no_header",
"display_value": "No Header\/Menus\/Footer"
}
]Request
GET
api/pages/layout/lookup
Save Page
If admins want to add new page, you can use this request to make one. Created pages will be seen by your users/students to interact with your platform and products. (See Parameter)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/pages" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"title":"About Us","content":"<div class=\"container\"><h1><b>About<\/b><\/h1> <\/div>","layout":"full_width","seo_title":"null","seo_description":"null","seo_thumbnail_url":"null"}'
const url = new URL(
"https://demo.aomlms.com/api/pages"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"title": "About Us",
"content": "<div class=\"container\"><h1><b>About<\/b><\/h1> <\/div>",
"layout": "full_width",
"seo_title": "null",
"seo_description": "null",
"seo_thumbnail_url": "null"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 1,
"message": "Page saved successfully"
}Request
POST
api/pages
Body Parameters
title string
Title for the page.
content string optional
Content(HTML, CSS, JS) for the page.
layout string
Layout type for the page. Layout options: full_width, no_header, fixed_width.
seo_title string optional
SEO title for the page.
seo_description string optional
SEO description for the page.
seo_thumbnail_url string optional
Thumbnail image for the page.
Soft Delete Page
To delete a page, you need to use this request. The pages will not be deleted permanently, it will be in draft mode. You can restore the page later. Returns page drafted(if multiple selected). (See Response)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/pages/delete" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"page_ids":[1,12,15]}'
const url = new URL(
"https://demo.aomlms.com/api/pages/delete"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"page_ids": [
1,
12,
15
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Page moved to draft successfully"
}Request
POST
api/pages/delete
Body Parameters
page_ids array
All page IDs which needs to be drafted.
Hard Delete Page
To delete a page, you need to use this request. The pages will be deleted permanently. In this case, you cannot restore the page after hard delete. Returns page drafted(if multiple selected). (See Response)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/pages/harddelete" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"page_ids":[1,12,15]}'
const url = new URL(
"https://demo.aomlms.com/api/pages/harddelete"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"page_ids": [
1,
12,
15
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Pages deleted permanently"
}Request
POST
api/pages/harddelete
Body Parameters
page_ids array
All page IDs which needs to be deleted.
Restore Page
To restore a page, you need to use this request. The pages will be restored from draft mode to published mode. Returns page retored(if multiple selected). (See Response)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/pages/restore" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"page_ids":[1,12,15]}'
const url = new URL(
"https://demo.aomlms.com/api/pages/restore"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"page_ids": [
1,
12,
15
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Page restored successfully"
}Request
POST
api/pages/restore
Body Parameters
page_ids array
All page IDs which needs to be restored.
Update Slug
Updates the slug of the page. Example - old-awesome-page to new-awesome-page
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/page/update-slug/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"slug":"about-us"}'
const url = new URL(
"https://demo.aomlms.com/api/page/update-slug/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"slug": "about-us"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
"about-us"Request
PUT
api/page/update-slug/{id}
URL Parameters
id string
The ID of the page.
Body Parameters
slug required optional
New slug for the page.
Update Page
If admins want to update an existing page, you can use this request to update one. Updates existing items of the page. Pages will be seen by your users/students to interact with your platform and products. (See Parameter)
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/page/3" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"title":"About Us","content":"<div class=\"container\"><h1><b>About Us<\/b><\/h1> <\/div>","layout":"full_width","seo_title":"null","seo_description":"null","seo_thumbnail_url":"null"}'
const url = new URL(
"https://demo.aomlms.com/api/page/3"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"title": "About Us",
"content": "<div class=\"container\"><h1><b>About Us<\/b><\/h1> <\/div>",
"layout": "full_width",
"seo_title": "null",
"seo_description": "null",
"seo_thumbnail_url": "null"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 3,
"message": "Page updated successfully"
}Request
PUT
api/page/{id}
URL Parameters
id string
ID of the page that needs to be updated.
Body Parameters
title string
Title for the page.
content string optional
Content(HTML, CSS, JS) for the page.
layout string
Layout type for the page. Layout options: full_width, no_header, fixed_width.
seo_title string optional
SEO title for the page.
seo_description string optional
SEO description for the page.
seo_thumbnail_url string optional
Thumbnail image for the page.
PDFs
A PDF Module is a lesson module used as course content. Helps to perform CRUD operation to and for PDF modules.
PDF Modules Tabular List
Returns all the PDF modules in a tabular list format in paginated mode. You can apply filter using search_param via associatedCourse(modules used in course) and moduleName.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/modules/pdf?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22associatedCourse%22%3A%22%22%2C%22moduleName%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/modules/pdf"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"associatedCourse":"","moduleName":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"id": 6,
"name": "Getting Started",
"slug": "getting-started",
"type": "pdf",
"icon": "<i class=\"el-icon-document\"><\/i>",
"author": "Aom Staff",
"created_at": "Aug 10, 2020 05:55 PM"
}
]
}Request
GET
api/modules/pdf
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on field names.
Create PDF Module
To create a pdf module, you need to use this request. (See parameters) Created pdf modules can be used in the course as course content/lesson.
Returns : id of the pdf module created and successfull message
Example request:
curl -X POST \
"https://demo.aomlms.com/api/modules/pdf" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"Getting Started","content":"blanditiis","instructions":"<p>This is the short description here<\/p>","url":"https:\/\/drive.google.com\/file\/d\/0B5cbJMbHsJ1gc3RhcnRlcl9maWX2Rhc2hlclYw\/view?usp=sharing","trackCompletion":true,"allowDownload":true,"defaultZoom":"75%","showSidebar":true}'
const url = new URL(
"https://demo.aomlms.com/api/modules/pdf"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "Getting Started",
"content": "blanditiis",
"instructions": "<p>This is the short description here<\/p>",
"url": "https:\/\/drive.google.com\/file\/d\/0B5cbJMbHsJ1gc3RhcnRlcl9maWX2Rhc2hlclYw\/view?usp=sharing",
"trackCompletion": true,
"allowDownload": true,
"defaultZoom": "75%",
"showSidebar": true
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 6,
"message": "Module saved successfully"
}Request
POST
api/modules/pdf
Body Parameters
name string
Name of the pdf module.
content string
Content for the pdf module that students will see. Example:
instructions string
Description for the pdf module that students will see.
url string
URL or actual path of the pdf module that students will see.
trackCompletion boolean
If true, the module is being tracked(whether its finished or not) in course player.
allowDownload boolean
If true, the pdf can be downloaded(by the students) otherwise not in course player.
defaultZoom string
The pdf will open with the set zoom percentage in course player.
showSidebar boolean optional
If true, the pdf will open with a sidebar in course player.
Retrieve PDF module
Retrieves the details of the specified pdf module. Helps in fetching pdf module using module ID. (See Parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/modules/pdf/23" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/modules/pdf/23"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "Getting Started",
"slug": "getting-started",
"content": null,
"url": "https:\/\/drive.google.com\/file\/d\/0B5cbJMbHsJ1gc3RhcnRlcl9maWxlX2Rhc2hlclYw\/view?usp=sharing",
"allowDownload": false,
"trackCompletion": true,
"defaultZoom": "page_width",
"showSidebar": true
}Request
GET
api/modules/pdf/{id}
URL Parameters
id string
ID of the pdf module you want to fetch the details of.
Update PDF Module
Updates the details of a specified pdf module. (See parameters) PDF modules can be used in the course as course content/lesson.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/modules/pdf/6" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"Getting Started","content":"<p>This is the updated short content here<\/p>","url":"https:\/\/drive.google.com\/file\/d\/0B5cbJMbHsJ1gc3RhcnRlcl9ma2Rhc2hlclYw\/view?usp=sharing","trackCompletion":true,"allowDownload":true,"defaultZoom":"75%","showSidebar":true}'
const url = new URL(
"https://demo.aomlms.com/api/modules/pdf/6"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "Getting Started",
"content": "<p>This is the updated short content here<\/p>",
"url": "https:\/\/drive.google.com\/file\/d\/0B5cbJMbHsJ1gc3RhcnRlcl9ma2Rhc2hlclYw\/view?usp=sharing",
"trackCompletion": true,
"allowDownload": true,
"defaultZoom": "75%",
"showSidebar": true
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Module updated successfully"
}Request
PUT
api/modules/pdf/{id}
URL Parameters
id string
ID of the pdf module.
Body Parameters
name string
Name of the pdf module.
content string
Content for the text modules that students will see.
url string
URL or actual path of the pdf module that students will see.
trackCompletion boolean
If true, the module is being tracked(whether its finished or not) in course player.
allowDownload boolean
If true, the pdf can be downloaded(by the students) otherwise not in course player.
defaultZoom string
The pdf will open with the set zoom percentage in course player.
showSidebar boolean optional
If true, the pdf will open with a sidebar in course player.
Retrieve Detailed PDF Module Info
Retrieves details of pdf module in depth as well as different modules details that are being used as course content for the same course the current pdf module is attached to. Returns related fields value. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/module/pdf/details?registrationId=1&moduleId=6" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/module/pdf/details"
);
let params = {
"registrationId": "1",
"moduleId": "6",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "test",
"slug": "test",
"content": "<p>afegrshtdh<\/p>",
"courseName": "course 1",
"courseSlug": "http:\/\/localhost:8000\/course\/course-1",
"trackCompletion": true,
"min_time_spent": 0,
"otherModules": [
{
"module_id": 1,
"name": "test",
"slug": "test",
"type": "text",
"icon": "<i class=\"el-icon-tickets\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": 1,
"status": "Completed",
"started_on": "2020-08-03T10:02:33.000000Z",
"completed_on": "2020-08-03T10:02:41.000000Z",
"last_accessed_on": "1 week ago",
"total_time_spent": {
"hours": 0,
"minutes": 0,
"seconds": 6,
"totalSeconds": 6
},
"completion_percentage": 100,
"no_of_times_accessed": 1
},
{
"module_id": 4,
"name": "assign",
"slug": "assign",
"type": "assignment",
"icon": "<i class=\"el-icon-edit-outline\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": true,
"status_row_id": -1,
"status": "Not Started",
"started_on": "",
"completed_on": "",
"last_accessed_on": "Never",
"total_time_spent": "",
"points_awarded": "",
"completion_percentage": 0,
"no_of_times_accessed": 0
}
],
"launchCheck": {
"canbeLaunched": true,
"errTitle": "",
"errDesc": ""
},
"prevSlug": "",
"nextSlug": "assign",
"status": "Completed",
"timeSpent": 6,
"statusRowId": 1
}Request
GET
api/module/pdf/details
Query Parameters
registrationId string
ID of the course Registration for which this module is attached to.
moduleId string
ID of the pdf module.
Retrieve Detailed PDF module Info as Membership content
Retrieves details of pdf module in depth for the same membership the current pdf module is attached to. Returns related fields value. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/module/pdf/content-details?moduleId=6" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/module/pdf/content-details"
);
let params = {
"moduleId": "6",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "test",
"slug": "test",
"content": "<p>afegrshtdh<\/p>",
"trackCompletion": true,
"min_time_spent": 0,
"timeSpent": 6
}Request
GET
api/module/pdf/content-details
Query Parameters
moduleId string
ID of the pdf module.
Powerpoint
A Powerpoint Module is used as course content. Helps to perform CRUD operation to and for Powerpoint modules.
Powerpoint Modules Tabular List
Returns all the Powerpoint modules in a tabular list format in paginated mode. You can apply filter using search_param via associatedCourse(modules used in course) and moduleName.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/modules/powerpoint?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22associatedCourse%22%3A%22%22%2C%22moduleName%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/modules/powerpoint"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"associatedCourse":"","moduleName":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"id": 6,
"name": "Getting Started",
"slug": "getting-started",
"type": "powerpoint",
"icon": "<i class=\"el-icon-document\"><\/i>",
"author": "Aom Staff",
"created_at": "Aug 10, 2020 05:55 PM"
}
]
}Request
GET
api/modules/powerpoint
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on field names.
Create Powerpoint Module
To create a Powerpoint module, you need to use this request. (See parameters) Created Powerpoint modules can be used in the course as course content/lesson.
Returns : id of the Powerpoint module created and successfull message
Example request:
curl -X POST \
"https://demo.aomlms.com/api/modules/powerpoint" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"Getting Started","viewer":"google_viewer","content":"animi","url":"https:\/\/drive.google.com\/file\/d\/0B5cbJMbHsJ1gc3RhcnRlcl9maWX2Rhc2hlclYw\/view?usp=sharing"}'
const url = new URL(
"https://demo.aomlms.com/api/modules/powerpoint"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "Getting Started",
"viewer": "google_viewer",
"content": "animi",
"url": "https:\/\/drive.google.com\/file\/d\/0B5cbJMbHsJ1gc3RhcnRlcl9maWX2Rhc2hlclYw\/view?usp=sharing"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 6,
"message": "Module saved successfully"
}Request
POST
api/modules/powerpoint
Body Parameters
name string
Name of the Powerpoint module.
viewer enum optional
microsoft_office, google_viewer.
content string
Content for the Powerpoint module that students will see. Example:
url string
URL or actual path of the Powerpoint module that students will see.
Retrieve Powerpoint module
Retrieves the details of the specified Powerpoint module. Helps in fetching Powerpoint module using module ID. (See Parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/modules/powerpoint/23" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/modules/powerpoint/23"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{"name":"Getting Started","slug":"getting-started","viewer":google_viewer, "content":null,"url":"https:\/\/drive.google.com\/file\/d\/0B5cbJMbHsJ1gc3RhcnRlcl9maWxlX2Rhc2hlclYw\/view?usp=sharing"}Request
GET
api/modules/powerpoint/{id}
URL Parameters
id string
ID of the Powerpoint module you want to fetch the details of.
Update Powerpoint Module
Updates the details of a specified Powerpoint module. (See parameters) Powerpoint modules can be used in the course as course content/lesson.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/modules/powerpoint/6" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"Getting Started","viewer":true,"content":"<p>This is the updated short content here<\/p>","url":"https:\/\/drive.google.com\/file\/d\/0B5cbJMbHsJ1gc3RhcnRlcl9ma2Rhc2hlclYw\/view?usp=sharing"}'
const url = new URL(
"https://demo.aomlms.com/api/modules/powerpoint/6"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "Getting Started",
"viewer": true,
"content": "<p>This is the updated short content here<\/p>",
"url": "https:\/\/drive.google.com\/file\/d\/0B5cbJMbHsJ1gc3RhcnRlcl9ma2Rhc2hlclYw\/view?usp=sharing"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Module updated successfully"
}Request
PUT
api/modules/powerpoint/{id}
URL Parameters
id string
ID of the Powerpoint module.
Body Parameters
name string
Name of the Powerpoint module.
viewer boolean optional
microsoft_office, google_viewer.
content string
Content for the text modules that students will see.
url string
URL or actual path of the Powerpoint module that students will see.
Retrieve Detailed Powerpoint Module Info
Retrieves details of Powerpoint module in depth as well as different modules details that are being used as course content for the same course the current Powerpoint module is attached to. Returns related fields value. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/module/powerpoint/details?registrationId=1&moduleId=6" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/module/powerpoint/details"
);
let params = {
"registrationId": "1",
"moduleId": "6",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "test",
"slug": "test",
"content": "<p>afegrshtdh<\/p>",
"courseName": "course 1",
"courseSlug": "http:\/\/localhost:8000\/course\/course-1",
"otherModules": [
{
"module_id": 1,
"name": "test",
"slug": "test",
"type": "text",
"icon": "<i class=\"el-icon-tickets\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": 1,
"status": "Completed",
"started_on": "2020-08-03T10:02:33.000000Z",
"completed_on": "2020-08-03T10:02:41.000000Z",
"last_accessed_on": "1 week ago",
"total_time_spent": {
"hours": 0,
"minutes": 0,
"seconds": 6,
"totalSeconds": 6
},
"completion_percentage": 100,
"no_of_times_accessed": 1
},
{
"module_id": 4,
"name": "assign",
"slug": "assign",
"type": "assignment",
"icon": "<i class=\"el-icon-edit-outline\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": true,
"status_row_id": -1,
"status": "Not Started",
"started_on": "",
"completed_on": "",
"last_accessed_on": "Never",
"total_time_spent": "",
"points_awarded": "",
"completion_percentage": 0,
"no_of_times_accessed": 0
}
],
"launchCheck": {
"canbeLaunched": true,
"errTitle": "",
"errDesc": ""
},
"prevSlug": "",
"nextSlug": "assign",
"status": "Completed",
"timeSpent": 6,
"statusRowId": 1
}Request
GET
api/module/powerpoint/details
Query Parameters
registrationId string
ID of the course Registration for which this module is attached to.
moduleId string
ID of the Powerpoint module.
Retrieve Detailed Powerpoint module Info as Membership content
Retrieves details of Powerpoint module in depth for the same membership the current Powerpoint module is attached to. Returns related fields value. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/module/powerpoint/content-details?moduleId=6" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/module/powerpoint/content-details"
);
let params = {
"moduleId": "6",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{"name":"test","slug":"test","viewer":microsoft_office,"url":"","content":"<p>afegrshtdh<\/p>"}Request
GET
api/module/powerpoint/content-details
Query Parameters
moduleId string
ID of the Powerpoint module.
Questions
Manage Questions. Questions can be added in the Quiz module for students to answer. Helps to perform CRUD operations for and to questions.
Questions Tabular List
Returns all the questions in a tabular list format in paginated mode. You can apply filter using search_param via questionTypes, questionCategoryIds, questionName and quizModuleId(module ID the question belongs to).
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/questions/tabularlist?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22questionTypes%22%3A%5B%5D%2C%22questionCategoryIds%22%3A%5B%5D%2C%22questionName%22%3A%22%22%2C%22quizModuleId%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/questions/tabularlist"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"questionTypes":[],"questionCategoryIds":[],"questionName":"","quizModuleId":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 3,
"recordsFiltered": 3,
"records": [
{
"id": 3,
"title": "Is red a color?",
"type": "multiple_choice",
"categories": "",
"author": "Aom Staff",
"created_at": "Aug 10, 2020 06:34 PM"
},
{
"id": 2,
"title": "Is Newyork a city?",
"type": "multiple_choice",
"categories": "",
"author": "Aom Staff",
"created_at": "Aug 10, 2020 06:33 PM"
},
{
"id": 1,
"title": "Is blue a color?",
"type": "multiple_choice",
"categories": "",
"author": "Aom Staff",
"created_at": "Aug 10, 2020 06:33 PM"
}
]
}Request
GET
api/questions/tabularlist
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on field names.
Question Type Lookups
Retrieves all types of the questions. Helps showing options in form elements like dropdowns.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/questions/type/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/questions/type/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"db_value": "multiple_choice",
"display_value": "Multiple Choice"
},
{
"db_value": "multiple_correct",
"display_value": "Multiple Correct"
},
{
"db_value": "short_answers",
"display_value": "Short Answers"
}
]Request
GET
api/questions/type/lookup
Question Lookup
Retrieves all the questions. Helps while showing questions in form elements like dropdown. You can apply filters using search_term(question) parameter. (See Parameter)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/question/lookup?search_term=accusantium" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/question/lookup"
);
let params = {
"search_term": "accusantium",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"value": 1,
"label": "Is blue a color?"
},
{
"value": 2,
"label": "Is Newyork a city?"
},
{
"value": 3,
"label": "Is red a color?"
}
]Request
GET
api/question/lookup
Query Parameters
search_term string
You need to provide questions or substring of the questions to search for that module.
Quick Edit
Updates the details in bulk for a specified question. Parameters is provided which needs to be updated. (See Parameters)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/questions/quickEdit" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"question_ids":[3,2],"author_id":1,"categories_id":[6]}'
const url = new URL(
"https://demo.aomlms.com/api/questions/quickEdit"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"question_ids": [
3,
2
],
"author_id": 1,
"categories_id": [
6
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Questions updated Successfully"
}Request
POST
api/questions/quickEdit
Body Parameters
question_ids array
All question IDs which needs to be updated.
author_id integer optional
Update the instructor/Author for the selected modules.
categories_id array optional
Update the categories of selected questions.
Create Question
To create a question, you need to use this request. (See parameters) Created questions can be used in the quizzes as quiz's content.
Returns : id of the question created and successfull message
Example request:
curl -X POST \
"https://demo.aomlms.com/api/questions" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"title":"Q1","type":"multiple_choice","content":"<p>This is the short content here<\/p>","hint":"SpaceX owner","explanation":"Elon owns Tesla car company","categories":[12,16],"options":[]}'
const url = new URL(
"https://demo.aomlms.com/api/questions"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"title": "Q1",
"type": "multiple_choice",
"content": "<p>This is the short content here<\/p>",
"hint": "SpaceX owner",
"explanation": "Elon owns Tesla car company",
"categories": [
12,
16
],
"options": []
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 4,
"message": "Question saved successfully"
}Request
POST
api/questions
Body Parameters
title string
Title of the question.
type string
Type of the question. Type options: multiple_choice, multiple_correct or short_answers.
content string
Content for the text modules that students will see.
hint string optional
Hint for the question for students.
explanation string optional
Explanation of the answer for students.
categories array optional
Categories for the question.
options array optional
Options and correct answer for this question.
Retrieve Question
Retrieves the details of the specified question. Helps in fetching question using its ID. (See Parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/question/3" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/question/3"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"title": "Is red a color?",
"content": null,
"hint": null,
"explanation": null,
"type": "multiple_choice",
"categories": [],
"options": []
}Request
GET
api/question/{id}
URL Parameters
id string
ID of the question you want to fetch the details of.
Update Question
Updates the details of a specified question. (See parameters) Questions can be used in the quizzes as quiz's content.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/question/{id}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"title":"Q1","type":"multiple_choice","content":"<p>This is the short content here<\/p>","hint":"SpaceX owner","explanation":"Elon owns Tesla car company","categories":[12,16],"options":[]}'
const url = new URL(
"https://demo.aomlms.com/api/question/{id}"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"title": "Q1",
"type": "multiple_choice",
"content": "<p>This is the short content here<\/p>",
"hint": "SpaceX owner",
"explanation": "Elon owns Tesla car company",
"categories": [
12,
16
],
"options": []
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Question updated successfully"
}Request
PUT
api/question/{id}
Body Parameters
title string
Title of the question.
type string
Type of the question. Type options: multiple_choice, multiple_correct or short_answers.
content string
Content for the text modules that students will see.
hint string optional
Hint for the question for students.
explanation string optional
Explanation of the answer for students.
categories array optional
Categories for the question.
options array optional
Options and correct answer for this question.
Delete Question
To delete a question, you need to use this request. Returns number of question deleted(if multiple selected) and also not deleted. (See Response)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/question/delete" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"delete_ids":[1,12,15]}'
const url = new URL(
"https://demo.aomlms.com/api/question/delete"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"delete_ids": [
1,
12,
15
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "2 question(s) deleted 1 question(s) not deleted as it is used in quiz. Please remove the question(s) from the quiz and try again."
}Request
POST
api/question/delete
Body Parameters
delete_ids array
All question IDs which needs to be deleted.
Bulk-Upload Questions
To add questions to existing/new quiz in bulk, you need to use this request. Returns number of question added and skipped and also any errors occurred while uploading. (See Response)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/question/bulkUpload" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"questionList":[["Question_Type","Question_Title","Question_Content","Question_Category","Answer_Hint","Answer_Explanation","Correct_Answer","Option_1","Option_2","Option_3","Option_4"],["multiple_choice","Question1","Test",null,null,null,1,"choice1","choice2","choice3","choice4"],["multiple_correct","Question2","Test",null,null,null,"1,2","choice1","choice2","choice3","choice4"],["short_answers","Question3","Test",null,null,null,null,"possible_answer1","possible_answer2","possible_answer3","possible_answer4"]],"quizIds":[7],"quiztype":"existing_quiz","newQuiz":"null"}'
const url = new URL(
"https://demo.aomlms.com/api/question/bulkUpload"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"questionList": [
[
"Question_Type",
"Question_Title",
"Question_Content",
"Question_Category",
"Answer_Hint",
"Answer_Explanation",
"Correct_Answer",
"Option_1",
"Option_2",
"Option_3",
"Option_4"
],
[
"multiple_choice",
"Question1",
"Test",
null,
null,
null,
1,
"choice1",
"choice2",
"choice3",
"choice4"
],
[
"multiple_correct",
"Question2",
"Test",
null,
null,
null,
"1,2",
"choice1",
"choice2",
"choice3",
"choice4"
],
[
"short_answers",
"Question3",
"Test",
null,
null,
null,
null,
"possible_answer1",
"possible_answer2",
"possible_answer3",
"possible_answer4"
]
],
"quizIds": [
7
],
"quiztype": "existing_quiz",
"newQuiz": "null"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Questions(s) uploaded successfully",
"errors": [],
"successfulRow": 3,
"skipped": 0,
"insertedQuestions": [
{
"id": 5,
"title": "Question1"
},
{
"id": 6,
"title": "Question2"
},
{
"id": 7,
"title": "Question3"
}
]
}Request
POST
api/question/bulkUpload
Body Parameters
questionList array
All questions which needs to be added(should in excel data form).
quizIds array
All existing quizzes the questions are going to be added.
quiztype string
Whether the questions are going to be added in new or existing quizzes.
newQuiz string optional
Name of the new Quiz, the questions are going to be added.
Quizzes
A Quiz Module is a quiz used as course content. Helps to perform CRUD operation to and for quiz modules.
Quiz Modules Tabular List
Returns all the quiz modules in a tabular list format in paginated mode. You can apply filter using search_param via associatedCourse(modules used in course) and moduleName.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/modules/quiz?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22associatedCourse%22%3A%22%22%2C%22moduleName%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/modules/quiz"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"associatedCourse":"","moduleName":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 2,
"recordsFiltered": 2,
"records": [
{
"id": 8,
"name": "Quiz-2",
"slug": "quiz-2",
"type": "quiz",
"quizType": "static",
"totalQuestions": 1,
"icon": "<i class=\"el-icon-discover\"><\/i>",
"author": "Aom Staff",
"created_at": "Aug 10, 2020 06:34 PM"
},
{
"id": 7,
"name": "First-quiz",
"slug": "first-quiz",
"type": "quiz",
"quizType": "static",
"totalQuestions": 2,
"icon": "<i class=\"el-icon-discover\"><\/i>",
"author": "Aom Staff",
"created_at": "Aug 10, 2020 06:34 PM"
}
]
}Request
GET
api/modules/quiz
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
for searching items based on field names.
Create Quiz Module
To create a quiz module, you need to use this request. (See parameters) Created quiz modules can be used in the course as course content.
Returns : id of the quiz module created and successfull message
Example request:
curl -X POST \
"https://demo.aomlms.com/api/modules/quiz" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"Quiz-2","content":"<p>Some content here<p>","type":"static","forceSequential":false,"minimumPassingMarks":75,"noOfRetakesAllowed":3,"questionCategories":[3,4],"questions":[],"showCorrectAnswerOption":"always","shuffleQuestions":false,"maxSpentHour":"1","maxSpentMinutes":"30"}'
const url = new URL(
"https://demo.aomlms.com/api/modules/quiz"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "Quiz-2",
"content": "<p>Some content here<p>",
"type": "static",
"forceSequential": false,
"minimumPassingMarks": 75,
"noOfRetakesAllowed": 3,
"questionCategories": [
3,
4
],
"questions": [],
"showCorrectAnswerOption": "always",
"shuffleQuestions": false,
"maxSpentHour": "1",
"maxSpentMinutes": "30"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 8,
"message": "Module saved successfully"
}Request
POST
api/modules/quiz
Body Parameters
name string
Name of the pdf module.
content string optional
Content for the pdf module that students will see.
type string
Type of the quiz. Type options: static or dynamic.
forceSequential boolean
Question will be returned in the same order while created.
minimumPassingMarks integer optional
Student should cover atleast this number to pass the quiz.
noOfRetakesAllowed integer optional
Number of attempts student can make to take the quiz.
questionCategories array optional
Categories of the question.
questions array optional
All questions attached to this quiz.
showCorrectAnswerOption string
After attempting the quiz, show the correct answer. Options: always, never,not_till_retake_allowed.
shuffleQuestions boolean
Shuffle the questions?.
maxSpentHour string
Maximum hours to be spend in quiz after that it will auto submit.
maxSpentMinutes string
Maximum minutes to be spend in quiz after that it will auto submit.
Retrieve Quiz module
Retrieves the details of the specified quiz module. Helps in fetching quiz module using module ID. (See Parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/modules/quiz/23" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/modules/quiz/23"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "First-quiz",
"slug": "first-quiz",
"content": null,
"type": "static",
"shuffleQuestions": false,
"forceSequential": false,
"showCorrectAnswerOption": "always",
"noOfRetakesAllowed": null,
"minimumPassingMarks": null,
"questions": [
{
"id": 1,
"title": "Is blue a color?"
},
{
"id": 2,
"title": "Is Newyork a city?"
}
],
"questionCategories": [],
"maxSpentHour": 1,
"maxSpentMinutes": 30
}Request
GET
api/modules/quiz/{id}
URL Parameters
id string
ID of the quiz module you want to fetch the details of.
Update Quiz Module
Updates the details of a specified quiz module. (See parameters) Quiz modules can be used in the course as course content.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/modules/quiz/{id}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"Quiz-2","content":"<p>Some content here<p>","type":"static","forceSequential":false,"minimumPassingMarks":75,"noOfRetakesAllowed":3,"questionCategories":[3,4],"questions":[],"showCorrectAnswerOption":"always","shuffleQuestions":false,"maxSpentHour":"1","maxSpentMinutes":"30"}'
const url = new URL(
"https://demo.aomlms.com/api/modules/quiz/{id}"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "Quiz-2",
"content": "<p>Some content here<p>",
"type": "static",
"forceSequential": false,
"minimumPassingMarks": 75,
"noOfRetakesAllowed": 3,
"questionCategories": [
3,
4
],
"questions": [],
"showCorrectAnswerOption": "always",
"shuffleQuestions": false,
"maxSpentHour": "1",
"maxSpentMinutes": "30"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 8,
"message": "Module saved successfully"
}Request
PUT
api/modules/quiz/{id}
Body Parameters
name string
Name of the pdf module.
content string optional
Content for the pdf module that students will see.
type string
Type of the quiz. Type options: static or dynamic.
forceSequential boolean
Question will be returned in the same order while created.
minimumPassingMarks integer optional
Student should cover atleast this number to pass the quiz.
noOfRetakesAllowed integer optional
Number of attempts student can make to take the quiz.
questionCategories array optional
Categories of the question.
questions array optional
All questions attached to this quiz.
showCorrectAnswerOption string
After attempting the quiz, show the correct answer. Options: always, never,not_till_retake_allowed.
shuffleQuestions boolean
Shuffle the questions?.
maxSpentHour string
Maximum hours to be spend in quiz after that it will auto submit.
maxSpentMinutes string
Maximum minutes to be spend in quiz after that it will auto submit.
Retrieve Detailed Quiz Module Info
Retrieves details of quiz module in depth as well as different modules details that are being used as course content for the same course the current quiz module is attached to. Returns related fields value. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/module/quiz/details?registrationId=1&moduleId=6" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/module/quiz/details"
);
let params = {
"registrationId": "1",
"moduleId": "6",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "test",
"slug": "test",
"content": "<p>afegrshtdh<\/p>",
"courseName": "course 1",
"courseSlug": "http:\/\/localhost:8000\/course\/course-1",
"trackCompletion": true,
"min_time_spent": 0,
"otherModules": [
{
"module_id": 1,
"name": "test",
"slug": "test",
"type": "text",
"icon": "<i class=\"el-icon-tickets\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": 1,
"status": "Completed",
"started_on": "2020-08-03T10:02:33.000000Z",
"completed_on": "2020-08-03T10:02:41.000000Z",
"last_accessed_on": "1 week ago",
"total_time_spent": {
"hours": 0,
"minutes": 0,
"seconds": 6,
"totalSeconds": 6
},
"completion_percentage": 100,
"no_of_times_accessed": 1
},
{
"module_id": 4,
"name": "assign",
"slug": "assign",
"type": "assignment",
"icon": "<i class=\"el-icon-edit-outline\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": true,
"status_row_id": -1,
"status": "Not Started",
"started_on": "",
"completed_on": "",
"last_accessed_on": "Never",
"total_time_spent": "",
"points_awarded": "",
"completion_percentage": 0,
"no_of_times_accessed": 0
}
],
"launchCheck": {
"canbeLaunched": true,
"errTitle": "",
"errDesc": ""
},
"prevSlug": "",
"nextSlug": "assign",
"status": "Completed",
"timeSpent": 6,
"statusRowId": 1
}Request
GET
api/module/quiz/details
Query Parameters
registrationId string
ID of the course Registration for which this module is attached to.
moduleId string
ID of the quiz module.
Save Answer
Save answer that is being selected by the student while taking the quiz. (See Parameters)
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/modules/quiz/7/saveAnswer?questionId=1&moduleStatusId=7&markedAnswer=yes&retakeCounter=2" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/modules/quiz/7/saveAnswer"
);
let params = {
"questionId": "1",
"moduleStatusId": "7",
"markedAnswer": "yes",
"retakeCounter": "2",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 7,
"message": "Answer saved successfully"
}Request
PUT
api/modules/quiz/{id}/saveAnswer
URL Parameters
id string
ID of the quiz module.
Query Parameters
questionId string
ID of the question is user is answering.
moduleStatusId string
ID of the Module status of the current quiz.
markedAnswer string
Answer marked by the user.
retakeCounter string
Quiz Retake count.
Submit Quiz
Submits the quiz after attempting all the questions of the quiz. Updates the status of quiz to completed if student is finished the quiz and submits. (See Parameters)
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/modules/quiz/7/submitQuiz" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"questions":"[]","statusRowId":"7","retakeCounter":"2"}'
const url = new URL(
"https://demo.aomlms.com/api/modules/quiz/7/submitQuiz"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"questions": "[]",
"statusRowId": "7",
"retakeCounter": "2"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Quiz Submitted Successfully"
}Request
PUT
api/modules/quiz/{id}/submitQuiz
URL Parameters
id string
ID of the quiz module.
Body Parameters
questions required optional
All questions in current quiz.
statusRowId required optional
ID of the Module status of the current quiz.
retakeCounter required optional
Quiz Retake count.
Retrieve Quiz Results
Retrieves the result of the quiz the student have taken. Helping to decide whether to assign certificate to a student. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/module/quiz/results?statusRowId=7" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/module/quiz/results"
);
let params = {
"statusRowId": "7",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "First-quiz",
"slug": "first-quiz",
"status": "In Progress",
"isRetakeAllowed": false,
"totalRetakeallowed": 1,
"attemptCount": 1,
"timeSpent": {
"hours": 0,
"minutes": 0,
"seconds": 16,
"totalSeconds": 16
},
"questions": [
{
"id": 1,
"title": "Is blue a color?",
"content": null,
"explanation": null,
"is_correct": false,
"marked_answer": [],
"correct_answer": []
},
{
"id": 2,
"title": "Is Newyork a city?",
"content": null,
"explanation": null,
"is_correct": false,
"marked_answer": [],
"correct_answer": []
}
],
"showCorrectAnswerOption": true,
"minimumPassingMarks": null,
"totalQuestions": 2,
"totalCorrect": 0,
"totalInCorrect": 2,
"minimumPassingAchieved": false
}Request
GET
api/module/quiz/results
Query Parameters
statusRowId string
ID of the Module status of the current quiz.
Static Quiz Lookup
Retrieves all the static quiz user has ever created. This request helps in showing all static quiz in form elements like dropdown, etc. Returns ID and name of the static quiz.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/static-quiz/dropdownlist" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/static-quiz/dropdownlist"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"value": 7,
"label": "First-quiz"
},
{
"value": 8,
"label": "Quiz-2"
}
]Request
GET
api/static-quiz/dropdownlist
Salesforce Integration
It allows you to track student activity and progress in the LMS, and trigger changes in Salesforce data accordingly.
Salesforce Event Lookup
Retrieves all the events for the salesforce actions. Helps showing options in dropdowns elements
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/integrations/salesforce/eventLookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/integrations/salesforce/eventLookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"db_value": "new_account_created",
"display_value": "New Account Created",
"crud_op": "Create",
"salesforce_crud": "[{'db_value' => 'salesforce_contact'},{'display_value'=> 'Salesforce Contacts'}]"
},
{
"db_value": "Account Updated",
"display_value": "Account Updated",
"crud_op": "Update",
"salesforce_crud": "[['db_value' => 'salesforce_contact', 'display_value'=> 'Salesforce Contacts']]"
},
{
"db_value": "course_enrolled",
"display_value": "Enrolled in a course",
"crud_op": "Update",
"salesforce_crud": "[['db_value' => 'salesforce_contact', 'display_value'=> 'Salesforce Contacts']]"
},
{
"db_value": "course_completed",
"display_value": "Course Completed",
"crud_op": "Update",
"salesforce_crud": "[['db_value' => 'salesforce_contact', 'display_value'=> 'Salesforce Contacts']]"
},
{
"db_value": "course_started",
"display_value": "Course Started",
"crud_op": "Update",
"salesforce_crud": "[['db_value' => 'salesforce_contact', 'display_value'=> 'Salesforce Contacts']]"
}
]Request
GET
api/integrations/salesforce/eventLookup
Salesforce Field Lookup
Retrieves all the fields for the salesforce. Helps showing options in dropdowns elements
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/integrations/salesforce/fieldLookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"type":"contact"}'
const url = new URL(
"https://demo.aomlms.com/api/integrations/salesforce/fieldLookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"type": "contact"
}
fetch(url, {
method: "GET",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"lms_fields": [
{
"db_value": "email"
},
{
"db_value": "last_name"
},
{
"db_value": "first_name"
},
{
"db_value": "last_login_ip"
},
{
"db_value": "is_disabled"
}
]
},
{
"salesforce_fields": [
{
"db_value": "email"
},
{
"db_value": "last_name"
},
{
"db_value": "first_name"
}
]
},
{
"courses": []
}
]Request
GET
api/integrations/salesforce/fieldLookup
Body Parameters
type string
Type to get the data, it can be contact.
Salesforce Tabular List
Returns all the salesforce details in a tabular list. You can apply filter using search_param via events.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/salesforces?order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22name%22%3A%22%22%2C%22scormTypes%22%3A%5B%5D%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/salesforces"
);
let params = {
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"name":"","scormTypes":[]}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"id": 1,
"event": "New Account Created",
"object": "",
"action": "",
"event_display_value": "",
"author": "Aom Staff",
"created_at": "Aug 03, 2020 11:03 AM"
}
]
}Request
GET
api/salesforces
Query Parameters
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on field names.
Create Salesforce Action
To create a Salesforce Action, you need to use this request. Provide event,action and object and it will be created. (See parameters)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/salesforce/action/create" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"event":"New Account Created","action":"create.","object":"Salesforce Contact"}'
const url = new URL(
"https://demo.aomlms.com/api/salesforce/action/create"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"event": "New Account Created",
"action": "create.",
"object": "Salesforce Contact"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Action created Successfully"
}Request
POST
api/salesforce/action/create
Body Parameters
event string
Event in which you want to send data.
action string
Action will be create of the event by default.
object string
Select the object from the dropdown list from Salesforce Contact.
Save Salesforce Mapping
To save a Salesforce Mapping, you need to use this request. Provide type and it will be created. (See parameters)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/salesforce/mapping/save" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"type":"salesforce_contact"}'
const url = new URL(
"https://demo.aomlms.com/api/salesforce/mapping/save"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"type": "salesforce_contact"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"is_success": true,
"message": "Mapping saved Successfully"
}Request
POST
api/salesforce/mapping/save
Body Parameters
type string
Type for which you want to save mapping.
Retrieve Salesforce Mapping
Retrieves the details of the salesforce mapping. Helps in fetching salesforce mapping using its type. (See Parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/salesforce/mappings" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"type":"salesforce_contact"}'
const url = new URL(
"https://demo.aomlms.com/api/salesforce/mappings"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"type": "salesforce_contact"
}
fetch(url, {
method: "GET",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"type": "salesforce_contact",
"userFieldProperties": [],
"courseFieldProperties": []
}Request
GET
api/salesforce/mappings
Body Parameters
type required optional
Type of the hupspot mapping you want to fetch the details of.
Update Salesforce Action
To update a Salesforce Action, you need to use this request. Provide id, event, action and object and it will be updated. (See parameters)
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/salesforce/3" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"event":"New Account Created","action":"create.","object":"Salesforce contact"}'
const url = new URL(
"https://demo.aomlms.com/api/salesforce/3"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"event": "New Account Created",
"action": "create.",
"object": "Salesforce contact"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 1,
"message": "Salesforce updated successfully"
}Request
PUT
api/salesforce/{id}
URL Parameters
id string
ID of the salesforce action.
Body Parameters
event string
Event in which you want to send data.
action string
Action will be create of the event by default.
object string
Select the object from the dropdown list from Salesforce contact.
Delete Salesforce
To delete a Salesforce, you need to use this request.
Example request:
curl -X POST \
"https://demo.aomlms.com/api/salesforce/action/delete/[1]" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/salesforce/action/delete/[1]"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Salesforce deleted successfully"
}Request
POST
api/salesforce/action/delete/{id}
URL Parameters
id string
Salesforce ID which needs to be deleted.
Salesforce Log Tabular List
Returns all the Salesforce log in a tabular list format in paginated mode.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/salesforce/logs/50?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/salesforce/logs/50"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"id": 1,
"event": "new_account_created",
"data": [],
"status": "success",
"errorMessage": "",
"created_at": "Aug 03, 2020 09:56 AM",
"showData": false
}
]
}Request
GET
api/salesforce/logs/{id}
URL Parameters
id string
ID of the Salesforce action.
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
SCORM Packages
SCORM packages can be used in course as course scorm module. Endpoints for managing SCORM Packages.
Create SCORM Package
You can create/upload the scorm package in the platform using this request. Uploaded scorm package files can be used as scorm modules in course.
Example request:
curl -X POST \
"https://demo.aomlms.com/api/scormpackage?resumableChunkNumber=1&resumableChunkSize=10485760&resumableCurrentChunkSize=79531&resumableTotalSize=79531&resumableType=image%2Fpng&resumableIdentifier=79531-Chanoo-Theory-of-Change-Sublevel-1zip&resumableFilename=Chanoo-Theory-of-Change-Sublevel-1.zip&resumableRelativePath=Chanoo-Theory-of-Change-Sublevel-1.zip&resumableTotalChunks=1&file=%28binary%29" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/scormpackage"
);
let params = {
"resumableChunkNumber": "1",
"resumableChunkSize": "10485760",
"resumableCurrentChunkSize": "79531",
"resumableTotalSize": "79531",
"resumableType": "image/png",
"resumableIdentifier": "79531-Chanoo-Theory-of-Change-Sublevel-1zip",
"resumableFilename": "Chanoo-Theory-of-Change-Sublevel-1.zip",
"resumableRelativePath": "Chanoo-Theory-of-Change-Sublevel-1.zip",
"resumableTotalChunks": "1",
"file": "(binary)",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"is_success": true,
"code": 200,
"errorMessage": "Unable to upload the package. Please contact admin",
"uploadedPackage": {
"name": "Chanoo-Theory-of-Change-Sublevel-1.zip",
"url": "\/scorm\/Chanoo-Theory-of-Change-Sublevel-1-e9408a656ce2655b828622a09e66a46d",
"launch_file": "index_lms.html",
"version": "1.2",
"created_by": 1,
"updated_at": "2020-08-12 09:58:22",
"created_at": "2020-08-12 09:58:22",
"id": 3,
"full_url": "https:\/\/staging.aomlms.com\/storage\/scorm\/Chanoo-Theory-of-Change-Sublevel-1-e9408a656ce2655b828622a09e66a46d\/index_lms.html"
}
}Request
POST
api/scormpackage
Query Parameters
resumableChunkNumber string
Chunk number for the scorm.
resumableChunkSize string
Chunk size for the scorm in bits.
resumableCurrentChunkSize string
Current uploading chunk size for the scorm in bits.
resumableTotalSize string
Total chunk size for the scorm in bits.
resumableType string
Type of the scorm in that is going to be uploaded.
resumableIdentifier string
Identifier for the scorm that is going to be uploaded.
resumableFilename string
Name of the scorm that is going to be uploaded.
resumableRelativePath string
Relative path of the scorm that is going to be uploaded.
resumableTotalChunks string
Total chunks.
file string
Binary file.
SCORM Tabular List
Returns all the scorm in a tabular list format in paginated mode. You can apply filter using search_param via name(scorm name) and scormTypes(different versions of SCORM).
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/scormpackages/tabularlist?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22name%22%3A%22%22%2C%22scormTypes%22%3A%5B%5D%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/scormpackages/tabularlist"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"name":"","scormTypes":[]}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"id": 1,
"name": "sample-course.zip",
"url": "\/scorm\/sample-course",
"full_url": "https:\/\/staging.aomlms.com\/storage\/scorm\/sample-course\/scormcontent\/index.html",
"version": "1.2",
"author": "Aom Staff",
"created_at": "Aug 03, 2020 11:03 AM"
}
]
}Request
GET
api/scormpackages/tabularlist
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
for searching items based on field names.
SCORM Types Lookup
Retrieves all types scorms in list format that this platform supports. Helps while showing scorms in form elements like dropdown.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/scormpackages/scormTypeLookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/scormpackages/scormTypeLookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"db_value": "SCORM 1.2",
"display_value": "Scorm version 1.2"
},
{
"db_value": "SCORM 2004",
"display_value": "Scorm version 2004"
},
{
"db_value": "xAPI",
"display_value": "xAPI"
}
]Request
GET
api/scormpackages/scormTypeLookup
Retrieve SCORM Packages
Retrieves the details of the specified SCORM package. Helps in fetching SCORM package using its ID. (See Parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/scormpackage/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/scormpackage/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"title": "Product-1",
"slug": "product-1",
"description": "Course 1 product",
"featuredImageUrl": null,
"regular_price": 3500,
"type": "SIMPLE",
"sale_price": 3001,
"saleStartDate": null,
"saleEndDate": null,
"status": "IN-STOCK",
"expiry": "2020-10-29",
"taxIncluded": false,
"taxBasedOn": "CUSTOMER-BILLING-ADDR",
"seo_title": null,
"seo_description": null,
"displayPrice": "<del>$3500 <\/del><span>$3001<\/span>",
"canBePurchased": true,
"label": "SALE",
"categories": [],
"courses": [
{
"value": 1,
"label": "course 1"
}
],
"courseCategories": []
}Request
GET
api/scormpackage/{id}
URL Parameters
id string
ID of the SCORM package you want to fetch the details of.
Delete SCORM Package
To delete a scorm package, you need to use this request. Returns number of scorm package deleted as well as not deleted. (See Response)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/scormpackage/delete" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"delete_ids":[3]}'
const url = new URL(
"https://demo.aomlms.com/api/scormpackage/delete"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"delete_ids": [
3
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "1 package(s) deleted 0 package(s) not deleted as it is used in Module. Please remove the scorm Package from the module and try again."
}Request
POST
api/scormpackage/delete
Body Parameters
delete_ids array
All scorm package IDs which needs to be deleted.
SCORMs
An SCORM Module is used as course content. Helps to perform CRUD operation to and for SCORM modules.
SCORM Modules Tabular List
Returns all the scorm modules in a tabular list format in paginated mode. You can apply filter using search_param via name and scormType(version).
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/modules/scorm?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22name%22%3A%22%22%2C%22scormTypes%22%3A%5B%5D%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/modules/scorm"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"name":"","scormTypes":[]}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"id": 1,
"name": "sample-course.zip",
"url": "\/scorm\/sample-course",
"full_url": "https:\/\/staging.aomlms.com\/storage\/scorm\/sample-course\/scormcontent\/index.html",
"version": "1.2",
"author": "Aom Staff",
"created_at": "Aug 03, 2020 11:03 AM"
}
]
}Request
GET
api/modules/scorm
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on field names.
Create Scorm Module
To create a scorm module, you need to use this request. (See parameters) Created scorm modules can be used in the course as course content/lesson.
Returns : id of the scorm module created and successfull message
Example request:
curl -X POST \
"https://demo.aomlms.com/api/modules/scorm" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"New Scorm","content":"This is the short content here","scormPackageFullUrl":"https:\/\/aomlms.com\/scorm\/sample-course\/scormcontent\/index.html","scormPackageId":1,"trackCompletion":true}'
const url = new URL(
"https://demo.aomlms.com/api/modules/scorm"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "New Scorm",
"content": "This is the short content here",
"scormPackageFullUrl": "https:\/\/aomlms.com\/scorm\/sample-course\/scormcontent\/index.html",
"scormPackageId": 1,
"trackCompletion": true
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 11,
"message": "Module saved successfully"
}Request
POST
api/modules/scorm
Body Parameters
name string
Name of the scorm module.
content string optional
Content for the scorm modules that students will see.
scormPackageFullUrl string optional
URL of the Scorm package.
scormPackageId integer
Id of the Scorm package.
trackCompletion boolean
If true, the module is being tracked(whether its finished or not) in course player.
Update Scorm Module
Updates the details of a specified scorm module. (See parameters) Scorm modules can be used in the course as course content/lesson.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/modules/scorm/{id}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"New Scorm","content":"This is the short content here","scormPackageFullUrl":"https:\/\/aomlms.com\/scorm\/sample-course\/scormcontent\/index.html","scormPackageId":1,"trackCompletion":true}'
const url = new URL(
"https://demo.aomlms.com/api/modules/scorm/{id}"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "New Scorm",
"content": "This is the short content here",
"scormPackageFullUrl": "https:\/\/aomlms.com\/scorm\/sample-course\/scormcontent\/index.html",
"scormPackageId": 1,
"trackCompletion": true
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Module updated successfully"
}Request
PUT
api/modules/scorm/{id}
Body Parameters
name string
Name of the scorm module.
content string optional
Content for the scorm modules that students will see.
scormPackageFullUrl string optional
URL of the Scorm package.
scormPackageId integer
Id of the Scorm package.
trackCompletion boolean
If true, the module is being tracked(whether its finished or not) in course player.
Retrieve Scorm Module
Retrieves the details of the specified scorm module. Helps in fetching scorm module using its ID. (See Parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/modules/scorm/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/modules/scorm/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "An interactive Scorm Illustration",
"slug": "an-interactive-scorm-illustration",
"trackCompletion": true,
"scormPackageId": 1,
"scormPackageFullUrl": "https:\/\/staging.aomlms.com\/storage\/scorm\/sample-course\/scormcontent\/index.html"
}Request
GET
api/modules/scorm/{id}
URL Parameters
id string
ID of the scorm module you want to fetch the details of.
Retrieve Detailed Scorm Module Info
Retrieves details of scorm module in depth as well as different modules details that are being used as course content for the same course the current scorm module is attached to. Returns related fields value. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/module/scorm/details?registrationId=16&moduleId=11" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/module/scorm/details"
);
let params = {
"registrationId": "16",
"moduleId": "11",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "New Scorm",
"slug": "new-scorm",
"content": null,
"courseName": "Testing",
"courseSlug": "https:\/\/staging.aomlms.com\/course\/testing",
"scormUrl": "https:\/\/staging.aomlms.com\/storage\/scorm\/sample-course\/scormcontent\/index.html",
"version": "1.2",
"trackCompletion": true,
"min_time_spent": 0,
"otherModules": [
{
"module_id": 11,
"name": "New Scorm",
"slug": "new-scorm",
"type": "scorm",
"icon": "<i class=\"el-icon-upload\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": true,
"status_row_id": 19,
"status": "In Progress",
"started_on": "2020-08-12T10:43:07.000000Z",
"completed_on": null,
"last_accessed_on": "15 seconds ago",
"total_time_spent": {
"hours": 0,
"minutes": 0,
"seconds": 13,
"totalSeconds": 13
},
"completion_percentage": 0,
"no_of_times_accessed": 1
}
],
"launchCheck": {
"canbeLaunched": true,
"errTitle": "",
"errDesc": ""
},
"prevSlug": "",
"nextSlug": "",
"scormKeys": {
"cmi.suspend_data": "",
"cmi.core.lesson_mode": "normal",
"cmi.mode": "normal",
"cmi.core.lesson_status": "incomplete",
"cmi.success_status": "",
"cmi.completion_status": "incomplete",
"cmi.core.student_id": 1,
"cmi.core.student_name": "Aom Staff"
},
"status": "In Progress",
"statusRowId": 19,
"timeSpent": 13
}Request
GET
api/module/scorm/details
Query Parameters
registrationId string
ID of the course Registration for which this module is attached to.
moduleId string
ID of the scorm module.
Retrieve Scorm Responses
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/scorm-report?modulesStatusId=nam&studentId=2" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/scorm-report"
);
let params = {
"modulesStatusId": "nam",
"studentId": "2",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"moduleName": "Sample Scorm",
"score": 50,
"studentName": "Aom Staff",
"interactions": [
{
"slide": "Q_8i27ew22n5kt-ekowv8qwotil",
"question": "Given the assembly below, why might the 4-hole pattern make a better datum choice for alignment of the radial hole vs another feature? Note that the center bore in this example is only for weight saving purposes.",
"questionType": "choice",
"studentResponse": "0_The_functional_intent_of_the_assembly_is_best_mimicked_by_using_the_four_hole_pattern_",
"correctResponse": "0_The_functional_intent_of_the_assembly_is_best_mimicked_by_using_the_four_hole_pattern_",
"result": "correct",
"time": "May 10, 2022 04:08 AM"
}
]
}Request
GET
api/scorm-report
Query Parameters
modulesStatusId string optional
int required ID of the Module status of the current assignment. Example : 7
studentId string optional
int required id of the student.
Retrieve Detailed Scorm Module Info For Membership Content
Retrieves details of scorm module in depth for the same membership the current scorm module is attached to. Returns related fields value. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/module/scorm/content-details?moduleId=11" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/module/scorm/content-details"
);
let params = {
"moduleId": "11",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "New Scorm",
"slug": "new-scorm",
"content": null,
"courseName": "Testing",
"courseSlug": "https:\/\/staging.aomlms.com\/course\/testing",
"scormUrl": "https:\/\/staging.aomlms.com\/storage\/scorm\/sample-course\/scormcontent\/index.html",
"version": "1.2",
"trackCompletion": true,
"min_time_spent": 0,
"otherModules": [
{
"module_id": 11,
"name": "New Scorm",
"slug": "new-scorm",
"type": "scorm",
"icon": "<i class=\"el-icon-upload\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": true,
"status_row_id": 19,
"status": "In Progress",
"started_on": "2020-08-12T10:43:07.000000Z",
"completed_on": null,
"last_accessed_on": "15 seconds ago",
"total_time_spent": {
"hours": 0,
"minutes": 0,
"seconds": 13,
"totalSeconds": 13
},
"completion_percentage": 0,
"no_of_times_accessed": 1
}
],
"launchCheck": {
"canbeLaunched": true,
"errTitle": "",
"errDesc": ""
},
"prevSlug": "",
"nextSlug": "",
"scormKeys": {
"cmi.suspend_data": "",
"cmi.core.lesson_mode": "normal",
"cmi.mode": "normal",
"cmi.core.lesson_status": "incomplete",
"cmi.success_status": "",
"cmi.completion_status": "incomplete",
"cmi.core.student_id": 1,
"cmi.core.student_name": "Aom Staff"
},
"status": "In Progress",
"statusRowId": 19,
"timeSpent": 13
}Request
GET
api/module/scorm/content-details
Query Parameters
moduleId string
ID of the scorm module.
Subscription Products
A subscription product whose amount will be paid in subscriptions (in between intervals) by your students. Helps in performing CRUD operations for and to subscription products.
api/webhook/paypal
Example request:
curl -X POST \
"https://demo.aomlms.com/api/webhook/paypal" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/webhook/paypal"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Request
POST
api/webhook/paypal
Retrieve Subscription
Retrieves the details of the subscription. Helps in fetching user subscription using its ID. (See Parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/subscription/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/subscription/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"status": "Active",
"endDate": "Aug 23th,2021",
"nextPaymentDate": "Jun 23th,2021",
"userName": "Aom Staff"
}Request
GET
api/subscription/{id}
URL Parameters
id string
ID of the subscription you want to fetch the details of.
Retrieve All Subscription Products
Retrieves the details of the subscription products. Helps in fetching subscription product using its ID. (See Parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/subscription/product/related" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/subscription/product/related"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"product_id": 1,
"title": "Professional Training And Education",
"subscription_price": "100",
"product_image_url": ""
}Request
GET
api/subscription/product/related
URL Parameters
id string
ID of the subscription you want to fetch the details of.
Subscription Related Orders Tabular List
Returns all the orders in a tabular list format in paginated mode. You can apply filter using search_param via orderStatus.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/subscription/orders/tabularlist?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22name%22%3A%22%22%2C%22scormTypes%22%3A%5B%5D%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/subscription/orders/tabularlist"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"name":"","scormTypes":[]}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"id": 1,
"total": "5",
"status": "ACTIVE",
"relationship": "Parent Order",
"created_at": "03 Aug 2020 09:08 AM"
}
]
}Request
GET
api/subscription/orders/tabularlist
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on field names.
Create Subscription
To create a subscription, you need to use this request. (See parameters) Subscription can be only created by purchasing subscription product.
Returns : success status and successfull message
Example request:
curl -X POST \
"https://demo.aomlms.com/api/subscription/create" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"orderId":1,"paymentToken":"XXXXXXXXXXXXXX","productQuantity":5}'
const url = new URL(
"https://demo.aomlms.com/api/subscription/create"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"orderId": 1,
"paymentToken": "XXXXXXXXXXXXXX",
"productQuantity": 5
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"success": true,
"message": "Subscription has been created"
}Request
POST
api/subscription/create
Body Parameters
orderId integer
Order ID of the product.
paymentToken string optional
requiredPayment Token of the purchase.
productQuantity integer
Product Quantity which is purchased.
Subscription Tabular List
Returns all the subscription in a tabular list format in paginated mode. You can apply filter using search_param via product title, subscription status and user nameorEmail.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/subscriptions/tabularlist?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22productTitle%22%3A%22%22%2C%22subscriptionStatus%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/subscriptions/tabularlist"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"productTitle":"","subscriptionStatus":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"id": 1,
"user_name": "Aom Staff",
"user_id": "2",
"product": "Professional Development and Training",
"product_id": "2",
"subscription_price": "100",
"next_payment_date": "Sept 03, 2020 11:03 AM",
"status": "Completed",
"created_at": "Aug 03, 2020 11:03 AM"
}
]
}Request
GET
api/subscriptions/tabularlist
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on field names.
Subscription Status Lookup
Retrieves all the status for the subscription. Helps showing options in dropdowns elements
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/subscription/status/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/subscription/status/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"db_value": "ACTIVE",
"display_value": "Active"
},
{
"db_value": "CANCELLED",
"display_value": "Cancelled"
},
{
"db_value": "EXPIRED",
"display_value": "Expired"
},
{
"db_value": "ON-HOLD",
"display_value": "On-Hold"
}
]Request
GET
api/subscription/status/lookup
Update Subscription
To update a subscription, you need to use this request. (See parameters) Subscription can be only created by purchasing subscription product.
Returns : success status and successfull message
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/subscription/{id}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"status":"ACTIVE","endDate":"Aug 23th, 2021","nextPaymentDate":"sapiente"}'
const url = new URL(
"https://demo.aomlms.com/api/subscription/{id}"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"status": "ACTIVE",
"endDate": "Aug 23th, 2021",
"nextPaymentDate": "sapiente"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Subscription updated successfully"
}Request
PUT
api/subscription/{id}
Body Parameters
status string
Status of the subscription.
endDate date
End Date of the subscription.
nextPaymentDate date
Next payemnet due date of the subscription product.. Jun 23th, 2021
Quick Edit
Updates the details in bulk for a specified subscriptions. Parameters is provided which needs to be updated.
Example request:
curl -X POST \
"https://demo.aomlms.com/api/subscription/quickEdit" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"subscription_ids":[1,2],"status":"ACTIVE"}'
const url = new URL(
"https://demo.aomlms.com/api/subscription/quickEdit"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"subscription_ids": [
1,
2
],
"status": "ACTIVE"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Subscriptions updated Successfully"
}Request
POST
api/subscription/quickEdit
Body Parameters
subscription_ids array
All subscription IDs which needs to be updated.
status string
Set the status for the subscriptions.
Subscription Renewal
Renew the subscription of the products. Helps in fetching subscription product using its ID. (See Parameters)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/subscription/process-subscription-action" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/subscription/process-subscription-action"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"success": 1,
"message": "Process Renewal Successfully completed"
}Request
POST
api/subscription/process-subscription-action
URL Parameters
id string
ID of the subscription you want to renew.
Subscription Action Lookup
Retrieves all the action for the subscription. Helps showing options in dropdowns elements
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/subscription/action/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/subscription/action/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"db_value": "PROCESS_RENEWAL",
"display_value": "Process renewal"
}
]Request
GET
api/subscription/action/lookup
Survey Modules
A survey module is a feedback module that you can add as course content to get students feedback about your course(How they felt about course, ratings, etc). Helps in performing CRUD operation to and for survey modules.
Survey Modules Tabular List
Returns all the survey modules in a tabular list format in paginated mode. You can apply filter using search_param via associatedCourse(modules used in course) and moduleName.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/modules/survey?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22associatedCourse%22%3A%22%22%2C%22moduleName%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/modules/survey"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"associatedCourse":"","moduleName":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 15,
"recordsFiltered": 1,
"records": [
{
"id": 15,
"name": "Feedback",
"slug": "feedback",
"type": "survey",
"icon": "<i class=\"el-icon-star-off\"><\/i>",
"author": "Aom Staff",
"created_at": "Aug 11, 2020 08:12 AM"
}
]
}Request
GET
api/modules/survey
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on field names.
Create Survey Module
To create a survey module, you need to use this request. (See parameters) Created survey modules can be used in the course as course content.
Returns : id of the survey module created and successfull message
Example request:
curl -X POST \
"https://demo.aomlms.com/api/modules/survey" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"Feedback","content":"This is the short content here","submitButtonText":"Submit Survey","submitOption":"save_to_db","fields":[{"type":"text","label":"How you left","defaultValue":"","isRequired":false,"optionLabel":[]},{"type":"rating","label":"How you rate us","defaultValue":"","isRequired":false,"optionLabel":[]}],"redirect":"http:\/\/www.aom.test.com","trackCompletion":true}'
const url = new URL(
"https://demo.aomlms.com/api/modules/survey"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "Feedback",
"content": "This is the short content here",
"submitButtonText": "Submit Survey",
"submitOption": "save_to_db",
"fields": [
{
"type": "text",
"label": "How you left",
"defaultValue": "",
"isRequired": false,
"optionLabel": []
},
{
"type": "rating",
"label": "How you rate us",
"defaultValue": "",
"isRequired": false,
"optionLabel": []
}
],
"redirect": "http:\/\/www.aom.test.com",
"trackCompletion": true
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 15,
"message": "Module saved successfully"
}Request
POST
api/modules/survey
Body Parameters
name string
Name of the text module.
content string optional
Content for the text modules that students will see.
submitButtonText string
Text for the submit button.
submitOption string
Submission options for students.
fields array
Form fields inside the Survey form(like radio, dropdown, rating, text, textarea, etc).
redirect string optional
After submission of survey, where the students will be redirected.
trackCompletion boolean
If true, the module is being tracked(whether its finished or not) in course player.
Update Survey Module
Updates the details of a specified survey module. (See parameters) Survey modules can be used in the course as course content.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/modules/survey/{id}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"Feedback","content":"This is the short content here","submitButtonText":"Submit Survey","submitOption":"save_to_db","fields":[{"type":"text","label":"How you left","defaultValue":"","isRequired":false,"optionLabel":[]},{"type":"rating","label":"How you rate us","defaultValue":"","isRequired":false,"optionLabel":[]}],"redirect":"http:\/\/www.aom.test.com","trackCompletion":true}'
const url = new URL(
"https://demo.aomlms.com/api/modules/survey/{id}"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "Feedback",
"content": "This is the short content here",
"submitButtonText": "Submit Survey",
"submitOption": "save_to_db",
"fields": [
{
"type": "text",
"label": "How you left",
"defaultValue": "",
"isRequired": false,
"optionLabel": []
},
{
"type": "rating",
"label": "How you rate us",
"defaultValue": "",
"isRequired": false,
"optionLabel": []
}
],
"redirect": "http:\/\/www.aom.test.com",
"trackCompletion": true
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Module updated successfully"
}Request
PUT
api/modules/survey/{id}
Body Parameters
name string
Name of the text module.
content string optional
Content for the text modules that students will see.
submitButtonText string
Text for the submit button.
submitOption string
Submission options for students.
fields array
Form fields inside the Survey form(like radio, dropdown, rating, text, textarea, etc).
redirect string optional
After submission of survey, where the students will be redirected.
trackCompletion boolean
If true, the module is being tracked(whether its finished or not) in course player.
Retrieve Survey module
Retrieves the details of the specified survey module. Helps in fetching survey module using its ID. (See Parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/modules/survey/15" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/modules/survey/15"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "Feedback",
"slug": "feedback",
"content": "A brief Description",
"redirect": null,
"trackCompletion": false,
"submitButtonText": "Submit Survey",
"submitOption": "save_to_db",
"fields": [
{
"id": 1,
"type": "text",
"label": "How you left",
"defaultValue": null,
"isRequired": false,
"optionLabel": []
},
{
"id": 2,
"type": "rating",
"label": "How you rate us",
"defaultValue": null,
"isRequired": false,
"optionLabel": []
}
]
}Request
GET
api/modules/survey/{id}
URL Parameters
id string
ID of the survey module you want to the fetch details of.
Retrieve Detailed Survey Module Info
Retrieves details of survey module in depth as well as different modules details that are being used as course content for the same course the current survey module is attached to. Returns related fields value. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/module/survey/details?registrationId=1&moduleId=15" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/module/survey/details"
);
let params = {
"registrationId": "1",
"moduleId": "15",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "Feedback",
"slug": "feedback",
"content": "A brief Description",
"courseName": "course 1",
"courseSlug": "http:\/\/localhost:8000\/course\/course-1",
"trackCompletion": false,
"min_time_spent": 0,
"otherModules": [
{
"module_id": 1,
"name": "test",
"slug": "test",
"type": "text",
"icon": "<i class=\"el-icon-tickets\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": 1,
"status": "Completed",
"started_on": "2020-08-03T10:02:33.000000Z",
"completed_on": "2020-08-03T10:02:41.000000Z",
"last_accessed_on": "14 hours ago",
"total_time_spent": {
"hours": 0,
"minutes": 0,
"seconds": 6,
"totalSeconds": 6
},
"completion_percentage": 100,
"no_of_times_accessed": 3
},
{
"module_id": 4,
"name": "assign",
"slug": "assign",
"type": "assignment",
"icon": "<i class=\"el-icon-edit-outline\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": true,
"status_row_id": -1,
"status": "Not Started",
"started_on": "",
"completed_on": "",
"last_accessed_on": "Never",
"total_time_spent": "",
"points_awarded": "",
"completion_percentage": 0,
"no_of_times_accessed": 0
},
{
"module_id": 7,
"name": "First-quiz",
"slug": "first-quiz",
"type": "quiz",
"icon": "<i class=\"el-icon-discover\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": -1,
"status": "Not Started",
"started_on": "",
"completed_on": "",
"last_accessed_on": "Never",
"total_time_spent": "",
"points_awarded": "",
"completion_percentage": 0,
"no_of_times_accessed": 0
},
{
"module_id": 9,
"name": "My-video-lesson",
"slug": "my-video-lesson",
"type": "video",
"icon": "<i class=\"el-icon-video-play\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": 4,
"status": "In Progress",
"started_on": "2020-08-10T20:04:14.000000Z",
"completed_on": null,
"last_accessed_on": "12 hours ago",
"total_time_spent": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"totalSeconds": null
},
"completion_percentage": 0,
"no_of_times_accessed": 1
},
{
"module_id": 10,
"name": "Essay on LMS",
"slug": "essay-on-lms",
"type": "assignment",
"icon": "<i class=\"el-icon-edit-outline\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": 5,
"status": "Completed",
"started_on": "2020-08-11T02:47:32.000000Z",
"completed_on": "2020-08-11T02:47:32.000000Z",
"last_accessed_on": "5 hours ago",
"total_time_spent": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"totalSeconds": null
},
"completion_percentage": 100,
"no_of_times_accessed": 2
},
{
"module_id": 12,
"name": "New-Webinar",
"slug": "new-webinar",
"type": "webinar",
"icon": "<i class=\"el-icon-date\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": -1,
"status": "Not Started",
"started_on": "",
"completed_on": "",
"last_accessed_on": "Never",
"total_time_spent": "",
"points_awarded": "",
"completion_percentage": 0,
"no_of_times_accessed": 0
},
{
"module_id": 13,
"name": "First-discussion",
"slug": "first-discussion",
"type": "discussion",
"icon": "<i class=\"el-icon-chat-line-round\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": 6,
"status": "In Progress",
"started_on": "2020-08-11T05:41:57.000000Z",
"completed_on": null,
"last_accessed_on": "2 hours ago",
"total_time_spent": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"totalSeconds": null
},
"completion_percentage": 0,
"no_of_times_accessed": 1
},
{
"module_id": 15,
"name": "Feedback",
"slug": "feedback",
"type": "survey",
"icon": "<i class=\"el-icon-star-off\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": -1,
"status": "Not Started",
"started_on": "",
"completed_on": "",
"last_accessed_on": "Never",
"total_time_spent": "",
"points_awarded": "",
"completion_percentage": 0,
"no_of_times_accessed": 0
}
],
"launchCheck": {
"canbeLaunched": true,
"errTitle": "",
"errDesc": ""
},
"errors": [],
"course_id": 1,
"prevSlug": "first-discussion",
"nextSlug": "",
"status": "In Progress",
"timeSpent": null,
"statusRowId": 8,
"form_id": 1,
"form_fields": {
"1": {
"type": "text",
"label": "How you left",
"submitted_value": "",
"options_label": [],
"options_value": [],
"is_required": false
},
"2": {
"type": "rating",
"label": "How you rate us",
"submitted_value": "",
"options_label": [],
"options_value": [],
"is_required": false
}
}
}Request
GET
api/module/survey/details
Query Parameters
registrationId string
ID of the course Registration for which this module is attached to.
moduleId string
ID of the survey module.
Mark Complete Survey Module
Updates the status of the survey module to completed. Changes the completion percentage to 100% and mark completed the survey module.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/module/survey/markComplete" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"form_id":1,"statusRowId":9,"timeSpent":101}'
const url = new URL(
"https://demo.aomlms.com/api/module/survey/markComplete"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"form_id": 1,
"statusRowId": 9,
"timeSpent": 101
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"is_success": true,
"message": "Module Completed Successfully"
}Request
PUT
api/module/survey/markComplete
Body Parameters
form_id integer
ID of the form, used in survey module.
statusRowId integer
ID of the ModuleStatus Row belongs to current survey module.
timeSpent number
Total time spent by user in current survey module.
Retrieve Student Response
Retrieves all the response made by a specified student in a specified course. Mostly used while generating reports for Instructors to see how students are feeling regarding their courses. Retrieve Student response survey as question and answer. (See response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/module/survey/student-details" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"statusRowId":"3"}'
const url = new URL(
"https://demo.aomlms.com/api/module/survey/student-details"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"statusRowId": "3"
}
fetch(url, {
method: "GET",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"question": [
"How you felt",
"How you rate us"
],
"answer": [
"Awesome course it was",
"5"
]
}Request
GET
api/module/survey/student-details
Body Parameters
statusRowId required optional
ID of the ModuleStatus Row belongs to current text module.
Retrieve Course Response
Retrieves all the response made by the all students in a specified course. Mostly used while generating reports for Instructors to see how students are feeling regarding their courses. Mostly used for reporting purpose course-wise. (See response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/module/survey/course-details?course_id=1&page_size=9&page_number=5" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/module/survey/course-details"
);
let params = {
"course_id": "1",
"page_size": "9",
"page_number": "5",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"form_data": {
"1": [
{
"student_id": 1,
"student_name": "Aom Staff",
"student_email": "[email protected]",
"course_name": "course 1",
"question": "How you left",
"answer": "Awesome course it was"
},
{
"student_id": 1,
"student_name": "Aom Staff",
"student_email": "[email protected]",
"course_name": "course 1",
"question": "How you rate us",
"answer": "5"
}
]
},
"form_id": [
1
]
}Request
GET
api/module/survey/course-details
Query Parameters
course_id string
ID of the course you want to fetch the survey response reports for.
page_size string
The number of the item you want for a page.
page_number string
Current page number in pagination.
Retrieve Course Max Form Submission Response Count
Retrieves the count of the maximum number of the form submissions in a single form in a specified course. Used to estimiate the number of seperate requests are needed to fetch all responses in chunks. (See response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/module/survey/course-details-count?course_id=1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/module/survey/course-details-count"
);
let params = {
"course_id": "1",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"max_form_data_count": 2
}Request
GET
api/module/survey/course-details-count
Query Parameters
course_id string
ID of the course you want to fetch the survey form max submission count for.
Survey Modules Attached In Course Tabular List
Returns all the survey modules attached in a course in a tabular list format in paginated mode. You can apply filter using search_param via courseName and courseId.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/module/survey/survey-count?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22courseName%22%3A%22%22%2C%22courseId%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/module/survey/survey-count"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"courseName":"","courseId":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 1,
"name": "Feedback",
"slug": "feedback",
"content": "A brief Description",
"showModules": true,
"status": "",
"categories": "",
"author": "Aom Staff",
"created_at": "Aug 23th 2021",
"count": "2",
"survey": []
}Request
GET
api/module/survey/survey-count
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on field names.
Survey User Response
Returns all the survey modules user response of the course in a tabular list format in paginated mode. You can apply filter using search_param via name and scormType(version).
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/survey/survey-check?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22userName%22%3A%22%22%7D&course_id=4&module_id=3" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/survey/survey-check"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"userName":""}",
"course_id": "4",
"module_id": "3",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"form_data": "Form Submission",
"courseName": "Professional Training and Education",
"moduleName": "Survey Module",
"recordsTotal": 1,
"recordsFiltered": 1,
"form_data_count": [
{
"submissions": [],
"name": "Aom Staff",
"email": "[email protected]"
}
]
}Request
GET
api/survey/survey-check
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
For searching items based on field names.
course_id string
Course ID for which you want to get user response.
module_id string
Module ID for which you want to get user response.
Save Survey Module Response
To save the response provided by the students using evaltion form, you need to use this request with provided parameters.
Example request:
curl -X POST \
"https://demo.aomlms.com/api/module/survey/save-response" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"Feedback","content":"A brief Description","courseName":"course 1","courseSlug":"http:\/\/localhost:8000\/course\/course-1","course_id":1,"form_id":1,"form_fields":"{\"1\":{\"type\":\"text\",\"label\":\"How you left\",\"submitted_value\":\"Awesome course it was\",\"options_label\":[],\"options_value\":[],\"is_required\":false},\"2\":{\"type\":\"rating\",\"label\":\"How you rate us\",\"submitted_value\":5,\"options_label\":[],\"options_value\":[],\"is_required\":false}}"}'
const url = new URL(
"https://demo.aomlms.com/api/module/survey/save-response"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "Feedback",
"content": "A brief Description",
"courseName": "course 1",
"courseSlug": "http:\/\/localhost:8000\/course\/course-1",
"course_id": 1,
"form_id": 1,
"form_fields": "{\"1\":{\"type\":\"text\",\"label\":\"How you left\",\"submitted_value\":\"Awesome course it was\",\"options_label\":[],\"options_value\":[],\"is_required\":false},\"2\":{\"type\":\"rating\",\"label\":\"How you rate us\",\"submitted_value\":5,\"options_label\":[],\"options_value\":[],\"is_required\":false}}"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 15,
"message": "Form saved successfully"
}Request
POST
api/module/survey/save-response
Body Parameters
name string
Name of the survey module.
content string optional
Content for the survey module that will be seen by the students in course player.
courseName string optional
Name of the course.
courseSlug string optional
Slug for the course.
course_id integer
ID of the course.
form_id integer
ID of the form, used in this survey module.
form_fields object optional
All form fields value used in form for submission.
Text Modules
A Text Module is a lesson module used as course content. Helps to perform CRUD operation to and for Text modules.
Text Modules Tabular List
Returns all the text modules in a tabular list format in paginated mode. You can apply filter using search_param via associatedCourse(modules used in course) and moduleName.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/modules/text?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22associatedCourse%22%3A%22%22%2C%22moduleName%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/modules/text"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"associatedCourse":"","moduleName":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"id": 1,
"name": "test",
"slug": "test",
"type": "text",
"icon": "<i class=\"el-icon-tickets\"><\/i>",
"author": "Aom Staff",
"created_at": "Aug 03, 2020 09:56 AM"
}
]
}Request
GET
api/modules/text
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
for searching items based on field names.
Retrieve Text Module
Retrieves the details of the specified text module. Helps in fetching text module using its ID. (See Parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/modules/text/67" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/modules/text/67"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "test",
"slug": "test",
"content": "<p>Content of the text lesson<\/p>",
"trackCompletion": true
}Request
GET
api/modules/text/{id}
URL Parameters
id string
ID of the text module you want to fetch the details of.
Create Text Module
To create a text module, you need to use this request. (See parameters) Created text modules can be used in the course as course content/lesson.
Returns : id of the text module created and successfull message
Example request:
curl -X POST \
"https://demo.aomlms.com/api/modules/text" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"The Fundamentals of LMS","content":"<p>This is the short content here<\/p>","trackCompletion":true}'
const url = new URL(
"https://demo.aomlms.com/api/modules/text"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "The Fundamentals of LMS",
"content": "<p>This is the short content here<\/p>",
"trackCompletion": true
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 5,
"message": "Module saved successfully"
}Request
POST
api/modules/text
Body Parameters
name string
Name of the text module.
content string
Content for the text modules that students will see.
trackCompletion boolean
If true, the module is being tracked(whether its finished or not) in course player.
Update Text Module
Updates the details of a specified text modules. (See parameters) Text modules can be used in the course as course content/lesson.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/modules/text/2" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"The Fundamentals of LMS","content":"<p>This is the updated short content here<\/p>","trackCompletion":true}'
const url = new URL(
"https://demo.aomlms.com/api/modules/text/2"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "The Fundamentals of LMS",
"content": "<p>This is the updated short content here<\/p>",
"trackCompletion": true
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Module updated successfully"
}Request
PUT
api/modules/text/{id}
URL Parameters
id string
ID of the text module.
Body Parameters
name string
Name of the text module.
content string
Content for the text modules that students will see.
trackCompletion boolean
If true, the module is being tracked(whether its finished or not) in course player.
Retrieve Detailed Text Module Info
Retrieves details of text module in depth as well as different modules details that are being used as course content for the same course the current text module is attached to. Returns related fields value. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/module/text/details?registrationId=1&moduleId=1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/module/text/details"
);
let params = {
"registrationId": "1",
"moduleId": "1",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "test",
"slug": "test",
"content": "<p>afegrshtdh<\/p>",
"courseName": "course 1",
"courseSlug": "http:\/\/localhost:8000\/course\/course-1",
"trackCompletion": true,
"min_time_spent": 0,
"otherModules": [
{
"module_id": 1,
"name": "test",
"slug": "test",
"type": "text",
"icon": "<i class=\"el-icon-tickets\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": 1,
"status": "Completed",
"started_on": "2020-08-03T10:02:33.000000Z",
"completed_on": "2020-08-03T10:02:41.000000Z",
"last_accessed_on": "1 week ago",
"total_time_spent": {
"hours": 0,
"minutes": 0,
"seconds": 6,
"totalSeconds": 6
},
"completion_percentage": 100,
"no_of_times_accessed": 1
},
{
"module_id": 4,
"name": "assign",
"slug": "assign",
"type": "assignment",
"icon": "<i class=\"el-icon-edit-outline\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": true,
"status_row_id": -1,
"status": "Not Started",
"started_on": "",
"completed_on": "",
"last_accessed_on": "Never",
"total_time_spent": "",
"points_awarded": "",
"completion_percentage": 0,
"no_of_times_accessed": 0
}
],
"launchCheck": {
"canbeLaunched": true,
"errTitle": "",
"errDesc": ""
},
"prevSlug": "",
"nextSlug": "assign",
"status": "Completed",
"timeSpent": 6,
"statusRowId": 1
}Request
GET
api/module/text/details
Query Parameters
registrationId string
ID of the course Registration for which this module is attached to.
moduleId string
ID of the text module.
Mark Complete Text Module
Updates the status of the text module to completed. Changes the completion percentage to 100% and mark completed the text module.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/module/text/markComplete" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"statusRowId":"3"}'
const url = new URL(
"https://demo.aomlms.com/api/module/text/markComplete"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"statusRowId": "3"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Module Completed Successfully"
}Request
PUT
api/module/text/markComplete
Body Parameters
statusRowId required optional
ID of the ModuleStatus Row belongs to current text module.
Retrieve Detailed Text module Info for Membership content
Retrieves details of text module in depth for the same membership the current text module is attached to. Returns related fields value. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/module/text/content-details?moduleId=9" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/module/text/content-details"
);
let params = {
"moduleId": "9",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "My-video-lesson",
"slug": "my-video-lesson",
"content": "Brief Description",
"disableForwardSeek": false,
"trackCompletion": true,
"timeSpent": null,
"lastWatchedTime": 0,
"isReady": true
}Request
GET
api/module/text/content-details
Query Parameters
moduleId string
ID of the video module.
User Roles
Role Managements
Roles Lookup
Retrieves all the roles user has ever created. This request helps in showing all the roles in form elements like dropdown, etc. Returns list of ID and name of the roles. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/roles/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/roles/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"id": 1,
"name": "superadmin",
"display_name": "Super Admin"
},
{
"id": 2,
"name": "admin",
"display_name": "Admin"
},
{
"id": 3,
"name": "groupadmin",
"display_name": "Group Admin"
},
{
"id": 4,
"name": "student",
"display_name": "Student"
}
]Request
GET
api/roles/lookup
Users
You can perform user management tasks like creating, deleting and updating users.
Tabular List
Retrieves all the users in a tabular list format with pagination mode. You can apply filter using search_param via courseCategoryIds(course category ID), courseName or roleNames(user role)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/users/tabularlist?page_size=10&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C%22direction%22%3A%22desc%22%7D&search_param=%7B%22courseCategoryIds%22%3A%5B%5D%2C%22courseName%22%3A%22course+1%22%2C%22roleNames%22%3A%5B%5D%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/users/tabularlist"
);
let params = {
"page_size": "10",
"page_number": "1",
"order_by": "{"colName":"created_at","direction":"desc"}",
"search_param": "{"courseCategoryIds":[],"courseName":"course 1","roleNames":[]}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 4,
"recordsFiltered": 4,
"records": [
{
"id": 4,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"avatar": "<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"40\" height=\"40\" viewBox=\"0 0 40 40\"><circle cx=\"20\" cy=\"20\" r=\"20\" stroke=\"background\" stroke-width=\"0\" fill=\"#03A9F4\" \/><text x=\"20\" y=\"20\" font-size=\"14\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">JD<\/text><\/svg>",
"role": "student",
"display_role": "Student",
"created_at": "Aug 06, 2020 07:20 AM",
"last_login": "2 days ago"
},
{
"id": 2,
"first_name": "Client",
"last_name": "Admin",
"email": "[email protected]",
"avatar": "<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"40\" height=\"40\" viewBox=\"0 0 40 40\"><circle cx=\"20\" cy=\"20\" r=\"20\" stroke=\"background\" stroke-width=\"0\" fill=\"#673AB7\" \/><text x=\"20\" y=\"20\" font-size=\"14\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">CA<\/text><\/svg>",
"role": "admin",
"display_role": "Admin",
"created_at": "Aug 03, 2020 09:31 AM",
"last_login": "Never"
},
{
"id": 3,
"first_name": "Demoss",
"last_name": "Student",
"email": "[email protected]",
"avatar": "<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"40\" height=\"40\" viewBox=\"0 0 40 40\"><circle cx=\"20\" cy=\"20\" r=\"20\" stroke=\"background\" stroke-width=\"0\" fill=\"#FF5722\" \/><text x=\"20\" y=\"20\" font-size=\"14\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">DS<\/text><\/svg>",
"role": "student",
"display_role": "Student",
"created_at": "Aug 03, 2020 09:31 AM",
"last_login": "5 days ago"
},
{
"id": 1,
"first_name": "Aom",
"last_name": "Staff",
"email": "[email protected]",
"avatar": "<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"40\" height=\"40\" viewBox=\"0 0 40 40\"><circle cx=\"20\" cy=\"20\" r=\"20\" stroke=\"background\" stroke-width=\"0\" fill=\"#00BCD4\" \/><text x=\"20\" y=\"20\" font-size=\"14\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">AS<\/text><\/svg>",
"role": "superadmin",
"display_role": "Super Admin",
"created_at": "Aug 03, 2020 09:31 AM",
"last_login": "1 minute ago"
}
]
}Request
GET
api/users/tabularlist
Query Parameters
page_size string
The number of the user you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
for searching items based on Course category ids, course name and role names.
Retrieve User By Role
Retrieves all the users belongs to a specified role.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/users/getUsersByRole?role=ratione" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/users/getUsersByRole"
);
let params = {
"role": "ratione",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"records": [
{
"id": 3,
"name": "Demo Student([email protected])"
},
{
"id": 4,
"name": "John Doe([email protected])"
}
]
}Request
GET
api/users/getUsersByRole
Query Parameters
role string
The role of the user.
User Lookup
Retrieves all the users. Helps in showing users in forms elements like dropdown.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/users/lookup" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/users/lookup"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"id": 1,
"full_name": "Aom Staff",
"email": "[email protected]"
},
{
"id": 2,
"full_name": "Client Admin",
"email": "[email protected]"
},
{
"id": 3,
"full_name": "Demoss Student",
"email": "[email protected]"
},
{
"id": 4,
"full_name": "John Doe",
"email": "[email protected]"
}
]Request
GET
api/users/lookup
Create User
To create user, you need to use this request.
Example request:
curl -X POST \
"https://demo.aomlms.com/api/user/create" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"firstName":"John","lastName":"Doe","email":"[email protected]","password":"somePassword","role":4}'
const url = new URL(
"https://demo.aomlms.com/api/user/create"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"firstName": "John",
"lastName": "Doe",
"email": "[email protected]",
"password": "somePassword",
"role": 4
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 11,
"message": "User created successfully"
}Request
POST
api/user/create
Body Parameters
firstName string
First Name of the user.
lastName string optional
Last Name of the user.
email string
Email of the user.
password string
Password for the user.
role integer
Role for the user. ID of role: 1 for superadmin, 2 for admin, 3 for groupadmin, 4 for student. Role options: 1,2,3 or 4.
Bulk Upload
To create users in bulk, you need to use this request.
Example request:
curl -X POST \
"https://demo.aomlms.com/api/user/bulkUpload" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"userList":[{"email":"[email protected]","first_name":"Fake FName","last_name":"Fake LName","password":"[email protected]"},{"email":"[email protected]","first_name":"Fake FName 2","last_name":"Fake LName 2","password":""}],"groupId":1,"selectedCourses":[1,2],"membershipId":12}'
const url = new URL(
"https://demo.aomlms.com/api/user/bulkUpload"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"userList": [
{
"email": "[email protected]",
"first_name": "Fake FName",
"last_name": "Fake LName",
"password": "[email protected]"
},
{
"email": "[email protected]",
"first_name": "Fake FName 2",
"last_name": "Fake LName 2",
"password": ""
}
],
"groupId": 1,
"selectedCourses": [
1,
2
],
"membershipId": 12
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "User(s) uploaded successfully"
}Request
POST
api/user/bulkUpload
Body Parameters
userList array
Users list that needs to be added.
groupId integer optional
Creates all users under specified group.
selectedCourses array optional
creates all users and add users in specified courses.
membershipId integer optional
creates all users under specified membership.
Retrieve User By ID
This endpoint returns the user details based on the ID specified.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/user/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/user/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"firstName": "John",
"lastName": "Doe",
"email": "[email protected]",
"lastLoggedIn": "Never",
"avatar": "<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"100\" height=\"100\" viewBox=\"0 0 100 100\"><circle cx=\"50\" cy=\"50\" r=\"50\" stroke=\"background\" stroke-width=\"0\" fill=\"#03A9F4\" \/><text x=\"50\" y=\"50\" font-size=\"40\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">JD<\/text><\/svg>",
"role": {
"id": 4,
"name": "student",
"display_name": "Student"
},
"disabled": false
}Request
GET
api/user/{id}
URL Parameters
id string
The ID of the user.
Update User
Updates user details using parameters mentioned.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/user/11" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"firstName":"John","lastName":"Doe","email":"[email protected]","lastLoggedIn":"Never","avatar":"<svg xmlns=\\\"http:\/\/www.w3.org\/2000\/svg\\\" width=\\\"100\\\" height=\\\"100\\\" viewBox=\\\"0 0 100 100\\\"><circle cx=\\\"50\\\" cy=\\\"50\\\" r=\\\"50\\\" stroke=\\\"background\\\" stroke-width=\\\"0\\\" fill=\\\"#E91E63\\\" \/><text x=\\\"50\\\" y=\\\"50\\\" font-size=\\\"40\\\" fill=\\\"#FFFFFF\\\" alignment-baseline=\\\"middle\\\" text-anchor=\\\"middle\\\" dominant-baseline=\\\"central\\\">AW<\/text><\/svg>","role":4,"disabled":false}'
const url = new URL(
"https://demo.aomlms.com/api/user/11"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"firstName": "John",
"lastName": "Doe",
"email": "[email protected]",
"lastLoggedIn": "Never",
"avatar": "<svg xmlns=\\\"http:\/\/www.w3.org\/2000\/svg\\\" width=\\\"100\\\" height=\\\"100\\\" viewBox=\\\"0 0 100 100\\\"><circle cx=\\\"50\\\" cy=\\\"50\\\" r=\\\"50\\\" stroke=\\\"background\\\" stroke-width=\\\"0\\\" fill=\\\"#E91E63\\\" \/><text x=\\\"50\\\" y=\\\"50\\\" font-size=\\\"40\\\" fill=\\\"#FFFFFF\\\" alignment-baseline=\\\"middle\\\" text-anchor=\\\"middle\\\" dominant-baseline=\\\"central\\\">AW<\/text><\/svg>",
"role": 4,
"disabled": false
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "User updated successfully"
}Request
PUT
api/user/{id}
URL Parameters
id string
ID of the user.
Body Parameters
firstName string
First Name of the user.
lastName string optional
Last Name of the user.
email string
Email of the user.
lastLoggedIn string
Datetime or Never.
avatar string
Avatar svg icon for the user.
role integer
Role for the user. ID of role: 1 for superadmin, 2 for admin, 3 for groupadmin, 4 for student. Role options: 1,2,3 or 4.
disabled boolean
User needs to be disabled or not.
Update User's Membership
Updates user membership plan using parameters mentioned.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/user/11/update-membership" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"membership":"{\"id\":4,\"name\":\"Gold Plan\",\"expired_at\": \"2021-10-01 23:00:00\"}"}'
const url = new URL(
"https://demo.aomlms.com/api/user/11/update-membership"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"membership": "{\"id\":4,\"name\":\"Gold Plan\",\"expired_at\": \"2021-10-01 23:00:00\"}"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "User updated successfully"
}Request
PUT
api/user/{id}/update-membership
URL Parameters
id string
ID of the user.
Body Parameters
membership json
Membership plan for the user.
Update Password
Updates password for the user.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/user/updatePassword/11" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"password":"somePassword","confirmPassword":"Doe"}'
const url = new URL(
"https://demo.aomlms.com/api/user/updatePassword/11"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"password": "somePassword",
"confirmPassword": "Doe"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Password updated successfully"
}Request
PUT
api/user/updatePassword/{id}
URL Parameters
id string
ID of the user.
Body Parameters
password string
Password for the user.
confirmPassword string optional
Confirm Password for the user.
Enrolled Courses
Retrieves all the courses opted by specified user. You can apply filters using search_param via status(course status)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/users/enrolled-courses?user_id=4&page_size=10&page_number=1&order_by=registered_on&search_param=%7B%22status%22%3A%5B%22In+Progress%22%2C%22Not+Started%22%5D%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/users/enrolled-courses"
);
let params = {
"user_id": "4",
"page_size": "10",
"page_number": "1",
"order_by": "registered_on",
"search_param": "{"status":["In Progress","Not Started"]}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"id": 6,
"courseId": 1,
"featuredImageUrl": null,
"courseSlug": "http:\/\/localhost:8000\/course\/course-1",
"courseName": "course 1",
"lastAccessed": "Never",
"status": "Not Started",
"display_status": "Not Started",
"accessStatus": "Allowed",
"percentComplete": 0,
"registered_on": "Aug 09, 2020",
"started_on": "",
"completed_on": "",
"expire_on": "Never",
"isExpired": false
}
]
}Request
GET
api/users/enrolled-courses
Query Parameters
user_id string
ID of the user.
page_size string
Number of the results you want in each page.
page_number string
Current Page number.
order_by string optional
Returns details in some order.
search_param string optional
Search parameters related to course.
Delete User
To delete a user, you need to use this request.
Example request:
curl -X POST \
"https://demo.aomlms.com/api/user/delete" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"delete_ids":[2,3,4]}'
const url = new URL(
"https://demo.aomlms.com/api/user/delete"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"delete_ids": [
2,
3,
4
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "2 student(s) not deleted as they has enrollments. Please remove the student(s) from the course and try again."
}Request
POST
api/user/delete
Body Parameters
delete_ids array
All user IDs which needs to be deleted.
Quick Edit
Updates the details in bulk for a specified user. Parameters is provided which needs to be updated.
Example request:
curl -X POST \
"https://demo.aomlms.com/api/user/quickEdit" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"user_ids":[4,2],"disabled":"false","role":"{\"id\":4,\"name\":\"student\",\"display_name\":\"Student\"}","course_ids":[1,2]}'
const url = new URL(
"https://demo.aomlms.com/api/user/quickEdit"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"user_ids": [
4,
2
],
"disabled": "false",
"role": "{\"id\":4,\"name\":\"student\",\"display_name\":\"Student\"}",
"course_ids": [
1,
2
]
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Users updated Successfully"
}Request
POST
api/user/quickEdit
Body Parameters
user_ids array
All user IDs which needs to be updated.
disabled array
Whether user will be disabled or not.
role json optional
Role for the user(admin/student).
course_ids array optional
User will be enrolled into the course specified.
Add Address
To add address for a user, you need to use this request using mentioned parameters.
Example request:
curl -X POST \
"https://demo.aomlms.com/api/user/1/addAddress" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"fullName":"John Doe","addressLine1":"Boring Street","addressLine2":"Awesome Colony","zipcode":"123456","city":"Mumbai","state":"NY","country":"US","isDefault":false}'
const url = new URL(
"https://demo.aomlms.com/api/user/1/addAddress"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"fullName": "John Doe",
"addressLine1": "Boring Street",
"addressLine2": "Awesome Colony",
"zipcode": "123456",
"city": "Mumbai",
"state": "NY",
"country": "US",
"isDefault": false
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Address added successfully"
}Request
POST
api/user/{id}/addAddress
URL Parameters
userId string
User ID for which we want to add address.
Body Parameters
fullName string
Full Name of the user.
addressLine1 string
Address line1 of the user.
addressLine2 string optional
Address line2 of the user.
zipcode string
Zipcode of the user address.
city string
City of the user address.
state string optional
State of the user address.
country string
Country of the user address.
isDefault boolean
Is the address default for billing.
Retrieve Addresses
Retrieves all the addresses which are added by the specified user.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/user/userAddress/4" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/user/userAddress/4"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"id": 1,
"isDefault": false,
"fullName": "John Doe",
"addressLine1": "Boring Street",
"addressLine2": "Awesome Colony",
"zipcode": "123456",
"city": "Mumbai",
"state": "MH",
"country": "IN"
}
]Request
GET
api/user/userAddress/{id}
URL Parameters
id string
ID of the user.
Retrieve Dashboard Stats
Retrieves Dashboard details for specified user. Returned information contains in-progress, notStarted and completed items details as well as time spent details.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/user/dashboard/statistics?user_id=4&page_size=10&page_number=1&order_by=registered_on&search_param=%7B%22status%22%3A%5B%22In+Progress%22%2C%22Not+Started%22%5D%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/user/dashboard/statistics"
);
let params = {
"user_id": "4",
"page_size": "10",
"page_number": "1",
"order_by": "registered_on",
"search_param": "{"status":["In Progress","Not Started"]}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"notStarted": 1,
"inProgress": 0,
"completed": 0,
"total": 1,
"studentName": "John Doe",
"timeSpent": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"totalSeconds": 0
}
}Request
GET
api/user/dashboard/statistics
Query Parameters
user_id string
ID of the user.
page_size string
Number of the results you want in each page.
page_number string
Current Page number.
order_by string optional
Returns details in some order.
search_param string optional
Search parameters related to course.
Retrieve User Activities
Returns all activities performed by a specified user. You can apply filter using search_param via courseCategoryIds(course category ID), courseName or status(course status)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/user-activities?user_id=4&page_size=10&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22courseCategoryIds%22%3A%5B%5D%2C%22courseName%22%3A%22course-1%22%2C%22status%22%3A%22In+Progress%22%7D&context=admin" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/user-activities"
);
let params = {
"user_id": "4",
"page_size": "10",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"courseCategoryIds":[],"courseName":"course-1","status":"In Progress"}",
"context": "admin",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"avatar": "<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"40\" height=\"40\" viewBox=\"0 0 40 40\"><circle cx=\"20\" cy=\"20\" r=\"20\" stroke=\"background\" stroke-width=\"0\" fill=\"#03A9F4\" \/><text x=\"20\" y=\"20\" font-size=\"14\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">JD<\/text><\/svg>",
"name": "John Doe",
"email": "[email protected]",
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"id": 15,
"verb": "ENROLLED",
"created_at": "Aug 09, 2020 10:27 AM",
"message": "John Doe is enrolled to course 1",
"course": "course 1"
}
]
}Request
GET
api/user-activities
Query Parameters
user_id string
ID of the user.
page_size string
Number of the results you want in each page.
page_number string
Current Page number.
order_by string optional
Returns details in some order.
search_param string optional
Search parameters related to course.
context string
Context for the details.
Retrieve User Orders
Retrieve order details, purchased by a specified user. Returned data is in pagination form.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/user-orders?user_id=4&page_size=10&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/user-orders"
);
let params = {
"user_id": "4",
"page_size": "10",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"avatar": "<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"40\" height=\"40\" viewBox=\"0 0 40 40\"><circle cx=\"20\" cy=\"20\" r=\"20\" stroke=\"background\" stroke-width=\"0\" fill=\"#03A9F4\" \/><text x=\"20\" y=\"20\" font-size=\"14\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">JD<\/text><\/svg>",
"recordsTotal": 0,
"recordsFiltered": 0,
"currencySymbol": "$",
"records": []
}Request
GET
api/user-orders
Query Parameters
user_id string
ID of the user.
page_size string
Number of the results you want in each page.
page_number string
Current Page number.
order_by string
Returns details in some order.
Retrieve Certificates
Retrieve all certificates earned by the user for every course they pursued/completed.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/user-certificates/4?page_size=10&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22courseCategoryIds%22%3A%5B%5D%2C%22courseName%22%3A%22%22%2C%22roleNames%22%3A%5B%5D%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/user-certificates/4"
);
let params = {
"page_size": "10",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"courseCategoryIds":[],"courseName":"","roleNames":[]}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"id": 1,
"courseId": 1,
"userId": 3,
"templateId": 1,
"courseName": "course 1",
"coursefeaturedImage": null,
"issueDate": "Aug 03, 2020 10:02 AM"
}
]
}Request
GET
api/user-certificates/{id}
URL Parameters
id string
ID of the user.
Query Parameters
page_size string
Number of the results you want in each page.
page_number string
Current Page number.
order_by string optional
Returns details in some order.
search_param string optional
Apply search parameter.
Remove Certificate
To removes the certificate for a specified user, you need to use this request.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/user/{id}/delete-certificate" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"id":1}'
const url = new URL(
"https://demo.aomlms.com/api/user/{id}/delete-certificate"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"id": 1
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Certificate Deleted Successfully"
}Request
PUT
api/user/{id}/delete-certificate
Body Parameters
id integer
ID of the certificate belongs to user.
Update Certificate Issue Date
Updates the Issue date of Certificate for a user.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/update-certificate-issue-date" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"rowId":1,"newIssueDate":"2020-08-04 00:00:00"}'
const url = new URL(
"https://demo.aomlms.com/api/update-certificate-issue-date"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"rowId": 1,
"newIssueDate": "2020-08-04 00:00:00"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Issue Date Updated Successfully"
}Request
PUT
api/update-certificate-issue-date
Body Parameters
rowId integer
ID of the user certificate.
newIssueDate datetime
New datetime for the certificate.
Retrieve Default Address
Retrieves the default address for the specified user.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/default-address/4" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/default-address/4"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"id": 1,
"addresstype": null,
"isDefault": true,
"fullName": "John Doe",
"addressLine1": "Boring Street",
"addressLine2": "Awesome Colony",
"zipcode": "123456",
"city": "Mumbai",
"state": "MH",
"country": "IN"
}
]Request
GET
api/default-address/{id}
URL Parameters
id string
ID of the user.
Retrieve User Address
Retrieves the address for the specified user address ID.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/getaddress/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/getaddress/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"id": 1,
"isDefault": false,
"fullName": "John Doe",
"addressLine1": "Boring Street",
"addressLine2": "Awesome Colony",
"zipcode": "123456",
"city": "Mumbai",
"state": "MH",
"country": "IN"
}
]Request
GET
api/getaddress/{id}
URL Parameters
id string
ID of the user address row from UsersAddress Model.
Update Address
Updates the address for a specified user using UserAddress ID. (See Parameters)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/user/updateAddress/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"fullName":"John Doe","addressLine1":"Boring Street","addressLine2":"Awesome Colony","zipcode":"123456","city":"Mumbai","state":"NY","country":"US","isDefault":false}'
const url = new URL(
"https://demo.aomlms.com/api/user/updateAddress/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"fullName": "John Doe",
"addressLine1": "Boring Street",
"addressLine2": "Awesome Colony",
"zipcode": "123456",
"city": "Mumbai",
"state": "NY",
"country": "US",
"isDefault": false
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Address updated successfully"
}Request
POST
api/user/updateAddress/{id}
URL Parameters
id string
User Address row id for UsersAddress model.
Body Parameters
fullName string
Full Name of the user.
addressLine1 string
Address line1 of the user.
addressLine2 string optional
Address line2 of the user.
zipcode string
Zipcode of the user address.
city string
City of the user address.
state string optional
State of the user address.
country string
Country of the user address.
isDefault boolean
Is the address default for billing.
Retrieve User Report
Retrieves detailed report for a specified user. You can apply filter using search_params via course(course ID) and status(course status). (See parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/user/reports/user-detailed?user_id=4&group_id=1&page_size=10&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22course%22%3A%221%22%2C%22status%22%3A%5B%22In+Progress%22%5D%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/user/reports/user-detailed"
);
let params = {
"user_id": "4",
"group_id": "1",
"page_size": "10",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"course":"1","status":["In Progress"]}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"totalNotStarted": 1,
"totalInProgress": 0,
"totalCompleted": 0,
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"courseName": "course 1",
"status": "Not Started",
"percent_complete": 0,
"access_status": "Allowed",
"registered_on": "Aug 09, 2020",
"started_on": "",
"completed_on": "",
"expire_on": "Never",
"last_accessed_on": "Never",
"total_time_spent": "0h 0m",
"certifcate_issued": "No"
}
]
}Request
GET
api/user/reports/user-detailed
Query Parameters
user_id string
ID of the user.
group_id string optional
ID of the group.
page_size string
Number of the result row you want in each page.
page_number string
Current Page number.
order_by string optional
Returns details in some order.
search_param string optional
Returns search filtered data.
Retrieve User Report With Custom User Data
Retrieves detailed report for all user.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/users/report?page_size=10&page_number=1&export_role=Student®istered_between=%7B%22first_name%22%3A%22Aom%22%2C%22last_name%22Staff%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/users/report"
);
let params = {
"page_size": "10",
"page_number": "1",
"export_role": "Student",
"registered_between": "{"first_name":"Aom","last_name"Staff"}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"totalNotStarted": 1,
"totalInProgress": 0,
"totalCompleted": 0,
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"first_name": "Aom",
"last_name": "Staff",
"email": "[email protected]",
"display_role": "Super Admin",
"created_at": "Aug 09, 2020",
"last_login": "Oct 09, 2020"
}
]
}Request
GET
api/users/report
Query Parameters
page_size string
Number of the result row you want in each page.
page_number string
Current Page number.
export_role string optional
Returns details of specific user role.
registered_between string optional
Returns search filtered data.
Retrieve User Subscription Tabular List
Returns all the user subscriptions created in a tabular list format. You can apply filter using search_param.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/user-subscriptions" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"user_id":4,"page_size":"10","page_number":"1","order_by":"{\"colName\":\"created_at\",\"direction\":\"desc\"}","search_param":"Active"}'
const url = new URL(
"https://demo.aomlms.com/api/user-subscriptions"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"user_id": 4,
"page_size": "10",
"page_number": "1",
"order_by": "{\"colName\":\"created_at\",\"direction\":\"desc\"}",
"search_param": "Active"
}
fetch(url, {
method: "GET",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"avatar": 4,
"recordsTotal": 1,
"currencySymbol": "$",
"recordsFiltered": 1,
"name": "Aom Staff",
"email": "[email protected]",
"records": [
{
"id": 3,
"item": "Professional Training and Education",
"status": "Active",
"total": "100",
"created_at": "Aug 10, 2020 12:43 PM"
}
]
}Request
GET
api/user-subscriptions
Body Parameters
user_id integer
ID of the user.
page_size required optional
The number of the user you want for a page.
page_number required optional
Current page number in pagination.
order_by For optional
Ordering items based on columns provided in JSON format.
search_param for optional
Searching items based on status.
Get Membership Content
Retrieves all the Membership contents in a tabular list format with pagination mode. You can apply filter using search_param via content-type (course or modules), content name or Description
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/membership/user-contents?page_size=10&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C%22direction%22%3A%22desc%22%7D&search_param=%7B%22type%22%3A%5B%27course%27%5D%2C%22nameOrDescription%22%3A%22course+1+description%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/membership/user-contents"
);
let params = {
"page_size": "10",
"page_number": "1",
"order_by": "{"colName":"created_at","direction":"desc"}",
"search_param": "{"type":['course'],"nameOrDescription":"course 1 description"}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 4,
"recordsFiltered": 4,
"records": [
{
"id": 4,
"first_name": "John",
"last_name": "Doe",
"email": "[email protected]",
"avatar": "<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"40\" height=\"40\" viewBox=\"0 0 40 40\"><circle cx=\"20\" cy=\"20\" r=\"20\" stroke=\"background\" stroke-width=\"0\" fill=\"#03A9F4\" \/><text x=\"20\" y=\"20\" font-size=\"14\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">JD<\/text><\/svg>",
"role": "student",
"display_role": "Student",
"created_at": "Aug 06, 2020 07:20 AM",
"last_login": "2 days ago"
},
{
"id": 2,
"first_name": "Client",
"last_name": "Admin",
"email": "[email protected]",
"avatar": "<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"40\" height=\"40\" viewBox=\"0 0 40 40\"><circle cx=\"20\" cy=\"20\" r=\"20\" stroke=\"background\" stroke-width=\"0\" fill=\"#673AB7\" \/><text x=\"20\" y=\"20\" font-size=\"14\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">CA<\/text><\/svg>",
"role": "admin",
"display_role": "Admin",
"created_at": "Aug 03, 2020 09:31 AM",
"last_login": "Never"
},
{
"id": 3,
"first_name": "Demoss",
"last_name": "Student",
"email": "[email protected]",
"avatar": "<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"40\" height=\"40\" viewBox=\"0 0 40 40\"><circle cx=\"20\" cy=\"20\" r=\"20\" stroke=\"background\" stroke-width=\"0\" fill=\"#FF5722\" \/><text x=\"20\" y=\"20\" font-size=\"14\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">DS<\/text><\/svg>",
"role": "student",
"display_role": "Student",
"created_at": "Aug 03, 2020 09:31 AM",
"last_login": "5 days ago"
},
{
"id": 1,
"first_name": "Aom",
"last_name": "Staff",
"email": "[email protected]",
"avatar": "<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" width=\"40\" height=\"40\" viewBox=\"0 0 40 40\"><circle cx=\"20\" cy=\"20\" r=\"20\" stroke=\"background\" stroke-width=\"0\" fill=\"#00BCD4\" \/><text x=\"20\" y=\"20\" font-size=\"14\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">AS<\/text><\/svg>",
"role": "superadmin",
"display_role": "Super Admin",
"created_at": "Aug 03, 2020 09:31 AM",
"last_login": "1 minute ago"
}
]
}Request
GET
api/membership/user-contents
Query Parameters
page_size string
The number of the user you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
for searching items based on Course category ids, course name and role names.
api/users/update-class-status
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/users/update-class-status" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/users/update-class-status"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/users/update-class-status
api/users/enrolled-classes
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/users/enrolled-classes" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/users/enrolled-classes"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/users/enrolled-classes
api/user/class/reports
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/user/class/reports" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/user/class/reports"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/user/class/reports
api/user/badges/{id}
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/user/badges/{id}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/user/badges/{id}"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/user/badges/{id}
api/user/leaderboard/{id}
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/user/leaderboard/{id}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/user/leaderboard/{id}"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (401):
{
"message": "Unauthenticated."
}Request
GET
api/user/leaderboard/{id}
Retrieve 2fa
Retrieves two factor authentication details for a specified user. Returned data includes QR code and String code.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/user-meta/2fa?user_id=4" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/user-meta/2fa"
);
let params = {
"user_id": "4",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"as_qr_code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" version=\"1.1\" width=\"200\" height=\"200\" viewBox=\"0 0 200 200\"><rect x=\"0\" y=\"0\" width=\"200\" height=\"200\" fill=\"#fefefe\"\/><g transform=\"scale(4.444)\"><g transform=\"translate(0,0)\"><path fill-rule=\"evenodd\" d=\"M10 0L10 1L8 1L8 2L9 2L9 3L8 3L8 4L10 4L10 5L8 5L8 7L9 7L9 6L10 6L10 8L6 8L6 9L8 9L8 10L5 10L5 8L0 8L0 9L4 9L4 11L7 11L7 12L5 12L5 13L7 13L7 12L8 12L8 11L9 11L9 14L10 14L10 11L9 11L9 10L10 10L10 8L11 8L11 9L12 9L12 8L11 8L11 6L12 6L12 7L13 7L13 8L14 8L14 7L15 7L15 6L14 6L14 7L13 7L13 6L12 6L12 5L13 5L13 4L12 4L12 2L13 2L13 3L14 3L14 2L16 2L16 3L15 3L15 4L14 4L14 5L15 5L15 4L17 4L17 5L16 5L16 8L18 8L18 9L17 9L17 12L16 12L16 11L15 11L15 10L16 10L16 9L15 9L15 10L14 10L14 9L13 9L13 10L11 10L11 13L12 13L12 12L13 12L13 13L14 13L14 14L13 14L13 15L14 15L14 16L8 16L8 17L10 17L10 18L11 18L11 19L12 19L12 21L14 21L14 22L15 22L15 24L16 24L16 22L15 22L15 21L20 21L20 23L19 23L19 24L20 24L20 25L18 25L18 24L17 24L17 25L18 25L18 26L17 26L17 28L16 28L16 27L15 27L15 26L16 26L16 25L15 25L15 26L14 26L14 25L13 25L13 24L14 24L14 23L13 23L13 24L12 24L12 25L11 25L11 22L9 22L9 21L10 21L10 20L8 20L8 18L6 18L6 17L7 17L7 16L6 16L6 15L7 15L7 14L3 14L3 16L1 16L1 14L2 14L2 13L1 13L1 11L2 11L2 12L3 12L3 10L1 10L1 11L0 11L0 13L1 13L1 14L0 14L0 16L1 16L1 17L0 17L0 20L1 20L1 21L0 21L0 22L1 22L1 23L0 23L0 24L1 24L1 25L4 25L4 26L2 26L2 28L3 28L3 29L2 29L2 30L3 30L3 29L4 29L4 32L5 32L5 33L8 33L8 34L6 34L6 35L8 35L8 36L6 36L6 37L8 37L8 39L9 39L9 40L8 40L8 45L12 45L12 43L11 43L11 42L12 42L12 41L13 41L13 43L14 43L14 44L13 44L13 45L14 45L14 44L15 44L15 45L17 45L17 44L16 44L16 43L14 43L14 41L13 41L13 40L14 40L14 39L12 39L12 38L13 38L13 37L11 37L11 35L12 35L12 36L14 36L14 35L16 35L16 37L14 37L14 38L16 38L16 37L20 37L20 38L19 38L19 40L20 40L20 41L18 41L18 40L17 40L17 41L18 41L18 42L17 42L17 43L18 43L18 42L20 42L20 44L18 44L18 45L20 45L20 44L21 44L21 45L23 45L23 44L24 44L24 45L26 45L26 44L28 44L28 42L34 42L34 43L37 43L37 41L39 41L39 44L38 44L38 45L44 45L44 44L43 44L43 41L42 41L42 40L45 40L45 39L44 39L44 38L45 38L45 36L44 36L44 34L45 34L45 33L44 33L44 34L43 34L43 33L41 33L41 34L39 34L39 33L35 33L35 34L34 34L34 32L35 32L35 31L37 31L37 32L39 32L39 31L38 31L38 30L35 30L35 31L34 31L34 30L33 30L33 29L35 29L35 28L36 28L36 29L38 29L38 28L36 28L36 27L38 27L38 25L42 25L42 26L43 26L43 27L41 27L41 28L39 28L39 30L40 30L40 32L43 32L43 31L44 31L44 32L45 32L45 31L44 31L44 30L45 30L45 27L44 27L44 26L45 26L45 25L44 25L44 22L45 22L45 21L44 21L44 20L43 20L43 19L44 19L44 18L45 18L45 17L44 17L44 16L43 16L43 14L45 14L45 13L43 13L43 11L44 11L44 10L45 10L45 9L44 9L44 8L43 8L43 9L44 9L44 10L42 10L42 8L41 8L41 12L42 12L42 14L39 14L39 15L37 15L37 14L38 14L38 13L37 13L37 12L38 12L38 11L39 11L39 10L40 10L40 8L39 8L39 10L38 10L38 8L37 8L37 6L36 6L36 7L35 7L35 6L34 6L34 5L37 5L37 3L36 3L36 1L37 1L37 0L36 0L36 1L35 1L35 4L32 4L32 3L31 3L31 2L33 2L33 3L34 3L34 2L33 2L33 1L34 1L34 0L32 0L32 1L31 1L31 0L28 0L28 1L26 1L26 0L25 0L25 1L24 1L24 0L23 0L23 3L22 3L22 2L21 2L21 1L22 1L22 0L21 0L21 1L19 1L19 2L18 2L18 0L16 0L16 1L13 1L13 0L12 0L12 1L11 1L11 0ZM28 1L28 2L30 2L30 1ZM10 2L10 4L11 4L11 5L12 5L12 4L11 4L11 2ZM17 2L17 4L18 4L18 6L17 6L17 7L18 7L18 6L19 6L19 7L20 7L20 5L19 5L19 4L20 4L20 3L21 3L21 4L22 4L22 3L21 3L21 2L19 2L19 4L18 4L18 2ZM23 3L23 4L24 4L24 3ZM27 3L27 4L26 4L26 5L27 5L27 7L26 7L26 6L25 6L25 8L27 8L27 9L26 9L26 10L29 10L29 12L27 12L27 11L25 11L25 12L24 12L24 11L20 11L20 12L19 12L19 13L15 13L15 12L14 12L14 11L13 11L13 12L14 12L14 13L15 13L15 15L16 15L16 17L11 17L11 18L13 18L13 19L15 19L15 20L14 20L14 21L15 21L15 20L16 20L16 19L15 19L15 18L16 18L16 17L17 17L17 20L19 20L19 18L21 18L21 19L20 19L20 20L23 20L23 18L24 18L24 16L25 16L25 15L26 15L26 18L25 18L25 19L24 19L24 20L26 20L26 22L28 22L28 23L26 23L26 26L27 26L27 27L26 27L26 28L25 28L25 29L26 29L26 30L25 30L25 33L24 33L24 34L17 34L17 36L18 36L18 35L19 35L19 36L20 36L20 35L22 35L22 36L23 36L23 35L25 35L25 37L26 37L26 38L25 38L25 39L26 39L26 38L28 38L28 39L29 39L29 38L30 38L30 40L26 40L26 42L24 42L24 41L20 41L20 42L24 42L24 44L25 44L25 43L27 43L27 42L28 42L28 41L31 41L31 40L32 40L32 41L34 41L34 42L35 42L35 37L36 37L36 36L39 36L39 34L38 34L38 35L36 35L36 34L35 34L35 36L34 36L34 35L33 35L33 32L34 32L34 31L33 31L33 32L32 32L32 31L30 31L30 30L27 30L27 29L31 29L31 28L32 28L32 29L33 29L33 27L32 27L32 25L33 25L33 26L35 26L35 27L34 27L34 28L35 28L35 27L36 27L36 26L35 26L35 24L36 24L36 23L34 23L34 22L36 22L36 21L34 21L34 20L36 20L36 19L32 19L32 21L31 21L31 22L32 22L32 23L30 23L30 22L29 22L29 20L26 20L26 18L27 18L27 19L28 19L28 17L29 17L29 16L30 16L30 15L31 15L31 16L32 16L32 17L33 17L33 18L35 18L35 17L33 17L33 16L36 16L36 17L37 17L37 16L36 16L36 14L35 14L35 13L36 13L36 11L38 11L38 10L35 10L35 9L37 9L37 8L35 8L35 7L34 7L34 6L33 6L33 7L34 7L34 8L32 8L32 6L31 6L31 5L30 5L30 4L31 4L31 3ZM28 4L28 5L29 5L29 6L28 6L28 8L29 8L29 6L30 6L30 9L29 9L29 10L31 10L31 9L32 9L32 8L31 8L31 6L30 6L30 5L29 5L29 4ZM21 5L21 8L24 8L24 5ZM22 6L22 7L23 7L23 6ZM19 8L19 9L18 9L18 11L19 11L19 9L20 9L20 10L24 10L24 9L20 9L20 8ZM32 10L32 11L33 11L33 12L34 12L34 11L35 11L35 10L34 10L34 11L33 11L33 10ZM30 11L30 12L31 12L31 13L30 13L30 14L28 14L28 13L27 13L27 12L26 12L26 13L25 13L25 14L23 14L23 15L25 15L25 14L26 14L26 15L27 15L27 16L29 16L29 15L30 15L30 14L32 14L32 16L33 16L33 15L34 15L34 14L32 14L32 12L31 12L31 11ZM21 12L21 14L20 14L20 13L19 13L19 14L17 14L17 15L19 15L19 16L18 16L18 18L19 18L19 16L20 16L20 17L23 17L23 16L22 16L22 15L21 15L21 14L22 14L22 13L23 13L23 12ZM26 13L26 14L27 14L27 15L28 15L28 14L27 14L27 13ZM19 14L19 15L20 15L20 16L21 16L21 15L20 15L20 14ZM39 15L39 17L38 17L38 18L39 18L39 20L41 20L41 19L40 19L40 17L41 17L41 18L42 18L42 19L43 19L43 18L42 18L42 17L43 17L43 16L42 16L42 17L41 17L41 16L40 16L40 15ZM5 16L5 17L6 17L6 16ZM2 17L2 21L1 21L1 22L2 22L2 23L1 23L1 24L2 24L2 23L3 23L3 21L4 21L4 20L3 20L3 19L5 19L5 20L7 20L7 19L6 19L6 18L3 18L3 17ZM29 18L29 19L31 19L31 18ZM5 21L5 24L8 24L8 21ZM21 21L21 24L24 24L24 21ZM32 21L32 22L34 22L34 21ZM37 21L37 24L40 24L40 21ZM6 22L6 23L7 23L7 22ZM17 22L17 23L18 23L18 22ZM22 22L22 23L23 23L23 22ZM38 22L38 23L39 23L39 22ZM9 23L9 24L10 24L10 23ZM28 23L28 24L27 24L27 25L28 25L28 24L29 24L29 26L28 26L28 27L27 27L27 28L29 28L29 26L31 26L31 25L32 25L32 24L33 24L33 23L32 23L32 24L31 24L31 25L30 25L30 23ZM42 24L42 25L43 25L43 24ZM6 25L6 26L5 26L5 27L4 27L4 28L5 28L5 27L6 27L6 28L9 28L9 30L8 30L8 29L5 29L5 30L7 30L7 31L5 31L5 32L7 32L7 31L9 31L9 32L8 32L8 33L9 33L9 34L8 34L8 35L9 35L9 34L12 34L12 33L10 33L10 30L11 30L11 29L13 29L13 30L14 30L14 29L16 29L16 31L15 31L15 32L16 32L16 33L13 33L13 34L16 34L16 33L18 33L18 32L17 32L17 31L18 31L18 30L19 30L19 31L20 31L20 30L19 30L19 29L23 29L23 30L24 30L24 29L23 29L23 28L21 28L21 27L23 27L23 26L24 26L24 27L25 27L25 26L24 26L24 25L23 25L23 26L21 26L21 27L20 27L20 26L18 26L18 28L19 28L19 29L16 29L16 28L14 28L14 29L13 29L13 25L12 25L12 26L11 26L11 27L10 27L10 26L9 26L9 25ZM0 26L0 28L1 28L1 26ZM6 26L6 27L8 27L8 26ZM11 27L11 28L12 28L12 27ZM30 27L30 28L31 28L31 27ZM41 28L41 29L40 29L40 30L41 30L41 31L42 31L42 30L41 30L41 29L42 29L42 28ZM43 29L43 30L44 30L44 29ZM0 30L0 31L1 31L1 32L0 32L0 34L2 34L2 33L3 33L3 31L1 31L1 30ZM21 30L21 31L22 31L22 33L23 33L23 31L22 31L22 30ZM26 30L26 31L27 31L27 32L26 32L26 33L27 33L27 32L29 32L29 33L28 33L28 35L27 35L27 34L25 34L25 35L26 35L26 36L27 36L27 37L28 37L28 36L30 36L30 38L32 38L32 39L34 39L34 38L33 38L33 37L34 37L34 36L33 36L33 37L32 37L32 36L30 36L30 35L29 35L29 33L30 33L30 34L32 34L32 32L30 32L30 31L27 31L27 30ZM13 31L13 32L14 32L14 31ZM1 32L1 33L2 33L2 32ZM19 32L19 33L21 33L21 32ZM4 34L4 35L1 35L1 36L0 36L0 37L1 37L1 36L3 36L3 37L5 37L5 34ZM40 35L40 36L41 36L41 35ZM8 36L8 37L9 37L9 36ZM43 36L43 37L41 37L41 40L42 40L42 38L43 38L43 37L44 37L44 36ZM21 37L21 40L24 40L24 37ZM37 37L37 40L40 40L40 37ZM10 38L10 39L11 39L11 40L10 40L10 41L9 41L9 42L11 42L11 41L12 41L12 39L11 39L11 38ZM17 38L17 39L18 39L18 38ZM22 38L22 39L23 39L23 38ZM38 38L38 39L39 39L39 38ZM15 41L15 42L16 42L16 41ZM41 41L41 42L40 42L40 43L42 43L42 41ZM44 42L44 43L45 43L45 42ZM9 43L9 44L11 44L11 43ZM21 43L21 44L23 44L23 43ZM29 43L29 44L30 44L30 45L32 45L32 44L31 44L31 43ZM34 44L34 45L35 45L35 44ZM36 44L36 45L37 45L37 44ZM0 0L0 7L7 7L7 0ZM1 1L1 6L6 6L6 1ZM2 2L2 5L5 5L5 2ZM38 0L38 7L45 7L45 0ZM39 1L39 6L44 6L44 1ZM40 2L40 5L43 5L43 2ZM0 38L0 45L7 45L7 38ZM1 39L1 44L6 44L6 39ZM2 40L2 43L5 43L5 40Z\" fill=\"#000000\"\/><\/g><\/g><\/svg>\n",
"as_uri": "otpauth:\/\/totp\/Laravel%[email protected]?issuer=Laravel&label=john%40aom.com&secret=CREPRUYTMCBSCPEAG2LGKOFYOF25BL4A&algorithm=SHA1&digits=6",
"as_string": "CREPRUYTMCBSCPEAG2LGKOFYOF25BL4A"
}Request
GET
api/user-meta/2fa
Query Parameters
user_id string
ID of the user.
Prepare 2fa
To prepares QR code for Two factor authentication, you need to use this request. Returns QR code, URI code and String code for users to authenticate themselves using their authenticator app.
Example request:
curl -X POST \
"https://demo.aomlms.com/api/user/prepareTwoFactorAuth" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"user_id":4}'
const url = new URL(
"https://demo.aomlms.com/api/user/prepareTwoFactorAuth"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"user_id": 4
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"as_qr_code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<svg xmlns=\"http:\/\/www.w3.org\/2000\/svg\" version=\"1.1\" width=\"200\" height=\"200\" viewBox=\"0 0 200 200\"><rect x=\"0\" y=\"0\" width=\"200\" height=\"200\" fill=\"#fefefe\"\/><g transform=\"scale(4.444)\"><g transform=\"translate(0,0)\"><path fill-rule=\"evenodd\" d=\"M10 0L10 1L8 1L8 2L9 2L9 3L8 3L8 4L10 4L10 5L8 5L8 7L9 7L9 6L10 6L10 8L6 8L6 9L8 9L8 10L5 10L5 8L0 8L0 9L4 9L4 11L7 11L7 12L5 12L5 13L7 13L7 12L8 12L8 11L9 11L9 14L10 14L10 11L9 11L9 10L10 10L10 8L11 8L11 9L12 9L12 8L11 8L11 6L12 6L12 7L13 7L13 8L14 8L14 7L15 7L15 6L14 6L14 7L13 7L13 6L12 6L12 5L13 5L13 4L12 4L12 2L13 2L13 3L14 3L14 2L16 2L16 3L15 3L15 4L14 4L14 5L15 5L15 4L17 4L17 5L16 5L16 8L18 8L18 9L17 9L17 12L16 12L16 11L15 11L15 10L16 10L16 9L15 9L15 10L14 10L14 9L13 9L13 10L11 10L11 13L12 13L12 12L13 12L13 13L14 13L14 14L13 14L13 15L14 15L14 16L8 16L8 17L10 17L10 18L11 18L11 19L12 19L12 21L14 21L14 22L15 22L15 24L16 24L16 22L15 22L15 21L20 21L20 23L19 23L19 24L20 24L20 25L18 25L18 24L17 24L17 25L18 25L18 26L17 26L17 28L16 28L16 27L15 27L15 26L16 26L16 25L15 25L15 26L14 26L14 25L13 25L13 24L14 24L14 23L13 23L13 24L12 24L12 25L11 25L11 22L9 22L9 21L10 21L10 20L8 20L8 18L6 18L6 17L7 17L7 16L6 16L6 15L7 15L7 14L3 14L3 16L1 16L1 14L2 14L2 13L1 13L1 11L2 11L2 12L3 12L3 10L1 10L1 11L0 11L0 13L1 13L1 14L0 14L0 16L1 16L1 17L0 17L0 20L1 20L1 21L0 21L0 22L1 22L1 23L0 23L0 24L1 24L1 25L4 25L4 26L2 26L2 28L3 28L3 29L2 29L2 30L3 30L3 29L4 29L4 32L5 32L5 33L8 33L8 34L6 34L6 35L8 35L8 36L6 36L6 37L8 37L8 39L9 39L9 40L8 40L8 45L12 45L12 43L11 43L11 42L12 42L12 41L13 41L13 43L14 43L14 44L13 44L13 45L14 45L14 44L15 44L15 45L17 45L17 44L16 44L16 43L14 43L14 41L13 41L13 40L14 40L14 39L12 39L12 38L13 38L13 37L11 37L11 35L12 35L12 36L14 36L14 35L16 35L16 37L14 37L14 38L16 38L16 37L20 37L20 38L19 38L19 40L20 40L20 41L18 41L18 40L17 40L17 41L18 41L18 42L17 42L17 43L18 43L18 42L20 42L20 44L18 44L18 45L20 45L20 44L21 44L21 45L23 45L23 44L24 44L24 45L26 45L26 44L28 44L28 42L34 42L34 43L37 43L37 41L39 41L39 44L38 44L38 45L44 45L44 44L43 44L43 41L42 41L42 40L45 40L45 39L44 39L44 38L45 38L45 36L44 36L44 34L45 34L45 33L44 33L44 34L43 34L43 33L41 33L41 34L39 34L39 33L35 33L35 34L34 34L34 32L35 32L35 31L37 31L37 32L39 32L39 31L38 31L38 30L35 30L35 31L34 31L34 30L33 30L33 29L35 29L35 28L36 28L36 29L38 29L38 28L36 28L36 27L38 27L38 25L42 25L42 26L43 26L43 27L41 27L41 28L39 28L39 30L40 30L40 32L43 32L43 31L44 31L44 32L45 32L45 31L44 31L44 30L45 30L45 27L44 27L44 26L45 26L45 25L44 25L44 22L45 22L45 21L44 21L44 20L43 20L43 19L44 19L44 18L45 18L45 17L44 17L44 16L43 16L43 14L45 14L45 13L43 13L43 11L44 11L44 10L45 10L45 9L44 9L44 8L43 8L43 9L44 9L44 10L42 10L42 8L41 8L41 12L42 12L42 14L39 14L39 15L37 15L37 14L38 14L38 13L37 13L37 12L38 12L38 11L39 11L39 10L40 10L40 8L39 8L39 10L38 10L38 8L37 8L37 6L36 6L36 7L35 7L35 6L34 6L34 5L37 5L37 3L36 3L36 1L37 1L37 0L36 0L36 1L35 1L35 4L32 4L32 3L31 3L31 2L33 2L33 3L34 3L34 2L33 2L33 1L34 1L34 0L32 0L32 1L31 1L31 0L28 0L28 1L26 1L26 0L25 0L25 1L24 1L24 0L23 0L23 3L22 3L22 2L21 2L21 1L22 1L22 0L21 0L21 1L19 1L19 2L18 2L18 0L16 0L16 1L13 1L13 0L12 0L12 1L11 1L11 0ZM28 1L28 2L30 2L30 1ZM10 2L10 4L11 4L11 5L12 5L12 4L11 4L11 2ZM17 2L17 4L18 4L18 6L17 6L17 7L18 7L18 6L19 6L19 7L20 7L20 5L19 5L19 4L20 4L20 3L21 3L21 4L22 4L22 3L21 3L21 2L19 2L19 4L18 4L18 2ZM23 3L23 4L24 4L24 3ZM27 3L27 4L26 4L26 5L27 5L27 7L26 7L26 6L25 6L25 8L27 8L27 9L26 9L26 10L29 10L29 12L27 12L27 11L25 11L25 12L24 12L24 11L20 11L20 12L19 12L19 13L15 13L15 12L14 12L14 11L13 11L13 12L14 12L14 13L15 13L15 15L16 15L16 17L11 17L11 18L13 18L13 19L15 19L15 20L14 20L14 21L15 21L15 20L16 20L16 19L15 19L15 18L16 18L16 17L17 17L17 20L19 20L19 18L21 18L21 19L20 19L20 20L23 20L23 18L24 18L24 16L25 16L25 15L26 15L26 18L25 18L25 19L24 19L24 20L26 20L26 22L28 22L28 23L26 23L26 26L27 26L27 27L26 27L26 28L25 28L25 29L26 29L26 30L25 30L25 33L24 33L24 34L17 34L17 36L18 36L18 35L19 35L19 36L20 36L20 35L22 35L22 36L23 36L23 35L25 35L25 37L26 37L26 38L25 38L25 39L26 39L26 38L28 38L28 39L29 39L29 38L30 38L30 40L26 40L26 42L24 42L24 41L20 41L20 42L24 42L24 44L25 44L25 43L27 43L27 42L28 42L28 41L31 41L31 40L32 40L32 41L34 41L34 42L35 42L35 37L36 37L36 36L39 36L39 34L38 34L38 35L36 35L36 34L35 34L35 36L34 36L34 35L33 35L33 32L34 32L34 31L33 31L33 32L32 32L32 31L30 31L30 30L27 30L27 29L31 29L31 28L32 28L32 29L33 29L33 27L32 27L32 25L33 25L33 26L35 26L35 27L34 27L34 28L35 28L35 27L36 27L36 26L35 26L35 24L36 24L36 23L34 23L34 22L36 22L36 21L34 21L34 20L36 20L36 19L32 19L32 21L31 21L31 22L32 22L32 23L30 23L30 22L29 22L29 20L26 20L26 18L27 18L27 19L28 19L28 17L29 17L29 16L30 16L30 15L31 15L31 16L32 16L32 17L33 17L33 18L35 18L35 17L33 17L33 16L36 16L36 17L37 17L37 16L36 16L36 14L35 14L35 13L36 13L36 11L38 11L38 10L35 10L35 9L37 9L37 8L35 8L35 7L34 7L34 6L33 6L33 7L34 7L34 8L32 8L32 6L31 6L31 5L30 5L30 4L31 4L31 3ZM28 4L28 5L29 5L29 6L28 6L28 8L29 8L29 6L30 6L30 9L29 9L29 10L31 10L31 9L32 9L32 8L31 8L31 6L30 6L30 5L29 5L29 4ZM21 5L21 8L24 8L24 5ZM22 6L22 7L23 7L23 6ZM19 8L19 9L18 9L18 11L19 11L19 9L20 9L20 10L24 10L24 9L20 9L20 8ZM32 10L32 11L33 11L33 12L34 12L34 11L35 11L35 10L34 10L34 11L33 11L33 10ZM30 11L30 12L31 12L31 13L30 13L30 14L28 14L28 13L27 13L27 12L26 12L26 13L25 13L25 14L23 14L23 15L25 15L25 14L26 14L26 15L27 15L27 16L29 16L29 15L30 15L30 14L32 14L32 16L33 16L33 15L34 15L34 14L32 14L32 12L31 12L31 11ZM21 12L21 14L20 14L20 13L19 13L19 14L17 14L17 15L19 15L19 16L18 16L18 18L19 18L19 16L20 16L20 17L23 17L23 16L22 16L22 15L21 15L21 14L22 14L22 13L23 13L23 12ZM26 13L26 14L27 14L27 15L28 15L28 14L27 14L27 13ZM19 14L19 15L20 15L20 16L21 16L21 15L20 15L20 14ZM39 15L39 17L38 17L38 18L39 18L39 20L41 20L41 19L40 19L40 17L41 17L41 18L42 18L42 19L43 19L43 18L42 18L42 17L43 17L43 16L42 16L42 17L41 17L41 16L40 16L40 15ZM5 16L5 17L6 17L6 16ZM2 17L2 21L1 21L1 22L2 22L2 23L1 23L1 24L2 24L2 23L3 23L3 21L4 21L4 20L3 20L3 19L5 19L5 20L7 20L7 19L6 19L6 18L3 18L3 17ZM29 18L29 19L31 19L31 18ZM5 21L5 24L8 24L8 21ZM21 21L21 24L24 24L24 21ZM32 21L32 22L34 22L34 21ZM37 21L37 24L40 24L40 21ZM6 22L6 23L7 23L7 22ZM17 22L17 23L18 23L18 22ZM22 22L22 23L23 23L23 22ZM38 22L38 23L39 23L39 22ZM9 23L9 24L10 24L10 23ZM28 23L28 24L27 24L27 25L28 25L28 24L29 24L29 26L28 26L28 27L27 27L27 28L29 28L29 26L31 26L31 25L32 25L32 24L33 24L33 23L32 23L32 24L31 24L31 25L30 25L30 23ZM42 24L42 25L43 25L43 24ZM6 25L6 26L5 26L5 27L4 27L4 28L5 28L5 27L6 27L6 28L9 28L9 30L8 30L8 29L5 29L5 30L7 30L7 31L5 31L5 32L7 32L7 31L9 31L9 32L8 32L8 33L9 33L9 34L8 34L8 35L9 35L9 34L12 34L12 33L10 33L10 30L11 30L11 29L13 29L13 30L14 30L14 29L16 29L16 31L15 31L15 32L16 32L16 33L13 33L13 34L16 34L16 33L18 33L18 32L17 32L17 31L18 31L18 30L19 30L19 31L20 31L20 30L19 30L19 29L23 29L23 30L24 30L24 29L23 29L23 28L21 28L21 27L23 27L23 26L24 26L24 27L25 27L25 26L24 26L24 25L23 25L23 26L21 26L21 27L20 27L20 26L18 26L18 28L19 28L19 29L16 29L16 28L14 28L14 29L13 29L13 25L12 25L12 26L11 26L11 27L10 27L10 26L9 26L9 25ZM0 26L0 28L1 28L1 26ZM6 26L6 27L8 27L8 26ZM11 27L11 28L12 28L12 27ZM30 27L30 28L31 28L31 27ZM41 28L41 29L40 29L40 30L41 30L41 31L42 31L42 30L41 30L41 29L42 29L42 28ZM43 29L43 30L44 30L44 29ZM0 30L0 31L1 31L1 32L0 32L0 34L2 34L2 33L3 33L3 31L1 31L1 30ZM21 30L21 31L22 31L22 33L23 33L23 31L22 31L22 30ZM26 30L26 31L27 31L27 32L26 32L26 33L27 33L27 32L29 32L29 33L28 33L28 35L27 35L27 34L25 34L25 35L26 35L26 36L27 36L27 37L28 37L28 36L30 36L30 38L32 38L32 39L34 39L34 38L33 38L33 37L34 37L34 36L33 36L33 37L32 37L32 36L30 36L30 35L29 35L29 33L30 33L30 34L32 34L32 32L30 32L30 31L27 31L27 30ZM13 31L13 32L14 32L14 31ZM1 32L1 33L2 33L2 32ZM19 32L19 33L21 33L21 32ZM4 34L4 35L1 35L1 36L0 36L0 37L1 37L1 36L3 36L3 37L5 37L5 34ZM40 35L40 36L41 36L41 35ZM8 36L8 37L9 37L9 36ZM43 36L43 37L41 37L41 40L42 40L42 38L43 38L43 37L44 37L44 36ZM21 37L21 40L24 40L24 37ZM37 37L37 40L40 40L40 37ZM10 38L10 39L11 39L11 40L10 40L10 41L9 41L9 42L11 42L11 41L12 41L12 39L11 39L11 38ZM17 38L17 39L18 39L18 38ZM22 38L22 39L23 39L23 38ZM38 38L38 39L39 39L39 38ZM15 41L15 42L16 42L16 41ZM41 41L41 42L40 42L40 43L42 43L42 41ZM44 42L44 43L45 43L45 42ZM9 43L9 44L11 44L11 43ZM21 43L21 44L23 44L23 43ZM29 43L29 44L30 44L30 45L32 45L32 44L31 44L31 43ZM34 44L34 45L35 45L35 44ZM36 44L36 45L37 45L37 44ZM0 0L0 7L7 7L7 0ZM1 1L1 6L6 6L6 1ZM2 2L2 5L5 5L5 2ZM38 0L38 7L45 7L45 0ZM39 1L39 6L44 6L44 1ZM40 2L40 5L43 5L43 2ZM0 38L0 45L7 45L7 38ZM1 39L1 44L6 44L6 39ZM2 40L2 43L5 43L5 40Z\" fill=\"#000000\"\/><\/g><\/g><\/svg>\n",
"as_uri": "otpauth:\/\/totp\/Laravel%[email protected]?issuer=Laravel&label=john%40aom.com&secret=CREPRUYTMCBSCPEAG2LGKOFYOF25BL4A&algorithm=SHA1&digits=6",
"as_string": "CREPRUYTMCBSCPEAG2LGKOFYOF25BL4A"
}Request
POST
api/user/prepareTwoFactorAuth
Body Parameters
user_id integer
ID of the user.
Confirm 2fa
To confirms relation between your AOM site and your authnticator app for 2fa, you need to use this request. User need to provided secret code from authenticator app. It enables Two factor authentication feature in the system for users. (See parameters)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/user/confirmTwoFactorAuth" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"user_id":4,"secretCode":250987,"qrCode":"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<svg xmlns=\\\"http:\\\/\\\/www.w3.org\\\/2000\\\/svg\\\" version=\\\"1.1\\\" width=\\\"200\\\" height=\\\"200\\\" viewBox=\\\"0 0 200 200\\\"><rect x=\\\"0\\\" y=\\\"0\\\" width=\\\"200\\\" height=\\\"200\\\" fill=\\\"#fefefe\\\"\\\/><g transform=\\\"scale(4.444)\\\"><g transform=\\\"translate(0,0)\\\"><path fill-rule=\\\"evenodd\\\" d=\\\"M10 0L10 1L8 1L8 2L9 2L9 3L8 3L8 4L10 4L10 5L8 5L8 7L9 7L9 6L10 6L10 8L6 8L6 9L8 9L8 10L5 10L5 8L0 8L0 9L4 9L4 11L7 11L7 12L5 12L5 13L7 13L7 12L8 12L8 11L9 11L9 14L10 14L10 11L9 11L9 10L10 10L10 8L11 8L11 9L12 9L12 8L11 8L11 6L12 6L12 7L13 7L13 8L14 8L14 7L15 7L15 6L14 6L14 7L13 7L13 6L12 6L12 5L13 5L13 4L12 4L12 2L13 2L13 3L14 3L14 2L16 2L16 3L15 3L15 4L14 4L14 5L15 5L15 4L17 4L17 5L16 5L16 8L18 8L18 9L17 9L17 12L16 12L16 11L15 11L15 10L16 10L16 9L15 9L15 10L14 10L14 9L13 9L13 10L11 10L11 13L12 13L12 12L13 12L13 13L14 13L14 14L13 14L13 15L14 15L14 16L8 16L8 17L10 17L10 18L11 18L11 19L12 19L12 21L14 21L14 22L15 22L15 24L16 24L16 22L15 22L15 21L20 21L20 23L19 23L19 24L20 24L20 25L18 25L18 24L17 24L17 25L18 25L18 26L17 26L17 28L16 28L16 27L15 27L15 26L16 26L16 25L15 25L15 26L14 26L14 25L13 25L13 24L14 24L14 23L13 23L13 24L12 24L12 25L11 25L11 22L9 22L9 21L10 21L10 20L8 20L8 18L6 18L6 17L7 17L7 16L6 16L6 15L7 15L7 14L3 14L3 16L1 16L1 14L2 14L2 13L1 13L1 11L2 11L2 12L3 12L3 10L1 10L1 11L0 11L0 13L1 13L1 14L0 14L0 16L1 16L1 17L0 17L0 20L1 20L1 21L0 21L0 22L1 22L1 23L0 23L0 24L1 24L1 25L4 25L4 26L2 26L2 28L3 28L3 29L2 29L2 30L3 30L3 29L4 29L4 32L5 32L5 33L8 33L8 34L6 34L6 35L8 35L8 36L6 36L6 37L8 37L8 39L9 39L9 40L8 40L8 45L12 45L12 43L11 43L11 42L12 42L12 41L13 41L13 43L14 43L14 44L13 44L13 45L14 45L14 44L15 44L15 45L17 45L17 44L16 44L16 43L14 43L14 41L13 41L13 40L14 40L14 39L12 39L12 38L13 38L13 37L11 37L11 35L12 35L12 36L14 36L14 35L16 35L16 37L14 37L14 38L16 38L16 37L20 37L20 38L19 38L19 40L20 40L20 41L18 41L18 40L17 40L17 41L18 41L18 42L17 42L17 43L18 43L18 42L20 42L20 44L18 44L18 45L20 45L20 44L21 44L21 45L23 45L23 44L24 44L24 45L26 45L26 44L28 44L28 42L34 42L34 43L37 43L37 41L39 41L39 44L38 44L38 45L44 45L44 44L43 44L43 41L42 41L42 40L45 40L45 39L44 39L44 38L45 38L45 36L44 36L44 34L45 34L45 33L44 33L44 34L43 34L43 33L41 33L41 34L39 34L39 33L35 33L35 34L34 34L34 32L35 32L35 31L37 31L37 32L39 32L39 31L38 31L38 30L35 30L35 31L34 31L34 30L33 30L33 29L35 29L35 28L36 28L36 29L38 29L38 28L36 28L36 27L38 27L38 25L42 25L42 26L43 26L43 27L41 27L41 28L39 28L39 30L40 30L40 32L43 32L43 31L44 31L44 32L45 32L45 31L44 31L44 30L45 30L45 27L44 27L44 26L45 26L45 25L44 25L44 22L45 22L45 21L44 21L44 20L43 20L43 19L44 19L44 18L45 18L45 17L44 17L44 16L43 16L43 14L45 14L45 13L43 13L43 11L44 11L44 10L45 10L45 9L44 9L44 8L43 8L43 9L44 9L44 10L42 10L42 8L41 8L41 12L42 12L42 14L39 14L39 15L37 15L37 14L38 14L38 13L37 13L37 12L38 12L38 11L39 11L39 10L40 10L40 8L39 8L39 10L38 10L38 8L37 8L37 6L36 6L36 7L35 7L35 6L34 6L34 5L37 5L37 3L36 3L36 1L37 1L37 0L36 0L36 1L35 1L35 4L32 4L32 3L31 3L31 2L33 2L33 3L34 3L34 2L33 2L33 1L34 1L34 0L32 0L32 1L31 1L31 0L28 0L28 1L26 1L26 0L25 0L25 1L24 1L24 0L23 0L23 3L22 3L22 2L21 2L21 1L22 1L22 0L21 0L21 1L19 1L19 2L18 2L18 0L16 0L16 1L13 1L13 0L12 0L12 1L11 1L11 0ZM28 1L28 2L30 2L30 1ZM10 2L10 4L11 4L11 5L12 5L12 4L11 4L11 2ZM17 2L17 4L18 4L18 6L17 6L17 7L18 7L18 6L19 6L19 7L20 7L20 5L19 5L19 4L20 4L20 3L21 3L21 4L22 4L22 3L21 3L21 2L19 2L19 4L18 4L18 2ZM23 3L23 4L24 4L24 3ZM27 3L27 4L26 4L26 5L27 5L27 7L26 7L26 6L25 6L25 8L27 8L27 9L26 9L26 10L29 10L29 12L27 12L27 11L25 11L25 12L24 12L24 11L20 11L20 12L19 12L19 13L15 13L15 12L14 12L14 11L13 11L13 12L14 12L14 13L15 13L15 15L16 15L16 17L11 17L11 18L13 18L13 19L15 19L15 20L14 20L14 21L15 21L15 20L16 20L16 19L15 19L15 18L16 18L16 17L17 17L17 20L19 20L19 18L21 18L21 19L20 19L20 20L23 20L23 18L24 18L24 16L25 16L25 15L26 15L26 18L25 18L25 19L24 19L24 20L26 20L26 22L28 22L28 23L26 23L26 26L27 26L27 27L26 27L26 28L25 28L25 29L26 29L26 30L25 30L25 33L24 33L24 34L17 34L17 36L18 36L18 35L19 35L19 36L20 36L20 35L22 35L22 36L23 36L23 35L25 35L25 37L26 37L26 38L25 38L25 39L26 39L26 38L28 38L28 39L29 39L29 38L30 38L30 40L26 40L26 42L24 42L24 41L20 41L20 42L24 42L24 44L25 44L25 43L27 43L27 42L28 42L28 41L31 41L31 40L32 40L32 41L34 41L34 42L35 42L35 37L36 37L36 36L39 36L39 34L38 34L38 35L36 35L36 34L35 34L35 36L34 36L34 35L33 35L33 32L34 32L34 31L33 31L33 32L32 32L32 31L30 31L30 30L27 30L27 29L31 29L31 28L32 28L32 29L33 29L33 27L32 27L32 25L33 25L33 26L35 26L35 27L34 27L34 28L35 28L35 27L36 27L36 26L35 26L35 24L36 24L36 23L34 23L34 22L36 22L36 21L34 21L34 20L36 20L36 19L32 19L32 21L31 21L31 22L32 22L32 23L30 23L30 22L29 22L29 20L26 20L26 18L27 18L27 19L28 19L28 17L29 17L29 16L30 16L30 15L31 15L31 16L32 16L32 17L33 17L33 18L35 18L35 17L33 17L33 16L36 16L36 17L37 17L37 16L36 16L36 14L35 14L35 13L36 13L36 11L38 11L38 10L35 10L35 9L37 9L37 8L35 8L35 7L34 7L34 6L33 6L33 7L34 7L34 8L32 8L32 6L31 6L31 5L30 5L30 4L31 4L31 3ZM28 4L28 5L29 5L29 6L28 6L28 8L29 8L29 6L30 6L30 9L29 9L29 10L31 10L31 9L32 9L32 8L31 8L31 6L30 6L30 5L29 5L29 4ZM21 5L21 8L24 8L24 5ZM22 6L22 7L23 7L23 6ZM19 8L19 9L18 9L18 11L19 11L19 9L20 9L20 10L24 10L24 9L20 9L20 8ZM32 10L32 11L33 11L33 12L34 12L34 11L35 11L35 10L34 10L34 11L33 11L33 10ZM30 11L30 12L31 12L31 13L30 13L30 14L28 14L28 13L27 13L27 12L26 12L26 13L25 13L25 14L23 14L23 15L25 15L25 14L26 14L26 15L27 15L27 16L29 16L29 15L30 15L30 14L32 14L32 16L33 16L33 15L34 15L34 14L32 14L32 12L31 12L31 11ZM21 12L21 14L20 14L20 13L19 13L19 14L17 14L17 15L19 15L19 16L18 16L18 18L19 18L19 16L20 16L20 17L23 17L23 16L22 16L22 15L21 15L21 14L22 14L22 13L23 13L23 12ZM26 13L26 14L27 14L27 15L28 15L28 14L27 14L27 13ZM19 14L19 15L20 15L20 16L21 16L21 15L20 15L20 14ZM39 15L39 17L38 17L38 18L39 18L39 20L41 20L41 19L40 19L40 17L41 17L41 18L42 18L42 19L43 19L43 18L42 18L42 17L43 17L43 16L42 16L42 17L41 17L41 16L40 16L40 15ZM5 16L5 17L6 17L6 16ZM2 17L2 21L1 21L1 22L2 22L2 23L1 23L1 24L2 24L2 23L3 23L3 21L4 21L4 20L3 20L3 19L5 19L5 20L7 20L7 19L6 19L6 18L3 18L3 17ZM29 18L29 19L31 19L31 18ZM5 21L5 24L8 24L8 21ZM21 21L21 24L24 24L24 21ZM32 21L32 22L34 22L34 21ZM37 21L37 24L40 24L40 21ZM6 22L6 23L7 23L7 22ZM17 22L17 23L18 23L18 22ZM22 22L22 23L23 23L23 22ZM38 22L38 23L39 23L39 22ZM9 23L9 24L10 24L10 23ZM28 23L28 24L27 24L27 25L28 25L28 24L29 24L29 26L28 26L28 27L27 27L27 28L29 28L29 26L31 26L31 25L32 25L32 24L33 24L33 23L32 23L32 24L31 24L31 25L30 25L30 23ZM42 24L42 25L43 25L43 24ZM6 25L6 26L5 26L5 27L4 27L4 28L5 28L5 27L6 27L6 28L9 28L9 30L8 30L8 29L5 29L5 30L7 30L7 31L5 31L5 32L7 32L7 31L9 31L9 32L8 32L8 33L9 33L9 34L8 34L8 35L9 35L9 34L12 34L12 33L10 33L10 30L11 30L11 29L13 29L13 30L14 30L14 29L16 29L16 31L15 31L15 32L16 32L16 33L13 33L13 34L16 34L16 33L18 33L18 32L17 32L17 31L18 31L18 30L19 30L19 31L20 31L20 30L19 30L19 29L23 29L23 30L24 30L24 29L23 29L23 28L21 28L21 27L23 27L23 26L24 26L24 27L25 27L25 26L24 26L24 25L23 25L23 26L21 26L21 27L20 27L20 26L18 26L18 28L19 28L19 29L16 29L16 28L14 28L14 29L13 29L13 25L12 25L12 26L11 26L11 27L10 27L10 26L9 26L9 25ZM0 26L0 28L1 28L1 26ZM6 26L6 27L8 27L8 26ZM11 27L11 28L12 28L12 27ZM30 27L30 28L31 28L31 27ZM41 28L41 29L40 29L40 30L41 30L41 31L42 31L42 30L41 30L41 29L42 29L42 28ZM43 29L43 30L44 30L44 29ZM0 30L0 31L1 31L1 32L0 32L0 34L2 34L2 33L3 33L3 31L1 31L1 30ZM21 30L21 31L22 31L22 33L23 33L23 31L22 31L22 30ZM26 30L26 31L27 31L27 32L26 32L26 33L27 33L27 32L29 32L29 33L28 33L28 35L27 35L27 34L25 34L25 35L26 35L26 36L27 36L27 37L28 37L28 36L30 36L30 38L32 38L32 39L34 39L34 38L33 38L33 37L34 37L34 36L33 36L33 37L32 37L32 36L30 36L30 35L29 35L29 33L30 33L30 34L32 34L32 32L30 32L30 31L27 31L27 30ZM13 31L13 32L14 32L14 31ZM1 32L1 33L2 33L2 32ZM19 32L19 33L21 33L21 32ZM4 34L4 35L1 35L1 36L0 36L0 37L1 37L1 36L3 36L3 37L5 37L5 34ZM40 35L40 36L41 36L41 35ZM8 36L8 37L9 37L9 36ZM43 36L43 37L41 37L41 40L42 40L42 38L43 38L43 37L44 37L44 36ZM21 37L21 40L24 40L24 37ZM37 37L37 40L40 40L40 37ZM10 38L10 39L11 39L11 40L10 40L10 41L9 41L9 42L11 42L11 41L12 41L12 39L11 39L11 38ZM17 38L17 39L18 39L18 38ZM22 38L22 39L23 39L23 38ZM38 38L38 39L39 39L39 38ZM15 41L15 42L16 42L16 41ZM41 41L41 42L40 42L40 43L42 43L42 41ZM44 42L44 43L45 43L45 42ZM9 43L9 44L11 44L11 43ZM21 43L21 44L23 44L23 43ZM29 43L29 44L30 44L30 45L32 45L32 44L31 44L31 43ZM34 44L34 45L35 45L35 44ZM36 44L36 45L37 45L37 44ZM0 0L0 7L7 7L7 0ZM1 1L1 6L6 6L6 1ZM2 2L2 5L5 5L5 2ZM38 0L38 7L45 7L45 0ZM39 1L39 6L44 6L44 1ZM40 2L40 5L43 5L43 2ZM0 38L0 45L7 45L7 38ZM1 39L1 44L6 44L6 39ZM2 40L2 43L5 43L5 40Z\\\" fill=\\\"#000000\\\"\\\/><\\\/g><\\\/g><\\\/svg>\\n","stringCode":"CREPRUYTMCBSCPEAG2LGKOFYOF25BLR3E"}'
const url = new URL(
"https://demo.aomlms.com/api/user/confirmTwoFactorAuth"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"user_id": 4,
"secretCode": 250987,
"qrCode": "<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<svg xmlns=\\\"http:\\\/\\\/www.w3.org\\\/2000\\\/svg\\\" version=\\\"1.1\\\" width=\\\"200\\\" height=\\\"200\\\" viewBox=\\\"0 0 200 200\\\"><rect x=\\\"0\\\" y=\\\"0\\\" width=\\\"200\\\" height=\\\"200\\\" fill=\\\"#fefefe\\\"\\\/><g transform=\\\"scale(4.444)\\\"><g transform=\\\"translate(0,0)\\\"><path fill-rule=\\\"evenodd\\\" d=\\\"M10 0L10 1L8 1L8 2L9 2L9 3L8 3L8 4L10 4L10 5L8 5L8 7L9 7L9 6L10 6L10 8L6 8L6 9L8 9L8 10L5 10L5 8L0 8L0 9L4 9L4 11L7 11L7 12L5 12L5 13L7 13L7 12L8 12L8 11L9 11L9 14L10 14L10 11L9 11L9 10L10 10L10 8L11 8L11 9L12 9L12 8L11 8L11 6L12 6L12 7L13 7L13 8L14 8L14 7L15 7L15 6L14 6L14 7L13 7L13 6L12 6L12 5L13 5L13 4L12 4L12 2L13 2L13 3L14 3L14 2L16 2L16 3L15 3L15 4L14 4L14 5L15 5L15 4L17 4L17 5L16 5L16 8L18 8L18 9L17 9L17 12L16 12L16 11L15 11L15 10L16 10L16 9L15 9L15 10L14 10L14 9L13 9L13 10L11 10L11 13L12 13L12 12L13 12L13 13L14 13L14 14L13 14L13 15L14 15L14 16L8 16L8 17L10 17L10 18L11 18L11 19L12 19L12 21L14 21L14 22L15 22L15 24L16 24L16 22L15 22L15 21L20 21L20 23L19 23L19 24L20 24L20 25L18 25L18 24L17 24L17 25L18 25L18 26L17 26L17 28L16 28L16 27L15 27L15 26L16 26L16 25L15 25L15 26L14 26L14 25L13 25L13 24L14 24L14 23L13 23L13 24L12 24L12 25L11 25L11 22L9 22L9 21L10 21L10 20L8 20L8 18L6 18L6 17L7 17L7 16L6 16L6 15L7 15L7 14L3 14L3 16L1 16L1 14L2 14L2 13L1 13L1 11L2 11L2 12L3 12L3 10L1 10L1 11L0 11L0 13L1 13L1 14L0 14L0 16L1 16L1 17L0 17L0 20L1 20L1 21L0 21L0 22L1 22L1 23L0 23L0 24L1 24L1 25L4 25L4 26L2 26L2 28L3 28L3 29L2 29L2 30L3 30L3 29L4 29L4 32L5 32L5 33L8 33L8 34L6 34L6 35L8 35L8 36L6 36L6 37L8 37L8 39L9 39L9 40L8 40L8 45L12 45L12 43L11 43L11 42L12 42L12 41L13 41L13 43L14 43L14 44L13 44L13 45L14 45L14 44L15 44L15 45L17 45L17 44L16 44L16 43L14 43L14 41L13 41L13 40L14 40L14 39L12 39L12 38L13 38L13 37L11 37L11 35L12 35L12 36L14 36L14 35L16 35L16 37L14 37L14 38L16 38L16 37L20 37L20 38L19 38L19 40L20 40L20 41L18 41L18 40L17 40L17 41L18 41L18 42L17 42L17 43L18 43L18 42L20 42L20 44L18 44L18 45L20 45L20 44L21 44L21 45L23 45L23 44L24 44L24 45L26 45L26 44L28 44L28 42L34 42L34 43L37 43L37 41L39 41L39 44L38 44L38 45L44 45L44 44L43 44L43 41L42 41L42 40L45 40L45 39L44 39L44 38L45 38L45 36L44 36L44 34L45 34L45 33L44 33L44 34L43 34L43 33L41 33L41 34L39 34L39 33L35 33L35 34L34 34L34 32L35 32L35 31L37 31L37 32L39 32L39 31L38 31L38 30L35 30L35 31L34 31L34 30L33 30L33 29L35 29L35 28L36 28L36 29L38 29L38 28L36 28L36 27L38 27L38 25L42 25L42 26L43 26L43 27L41 27L41 28L39 28L39 30L40 30L40 32L43 32L43 31L44 31L44 32L45 32L45 31L44 31L44 30L45 30L45 27L44 27L44 26L45 26L45 25L44 25L44 22L45 22L45 21L44 21L44 20L43 20L43 19L44 19L44 18L45 18L45 17L44 17L44 16L43 16L43 14L45 14L45 13L43 13L43 11L44 11L44 10L45 10L45 9L44 9L44 8L43 8L43 9L44 9L44 10L42 10L42 8L41 8L41 12L42 12L42 14L39 14L39 15L37 15L37 14L38 14L38 13L37 13L37 12L38 12L38 11L39 11L39 10L40 10L40 8L39 8L39 10L38 10L38 8L37 8L37 6L36 6L36 7L35 7L35 6L34 6L34 5L37 5L37 3L36 3L36 1L37 1L37 0L36 0L36 1L35 1L35 4L32 4L32 3L31 3L31 2L33 2L33 3L34 3L34 2L33 2L33 1L34 1L34 0L32 0L32 1L31 1L31 0L28 0L28 1L26 1L26 0L25 0L25 1L24 1L24 0L23 0L23 3L22 3L22 2L21 2L21 1L22 1L22 0L21 0L21 1L19 1L19 2L18 2L18 0L16 0L16 1L13 1L13 0L12 0L12 1L11 1L11 0ZM28 1L28 2L30 2L30 1ZM10 2L10 4L11 4L11 5L12 5L12 4L11 4L11 2ZM17 2L17 4L18 4L18 6L17 6L17 7L18 7L18 6L19 6L19 7L20 7L20 5L19 5L19 4L20 4L20 3L21 3L21 4L22 4L22 3L21 3L21 2L19 2L19 4L18 4L18 2ZM23 3L23 4L24 4L24 3ZM27 3L27 4L26 4L26 5L27 5L27 7L26 7L26 6L25 6L25 8L27 8L27 9L26 9L26 10L29 10L29 12L27 12L27 11L25 11L25 12L24 12L24 11L20 11L20 12L19 12L19 13L15 13L15 12L14 12L14 11L13 11L13 12L14 12L14 13L15 13L15 15L16 15L16 17L11 17L11 18L13 18L13 19L15 19L15 20L14 20L14 21L15 21L15 20L16 20L16 19L15 19L15 18L16 18L16 17L17 17L17 20L19 20L19 18L21 18L21 19L20 19L20 20L23 20L23 18L24 18L24 16L25 16L25 15L26 15L26 18L25 18L25 19L24 19L24 20L26 20L26 22L28 22L28 23L26 23L26 26L27 26L27 27L26 27L26 28L25 28L25 29L26 29L26 30L25 30L25 33L24 33L24 34L17 34L17 36L18 36L18 35L19 35L19 36L20 36L20 35L22 35L22 36L23 36L23 35L25 35L25 37L26 37L26 38L25 38L25 39L26 39L26 38L28 38L28 39L29 39L29 38L30 38L30 40L26 40L26 42L24 42L24 41L20 41L20 42L24 42L24 44L25 44L25 43L27 43L27 42L28 42L28 41L31 41L31 40L32 40L32 41L34 41L34 42L35 42L35 37L36 37L36 36L39 36L39 34L38 34L38 35L36 35L36 34L35 34L35 36L34 36L34 35L33 35L33 32L34 32L34 31L33 31L33 32L32 32L32 31L30 31L30 30L27 30L27 29L31 29L31 28L32 28L32 29L33 29L33 27L32 27L32 25L33 25L33 26L35 26L35 27L34 27L34 28L35 28L35 27L36 27L36 26L35 26L35 24L36 24L36 23L34 23L34 22L36 22L36 21L34 21L34 20L36 20L36 19L32 19L32 21L31 21L31 22L32 22L32 23L30 23L30 22L29 22L29 20L26 20L26 18L27 18L27 19L28 19L28 17L29 17L29 16L30 16L30 15L31 15L31 16L32 16L32 17L33 17L33 18L35 18L35 17L33 17L33 16L36 16L36 17L37 17L37 16L36 16L36 14L35 14L35 13L36 13L36 11L38 11L38 10L35 10L35 9L37 9L37 8L35 8L35 7L34 7L34 6L33 6L33 7L34 7L34 8L32 8L32 6L31 6L31 5L30 5L30 4L31 4L31 3ZM28 4L28 5L29 5L29 6L28 6L28 8L29 8L29 6L30 6L30 9L29 9L29 10L31 10L31 9L32 9L32 8L31 8L31 6L30 6L30 5L29 5L29 4ZM21 5L21 8L24 8L24 5ZM22 6L22 7L23 7L23 6ZM19 8L19 9L18 9L18 11L19 11L19 9L20 9L20 10L24 10L24 9L20 9L20 8ZM32 10L32 11L33 11L33 12L34 12L34 11L35 11L35 10L34 10L34 11L33 11L33 10ZM30 11L30 12L31 12L31 13L30 13L30 14L28 14L28 13L27 13L27 12L26 12L26 13L25 13L25 14L23 14L23 15L25 15L25 14L26 14L26 15L27 15L27 16L29 16L29 15L30 15L30 14L32 14L32 16L33 16L33 15L34 15L34 14L32 14L32 12L31 12L31 11ZM21 12L21 14L20 14L20 13L19 13L19 14L17 14L17 15L19 15L19 16L18 16L18 18L19 18L19 16L20 16L20 17L23 17L23 16L22 16L22 15L21 15L21 14L22 14L22 13L23 13L23 12ZM26 13L26 14L27 14L27 15L28 15L28 14L27 14L27 13ZM19 14L19 15L20 15L20 16L21 16L21 15L20 15L20 14ZM39 15L39 17L38 17L38 18L39 18L39 20L41 20L41 19L40 19L40 17L41 17L41 18L42 18L42 19L43 19L43 18L42 18L42 17L43 17L43 16L42 16L42 17L41 17L41 16L40 16L40 15ZM5 16L5 17L6 17L6 16ZM2 17L2 21L1 21L1 22L2 22L2 23L1 23L1 24L2 24L2 23L3 23L3 21L4 21L4 20L3 20L3 19L5 19L5 20L7 20L7 19L6 19L6 18L3 18L3 17ZM29 18L29 19L31 19L31 18ZM5 21L5 24L8 24L8 21ZM21 21L21 24L24 24L24 21ZM32 21L32 22L34 22L34 21ZM37 21L37 24L40 24L40 21ZM6 22L6 23L7 23L7 22ZM17 22L17 23L18 23L18 22ZM22 22L22 23L23 23L23 22ZM38 22L38 23L39 23L39 22ZM9 23L9 24L10 24L10 23ZM28 23L28 24L27 24L27 25L28 25L28 24L29 24L29 26L28 26L28 27L27 27L27 28L29 28L29 26L31 26L31 25L32 25L32 24L33 24L33 23L32 23L32 24L31 24L31 25L30 25L30 23ZM42 24L42 25L43 25L43 24ZM6 25L6 26L5 26L5 27L4 27L4 28L5 28L5 27L6 27L6 28L9 28L9 30L8 30L8 29L5 29L5 30L7 30L7 31L5 31L5 32L7 32L7 31L9 31L9 32L8 32L8 33L9 33L9 34L8 34L8 35L9 35L9 34L12 34L12 33L10 33L10 30L11 30L11 29L13 29L13 30L14 30L14 29L16 29L16 31L15 31L15 32L16 32L16 33L13 33L13 34L16 34L16 33L18 33L18 32L17 32L17 31L18 31L18 30L19 30L19 31L20 31L20 30L19 30L19 29L23 29L23 30L24 30L24 29L23 29L23 28L21 28L21 27L23 27L23 26L24 26L24 27L25 27L25 26L24 26L24 25L23 25L23 26L21 26L21 27L20 27L20 26L18 26L18 28L19 28L19 29L16 29L16 28L14 28L14 29L13 29L13 25L12 25L12 26L11 26L11 27L10 27L10 26L9 26L9 25ZM0 26L0 28L1 28L1 26ZM6 26L6 27L8 27L8 26ZM11 27L11 28L12 28L12 27ZM30 27L30 28L31 28L31 27ZM41 28L41 29L40 29L40 30L41 30L41 31L42 31L42 30L41 30L41 29L42 29L42 28ZM43 29L43 30L44 30L44 29ZM0 30L0 31L1 31L1 32L0 32L0 34L2 34L2 33L3 33L3 31L1 31L1 30ZM21 30L21 31L22 31L22 33L23 33L23 31L22 31L22 30ZM26 30L26 31L27 31L27 32L26 32L26 33L27 33L27 32L29 32L29 33L28 33L28 35L27 35L27 34L25 34L25 35L26 35L26 36L27 36L27 37L28 37L28 36L30 36L30 38L32 38L32 39L34 39L34 38L33 38L33 37L34 37L34 36L33 36L33 37L32 37L32 36L30 36L30 35L29 35L29 33L30 33L30 34L32 34L32 32L30 32L30 31L27 31L27 30ZM13 31L13 32L14 32L14 31ZM1 32L1 33L2 33L2 32ZM19 32L19 33L21 33L21 32ZM4 34L4 35L1 35L1 36L0 36L0 37L1 37L1 36L3 36L3 37L5 37L5 34ZM40 35L40 36L41 36L41 35ZM8 36L8 37L9 37L9 36ZM43 36L43 37L41 37L41 40L42 40L42 38L43 38L43 37L44 37L44 36ZM21 37L21 40L24 40L24 37ZM37 37L37 40L40 40L40 37ZM10 38L10 39L11 39L11 40L10 40L10 41L9 41L9 42L11 42L11 41L12 41L12 39L11 39L11 38ZM17 38L17 39L18 39L18 38ZM22 38L22 39L23 39L23 38ZM38 38L38 39L39 39L39 38ZM15 41L15 42L16 42L16 41ZM41 41L41 42L40 42L40 43L42 43L42 41ZM44 42L44 43L45 43L45 42ZM9 43L9 44L11 44L11 43ZM21 43L21 44L23 44L23 43ZM29 43L29 44L30 44L30 45L32 45L32 44L31 44L31 43ZM34 44L34 45L35 45L35 44ZM36 44L36 45L37 45L37 44ZM0 0L0 7L7 7L7 0ZM1 1L1 6L6 6L6 1ZM2 2L2 5L5 5L5 2ZM38 0L38 7L45 7L45 0ZM39 1L39 6L44 6L44 1ZM40 2L40 5L43 5L43 2ZM0 38L0 45L7 45L7 38ZM1 39L1 44L6 44L6 39ZM2 40L2 43L5 43L5 40Z\\\" fill=\\\"#000000\\\"\\\/><\\\/g><\\\/g><\\\/svg>\\n",
"stringCode": "CREPRUYTMCBSCPEAG2LGKOFYOF25BLR3E"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"status": "success",
"message": "Two Factor Authentication activated"
}Request
POST
api/user/confirmTwoFactorAuth
Body Parameters
user_id integer
ID of the user.
secretCode number
secret code from users authenticator app.
qrCode string
QR code generated by prepareTwoFactor method.
stringCode string
String code generated by prepareTwoFactor method.
Disable 2fa
To disables Two factor authentication feature in system for specified user, you need to use this request. (See parameters)
Example request:
curl -X POST \
"https://demo.aomlms.com/api/user/disableTwoFactorAuth" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"user_id":4}'
const url = new URL(
"https://demo.aomlms.com/api/user/disableTwoFactorAuth"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"user_id": 4
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "2factor authentication disabled successfully",
"qrcode": null,
"stringcode": null
}Request
POST
api/user/disableTwoFactorAuth
Body Parameters
user_id integer
ID of the user.
Resend New Account Email
Send New Account Created email again.
Example request:
curl -X POST \
"https://demo.aomlms.com/api/email/resendNewAccountEmail" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"user_id":4}'
const url = new URL(
"https://demo.aomlms.com/api/email/resendNewAccountEmail"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"user_id": 4
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
[
{
"status": "success",
"message": "New Password is created and New Account Email Sent."
}
]Request
POST
api/email/resendNewAccountEmail
Body Parameters
user_id integer
ID of the user.
Videos
A Video Module is a lesson module used as course content. Helps to perform CRUD operation to and for Video modules.
Video Modules Tabular List
Returns all the video modules in a tabular list format in paginated mode. You can apply filter using search_param via associatedCourse(modules used in course) and moduleName.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/modules/video?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22associatedCourse%22%3A%22%22%2C%22moduleName%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/modules/video"
);
let params = {
"page_size": "50",
"page_number": "1",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"associatedCourse":"","moduleName":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 1,
"recordsFiltered": 1,
"records": [
{
"id": 3,
"name": "Video Module Name",
"slug": "video-module-name",
"type": "video",
"provider": "vimeo",
"icon": "<i class=\"el-icon-video-play\"><\/i>",
"author": "Aom Staff",
"created_at": "Aug 09, 2020 06:20 PM"
}
]
}Request
GET
api/modules/video
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
for searching items based on field names.
Create Video Module
To create a video module, you need to use this request. (See parameters) Created video modules can be used in the course as course content/lesson.
Returns : id of the video module created and successfull message
Example request:
curl -X POST \
"https://demo.aomlms.com/api/modules/video" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"My-video-lesson","content":"Brief Description","coverUrl":"ratione","url":"https:\/\/player.vimeo.com\/video\/382947752","provider":"vimeo","trackCompletion":true,"disableForwardSeek":true,"subtitle":"ad"}'
const url = new URL(
"https://demo.aomlms.com/api/modules/video"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "My-video-lesson",
"content": "Brief Description",
"coverUrl": "ratione",
"url": "https:\/\/player.vimeo.com\/video\/382947752",
"provider": "vimeo",
"trackCompletion": true,
"disableForwardSeek": true,
"subtitle": "ad"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 9,
"message": "Module saved successfully"
}Request
POST
api/modules/video
Body Parameters
name string
Name of the video module.
content string
Content for the video modules that students will see.
coverUrl string optional
Cover url path for the video module. Example:
url string
Url path for the video module.
provider string
Provider of the video. Provider options: vimeo, in-house, youtube.
trackCompletion boolean
If true, the module is being tracked(whether its finished or not) in course player.
disableForwardSeek boolean
If true, students will not be able to skip forward in the video.
subtitle string optional
The text to add subtitle in the video in vtt format. Example:
Retrieve Video Module
Retrieves the details of the specified video module. Helps in fetching video module using its ID. (See Parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/modules/video/3" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/modules/video/3"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "Video Module Name",
"slug": "video-module-name",
"content": null,
"provider": "vimeo",
"url": null,
"coverUrl": null,
"disableForwardSeek": true,
"trackCompletion": false,
"fileName": ""
}Request
GET
api/modules/video/{id}
URL Parameters
id string
ID of the video module you want to fetch the details of.
Update Video Module
Updates the details of the specified video module. (See parameters) Video modules can be used in the course as course content/lesson.
Returns : id of the video module created and successfull message
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/modules/video/{id}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"My-video-lesson","content":"Updated Brief Description","coverUrl":"sed","url":"https:\/\/player.vimeo.com\/video\/382947752","provider":"vimeo","trackCompletion":true,"disableForwardSeek":true,"subtitle":"gfg"}'
const url = new URL(
"https://demo.aomlms.com/api/modules/video/{id}"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "My-video-lesson",
"content": "Updated Brief Description",
"coverUrl": "sed",
"url": "https:\/\/player.vimeo.com\/video\/382947752",
"provider": "vimeo",
"trackCompletion": true,
"disableForwardSeek": true,
"subtitle": "gfg"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Module updated successfully"
}Request
PUT
api/modules/video/{id}
Body Parameters
name string
Name of the video module.
content string
Content for the video modules that students will see.
coverUrl string optional
Cover url path for the video module. Example:
url string
Url path for the video module.
provider string
Provider of the video. Provider options: vimeo, in-house, youtube.
trackCompletion boolean
If true, the module is being tracked(whether its finished or not) in course player.
disableForwardSeek boolean
If true, students will not be able to skip forward in the video.
subtitle string optional
The text to add subtitle in the video in vtt format.
Retrieve Detailed Video Module Info
Retrieves details of video module in depth as well as different modules details that are being used as course content for the same course the current video module is attached to. Returns related fields value. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/module/video/details?registrationId=1&moduleId=9" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/module/video/details"
);
let params = {
"registrationId": "1",
"moduleId": "9",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "My-video-lesson",
"slug": "my-video-lesson",
"content": "Brief Description",
"courseName": "course 1",
"courseSlug": "http:\/\/localhost:8000\/course\/course-1",
"min_time_spent": 0,
"otherModules": [
{
"module_id": 1,
"name": "test",
"slug": "test",
"type": "text",
"icon": "<i class=\"el-icon-tickets\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": 1,
"status": "Completed",
"started_on": "2020-08-03T10:02:33.000000Z",
"completed_on": "2020-08-03T10:02:41.000000Z",
"last_accessed_on": "1 hour ago",
"total_time_spent": {
"hours": 0,
"minutes": 0,
"seconds": 6,
"totalSeconds": 6
},
"completion_percentage": 100,
"no_of_times_accessed": 3
},
{
"module_id": 4,
"name": "assign",
"slug": "assign",
"type": "assignment",
"icon": "<i class=\"el-icon-edit-outline\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": true,
"status_row_id": -1,
"status": "Not Started",
"started_on": "",
"completed_on": "",
"last_accessed_on": "Never",
"total_time_spent": "",
"points_awarded": "",
"completion_percentage": 0,
"no_of_times_accessed": 0
},
{
"module_id": 7,
"name": "First-quiz",
"slug": "first-quiz",
"type": "quiz",
"icon": "<i class=\"el-icon-discover\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": -1,
"status": "Not Started",
"started_on": "",
"completed_on": "",
"last_accessed_on": "Never",
"total_time_spent": "",
"points_awarded": "",
"completion_percentage": 0,
"no_of_times_accessed": 0
},
{
"module_id": 9,
"name": "My-video-lesson",
"slug": "my-video-lesson",
"type": "video",
"icon": "<i class=\"el-icon-video-play\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": -1,
"status": "Not Started",
"started_on": "",
"completed_on": "",
"last_accessed_on": "Never",
"total_time_spent": "",
"points_awarded": "",
"completion_percentage": 0,
"no_of_times_accessed": 0
}
],
"launchCheck": {
"canbeLaunched": true,
"errTitle": "",
"errDesc": ""
},
"prevSlug": "first-quiz",
"nextSlug": "",
"provider": "vimeo",
"coverUrl": null,
"url": "https:\/\/player.vimeo.com\/video\/382947752",
"disableForwardSeek": false,
"trackCompletion": true,
"status": "In Progress",
"statusRowId": 4,
"timeSpent": null,
"lastWatchedTime": 0,
"isReady": true
}Request
GET
api/module/video/details
Query Parameters
registrationId string
ID of the course Registration for which this module is attached to.
moduleId string
ID of the video module.
Mark Complete Video Module
Updates the status of the video module to completed. Changes the completion percentage to 100% and marks completed the video module.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/module/video/markComplete?statusRowId=3&videoDuration=3" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/module/video/markComplete"
);
let params = {
"statusRowId": "3",
"videoDuration": "3",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Module Completed Successfully"
}Request
PUT
api/module/video/markComplete
Query Parameters
statusRowId string
ID of the ModuleStatus Row belongs to current video module.
videoDuration string
Duration of the video of current video module.
Retrieve Detailed Video module Info for Membership content
Retrieves details of video module for the same membership the current video module is attached to. Returns related fields value. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/module/video/content-details?moduleId=9" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/module/video/content-details"
);
let params = {
"moduleId": "9",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "My-video-lesson",
"slug": "my-video-lesson",
"content": "Brief Description",
"disableForwardSeek": false,
"trackCompletion": true,
"timeSpent": null,
"lastWatchedTime": 0,
"isReady": true
}Request
GET
api/module/video/content-details
Query Parameters
moduleId string
ID of the video module.
Webinars
A Webinar Module is used as course content. Helps to perform CRUD operation to and for Webinar modules.
Webinar Modules Tabular List
Returns all the webinar modules in a tabular list format in paginated mode. You can apply filter using search_param via associatedCourse(modules used in course) and moduleName.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/modules/webinar?page_size=50&page_number=5&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22associatedCourse%22%3A%22%22%2C%22moduleName%22%3A%22%22%7D" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/modules/webinar"
);
let params = {
"page_size": "50",
"page_number": "5",
"order_by": "{"colName":"created_at", "direction": "desc"}}",
"search_param": "{"associatedCourse":"","moduleName":""}",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"recordsTotal": 0,
"recordsFiltered": 0,
"records": []
}Request
GET
api/modules/webinar
Query Parameters
page_size string
The number of the items you want for a page.
page_number string
Current page number in pagination.
order_by string optional
For ordering items based on columns provided in JSON format.
search_param string optional
for searching items based on field names.
Create Webinar Module
To create a webinar module, you need to use this request. (See parameters) Created webinar modules can be used in the course as course content/lesson.
Returns : id of the webinar created and successfull message
Example request:
curl -X POST \
"https://demo.aomlms.com/api/modules/webinar" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"New-Webinar","content":"A brief description","service_provider":"vimeo_live_streaming","meeting_url":"https:\/\/vimeo.com\/WGYWVjhvjvkgrbwekjrblwiebrjbXjytfjg","start_time":"2020-08-17 00:00:00","end_time":"2020-08-17 01:00:00","zoom_meeting_id":"83170896876","zoom_host_pwd":"83170896787"}'
const url = new URL(
"https://demo.aomlms.com/api/modules/webinar"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "New-Webinar",
"content": "A brief description",
"service_provider": "vimeo_live_streaming",
"meeting_url": "https:\/\/vimeo.com\/WGYWVjhvjvkgrbwekjrblwiebrjbXjytfjg",
"start_time": "2020-08-17 00:00:00",
"end_time": "2020-08-17 01:00:00",
"zoom_meeting_id": "83170896876",
"zoom_host_pwd": "83170896787"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"id": 12,
"message": "Module saved successfully"
}Request
POST
api/modules/webinar
Body Parameters
name string
Name of the webinar module.
content string
Content for the webinar modules that students will see.
service_provider string
Service Provider of the webinar. Service provider options: vimeo_live_streaming, zoom, goto_webinar, goto_training or ms_team_meet.
meeting_url string optional
URL of the webinar where students can join..
start_time string
Start time of the webinar.
end_time string
End time of the webinar.
zoom_meeting_id string
Meeting Id for service provider zoom.
zoom_host_pwd string
Host password for service provider zoom.
Update Webinar Module
Update the details of specified webinar module. (See Response) Webinar modules can be used in the course as course content/lesson.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/modules/webinar/{id}" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}" \
-d '{"name":"New-Webinar","content":"An updated brief description","service_provider":"vimeo_live_streaming","meeting_url":"https:\/\/vimeo.com\/WGYWVjhvjvkgrbwekjrblwiebrjbXjytfjg","start_time":"2020-08-17 00:00:00","end_time":"2020-08-17 02:00:00","zoom_meeting_id":"83170896876","zoom_host_pwd":"83170896787"}'
const url = new URL(
"https://demo.aomlms.com/api/modules/webinar/{id}"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
let body = {
"name": "New-Webinar",
"content": "An updated brief description",
"service_provider": "vimeo_live_streaming",
"meeting_url": "https:\/\/vimeo.com\/WGYWVjhvjvkgrbwekjrblwiebrjbXjytfjg",
"start_time": "2020-08-17 00:00:00",
"end_time": "2020-08-17 02:00:00",
"zoom_meeting_id": "83170896876",
"zoom_host_pwd": "83170896787"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Module updated successfully"
}Request
PUT
api/modules/webinar/{id}
Body Parameters
name string
Name of the webinar module.
content string
Content for the webinar modules that students will see.
service_provider string
Service Provider of the webinar. Service provider options: vimeo_live_streaming, zoom, goto_webinar, goto_training or ms_team_meet.
meeting_url string optional
URL of the webinar where students can join..
start_time string
Start time of the webinar.
end_time string
End time of the webinar.
zoom_meeting_id string
Meeting Id for service provider zoom.
zoom_host_pwd string
Host password for service provider zoom.
Retrieve Webinar Modules
Retrieves the details of the specified webinar module. Helps in fetching webinar module using its ID. (See Parameters)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/modules/webinar/2" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/modules/webinar/2"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "New-Webinar",
"slug": "new-webinar",
"content": "A Brief Description",
"service_provider": "vimeo_live_streaming",
"meeting_url": "https:\/\/zzom.com\/WGYWVjhvjvkgrbwekjrblwiebrjbXjytfjg",
"start_time": "2020-08-17 00:00:00",
"end_time": "2020-08-17 01:00:00"
}Request
GET
api/modules/webinar/{id}
URL Parameters
id string
ID of the webinar module you want to fetch the details of.
Retrieve Detailed Webinar Module Info
Retrieves details of webinar module in depth as well as different modules details that are being used as course content for the same course the current webinar module is attached to. Returns related fields value. (See Response)
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/module/webinar/details?registrationId=1&moduleId=9" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/module/webinar/details"
);
let params = {
"registrationId": "1",
"moduleId": "9",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"name": "Essay on LMS",
"slug": "essay-on-lms",
"content": "A brief description",
"courseName": "course 1",
"courseSlug": "http:\/\/localhost:8000\/course\/course-1",
"totalPoints": 25,
"submissionType": "text",
"maxUploadSize": 5,
"min_time_spent": 0,
"allowedFileTypes": ".",
"otherModules": [
{
"module_id": 1,
"name": "test",
"slug": "test",
"type": "text",
"icon": "<i class=\"el-icon-tickets\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": 1,
"status": "Completed",
"started_on": "2020-08-03T10:02:33.000000Z",
"completed_on": "2020-08-03T10:02:41.000000Z",
"last_accessed_on": "8 hours ago",
"total_time_spent": {
"hours": 0,
"minutes": 0,
"seconds": 6,
"totalSeconds": 6
},
"completion_percentage": 100,
"no_of_times_accessed": 3
},
{
"module_id": 4,
"name": "assign",
"slug": "assign",
"type": "assignment",
"icon": "<i class=\"el-icon-edit-outline\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": true,
"status_row_id": -1,
"status": "Not Started",
"started_on": "",
"completed_on": "",
"last_accessed_on": "Never",
"total_time_spent": "",
"points_awarded": "",
"completion_percentage": 0,
"no_of_times_accessed": 0
},
{
"module_id": 7,
"name": "First-quiz",
"slug": "first-quiz",
"type": "quiz",
"icon": "<i class=\"el-icon-discover\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": -1,
"status": "Not Started",
"started_on": "",
"completed_on": "",
"last_accessed_on": "Never",
"total_time_spent": "",
"points_awarded": "",
"completion_percentage": 0,
"no_of_times_accessed": 0
},
{
"module_id": 9,
"name": "My-video-lesson",
"slug": "my-video-lesson",
"type": "video",
"icon": "<i class=\"el-icon-video-play\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": 4,
"status": "In Progress",
"started_on": "2020-08-10T20:04:14.000000Z",
"completed_on": null,
"last_accessed_on": "6 hours ago",
"total_time_spent": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"totalSeconds": null
},
"completion_percentage": 0,
"no_of_times_accessed": 1
},
{
"module_id": 10,
"name": "Essay on LMS",
"slug": "essay-on-lms",
"type": "assignment",
"icon": "<i class=\"el-icon-edit-outline\"><\/i>",
"is_locked": false,
"lock_reason": "",
"is_dripped": false,
"drip_message": "",
"is_current": false,
"status_row_id": 5,
"status": "Completed",
"started_on": "2020-08-11T02:47:32.000000Z",
"completed_on": "2020-08-11T02:47:32.000000Z",
"last_accessed_on": "46 seconds ago",
"total_time_spent": {
"hours": 0,
"minutes": 0,
"seconds": 0,
"totalSeconds": null
},
"completion_percentage": 100,
"no_of_times_accessed": 1
}
],
"launchCheck": {
"canbeLaunched": true,
"errTitle": "",
"errDesc": ""
},
"prevSlug": "my-video-lesson",
"nextSlug": "",
"status": "Completed",
"statusRowId": 5,
"timeSpent": null,
"prevSubmission": []
}Request
GET
api/module/webinar/details
Query Parameters
registrationId string
ID of the course Registration for which this module is attached to.
moduleId string
ID of the webinar module.
Webinar Module Launch Details
Retrieves the launch details for the webinar modules. Returned data includes webinar provider name(like vimeo, zoom, big blue button, etc), whether webinar is created successfully or not, etc This information helps while launching the webinar for students.
Example request:
curl -X GET \
-G "https://demo.aomlms.com/api/module/webinar/launch?moduleId=12" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/module/webinar/launch"
);
let params = {
"moduleId": "12",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"provider": "vimeo_live_streaming",
"webinarDetails": {
"is_success": "false",
"message": "Something went wrong. Please contact admin"
}
}Request
GET
api/module/webinar/launch
Query Parameters
moduleId string
ID of the current webinar module.
Mark Complete Webinar Module
Updates the status of the webinar module to completed. Changes the completion percentage to 100% and mark completed the webinar module.
Example request:
curl -X PUT \
"https://demo.aomlms.com/api/module/webinar/markComplete?statusRowId=4" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer {token}"const url = new URL(
"https://demo.aomlms.com/api/module/webinar/markComplete"
);
let params = {
"statusRowId": "4",
};
Object.keys(params)
.forEach(key => url.searchParams.append(key, params[key]));
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));Example response (200):
{
"message": "Module Completed Successfully"
}Request
PUT
api/module/webinar/markComplete
Query Parameters
statusRowId string
ID of the ModuleStatus Row belongs to current webinar module.