NAV
bash javascript

Info

Welcome to the generated API reference. Get Postman Collection

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

HTTP Request

POST api/announcement

Body Parameters

Parameter Type Status Description
heading string required Heading of the announcement.
content string required Content(Body) for the announcement that students will see.
expiry date optional Till what date, the announcement is active for users.
sending_rules string required Rule for sending announcement, based on this rule announcement will be sent to all or specific 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"
        }
    ]
}

HTTP Request

GET api/announcement/tabularlist

Query Parameters

Parameter Status Description
page_size required The number of the items you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param 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"
}

HTTP Request

PUT api/announcement/{id}

URL Parameters

Parameter Status Description
id optional int required ID of the announcement needs to be updated.

Body Parameters

Parameter Type Status Description
heading string required Heading of the announcement.
content string required Content(Body) for the announcement that students will see.
expiry date optional Till what date, the announcement is active for users.
sending_rules string required Rule for sending announcement, based on this rule announcement will be sent to all or specific 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"
}

HTTP Request

GET api/announcement/{id}

URL Parameters

Parameter Status Description
id required ID of the announcement you want to fetch the details of.

Delete Announcement

To delete an nnouncement, 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 "
}

HTTP Request

POST api/announcement/delete

Body Parameters

Parameter Type Status Description
delete_ids array required 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": []
}

HTTP Request

GET api/student/announcements

Query Parameters

Parameter Status Description
page_size required The number of the items you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param 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"
        }
    ]
}

HTTP Request

GET api/modules/assignment

Query Parameters

Parameter Status Description
page_size required The number of the items you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param 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"
}

HTTP Request

POST api/modules/assignment

Body Parameters

Parameter Type Status Description
name string required Name of the assignment module.
content string required Content for the assignment modules that students will see.
submission_type string required Type for the assignment module(file based or text based).
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/1" \
    -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/1"
);

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

HTTP Request

PUT api/modules/assignment/{id}

Body Parameters

Parameter Type Status Description
name string required Name of the assignment module.
content string required Content for the assignment modules that students will see.
submission_type string required Type for the assignment module(file based or text based).
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": [
        ""
    ]
}

HTTP Request

GET api/modules/assignment/{id}

URL Parameters

Parameter Status Description
id required 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": []
}

HTTP Request

GET api/module/assignment/details

Query Parameters

Parameter Status Description
registrationId required ID of the course Registration for which this module is attached to.
moduleId required 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": ""
        }
    ]
}

HTTP Request

GET api/module/assignment/submissions

Query Parameters

Parameter Status Description
statusRowId required 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"
}

HTTP Request

POST api/module/assignment/submit

Body Parameters

Parameter Type Status Description
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"
}

HTTP Request

POST api/module/assignment/upload

Body Parameters

Parameter Type Status Description
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 sucessfully"
}

HTTP Request

POST api/module/assignment/evaluate

Body Parameters

Parameter Type Status Description
statusRowId required optional ID of the Module status of the current assignment.
evaluation required optional Evaluation data by the Instructor(Completed or not).

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

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

HTTP Request

GET api/categories/course/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 course 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"
    }
]

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

HTTP Request

GET api/coursecategory/tabularlist

Query Parameters

Parameter Status Description
page_size required The number of the items you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param 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"
        }
    ]
}

HTTP Request

GET api/questioncategory/tabularlist

Query Parameters

Parameter Status Description
page_size required The number of the items you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param 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","type":"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",
    "type": "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"
}

HTTP Request

POST api/category/create

Body Parameters

Parameter Type Status Description
category_name string required Name of the course category.
type string required Type for the category that is being created.

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

HTTP Request

PUT api/category/{id}

URL Parameters

Parameter Status Description
id required ID of the category.

Body Parameters

Parameter Type Status Description
category_name string required 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
}

HTTP Request

GET api/category/{id}

URL Parameters

Parameter Status Description
id required 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 "
}

HTTP Request

POST api/category/delete

Body Parameters

Parameter Type Status Description
delete_ids array required 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"
    }
]

HTTP 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=8&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": "8",
    "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"
        }
    ]
}

HTTP Request

GET api/certificate_templates/tabularlist

Query Parameters

Parameter Status Description
page_size required The number of the items you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param 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"
}

HTTP Request

POST api/certificate_templates/quickEdit

Body Parameters

Parameter Type Status Description
template_ids array required 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": "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"
    }
]

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

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

HTTP Request

POST api/certificate_template

Body Parameters

Parameter Type Status Description
name string required Name of the certificate template.
bg_url string optional Background for the certificate template.
height integer required Height size for the certificate template.
width integer required Width size for the certificate template.
fields array optional All the certificate fields user have added to appear in certficate 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
        }
    ]
}

HTTP Request

GET api/certificate_template/{id}

URL Parameters

Parameter Status Description
id required 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):

null

HTTP Request

GET api/certificate_template/preview/{id}

URL Parameters

Parameter Status Description
id required 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"
}

HTTP Request

PUT api/certificate_template/{id}

URL Parameters

Parameter Status Description
id optional int required ID of the certificate template

Body Parameters

Parameter Type Status Description
name string required Name of the certificate template.
bg_url string optional Background for the certificate template.
height integer required Height size for the certificate template.
width integer required Width size for the certificate template.
fields array optional All the certificate fields user have added to appear in certficate 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."
}

HTTP Request

POST api/certificate_template/delete

Body Parameters

Parameter Type Status Description
delete_ids array required 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"
        }
    ]
}

HTTP Request

GET api/courses/tabularlist

Query Parameters

Parameter Status Description
page_size required The number of the item you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param 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
    }
]

HTTP Request

GET api/courses/dropdownlist

Query Parameters

Parameter Status Description
group_id required 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"
        }
    ]
}

HTTP Request

GET api/course/enrolled-students

Query Parameters

Parameter Status Description
course_id required ID of the course.
group_id required ID of the group.
page_size required number of the results you want in each page.
page_number required Current Page number.
order_by optional returns details in some order.
search_param optional Search parameters related to course.

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

HTTP Request

GET api/course/submissions

Query Parameters

Parameter Status Description
course_id required ID of the course.
page_size required The number of the submissions you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param optional for searching items based on Course category ids, course name and role names.

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
}

HTTP Request

GET api/course/reports/overview

Query Parameters

Parameter Status Description
group_id 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=nulla&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": "nulla",
    "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"
        }
    ]
}

HTTP Request

GET api/course/reports/course-detailed

Query Parameters

Parameter Status Description
course_id required ID of the course.
group_id optional ID of the group. Example:
page_size required The number of the submissions you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param 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": []
}

HTTP Request

GET api/course/{id}

URL Parameters

Parameter Status Description
id required 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","credits":70,"minPassingPercentage":75,"gradingRule":"no_grading","durationRule":"unlimited","status":"publish","certificateTemplates":"[1]","associatedProduct":"[1]","hasAssociatedProduct":true,"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":"[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",
    "credits": 70,
    "minPassingPercentage": 75,
    "gradingRule": "no_grading",
    "durationRule": "unlimited",
    "status": "publish",
    "certificateTemplates": "[1]",
    "associatedProduct": "[1]",
    "hasAssociatedProduct": true,
    "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": "[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"
}

HTTP Request

POST api/course

URL Parameters

Parameter Status Description
id required ID of the course.

Body Parameters

Parameter Type Status Description
name string required Name of the course.
instructions string optional Instruction for the course.
slug string required Slug for the course.
featuredImageUrl string optional Image for the course.
credits integer optional Credit after course completion, used in certificates.
minPassingPercentage number optional Minimum passing percenatage for students.
gradingRule string required Grading criteria for the course.
durationRule string required Access duration for the course.
status string required Course is in Draft or Publish mode.
certificateTemplates array optional Certificates attached to this course.
associatedProduct array optional Associated product for this course.
hasAssociatedProduct boolean optional Does course have associated product.
modules array optional All modules related to this course.
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","credits":70,"minPassingPercentage":75,"gradingRule":"no_grading","durationRule":"unlimited","status":"publish","certificateTemplates":"[1]","associatedProduct":"[1]","hasAssociatedProduct":true,"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":"[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",
    "credits": 70,
    "minPassingPercentage": 75,
    "gradingRule": "no_grading",
    "durationRule": "unlimited",
    "status": "publish",
    "certificateTemplates": "[1]",
    "associatedProduct": "[1]",
    "hasAssociatedProduct": true,
    "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": "[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"
}

HTTP Request

PUT api/course/{id}

URL Parameters

Parameter Status Description
id required ID of the course.

Body Parameters

Parameter Type Status Description
name string required Name of the course.
slug string required Slug for the course.
featuredImageUrl string optional Image for the course.
credits integer optional Credit after course completion, used in certificates.
minPassingPercentage number optional Minimum passing percenatage for students.
gradingRule string required Grading criteria for the course.
durationRule string required Access duration for the course.
status string required Course is in Draft or Publish mode.
certificateTemplates array optional Certificates attached to this course.
associatedProduct array optional Associated product for this course.
hasAssociatedProduct boolean optional Does course have associated product.
modules array optional All modules related to this course.
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"

HTTP Request

PUT api/course/update-slug/{id}

URL Parameters

Parameter Status Description
id required The ID of the course.

Body Parameters

Parameter Type Status Description
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=eum" \
    -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": "eum",
};
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"
    }
]

HTTP Request

POST api/course/lookup

URL Parameters

Parameter Status Description
id required ID of the course.

Query Parameters

Parameter Status Description
group_id optional ID of the group.
search_term 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):

null

HTTP Request

POST api/course/delete

Body Parameters

Parameter Type Status Description
delete_ids array required 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"
}

HTTP Request

POST api/course/quickEdit

Body Parameters

Parameter Type Status Description
course_ids array required 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):

[
    {
        "id": 3,
        "full_name": "Demo Student",
        "email": "[email protected]"
    },
    {
        "id": 4,
        "full_name": "John Doe",
        "email": "[email protected]"
    }
]

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

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

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

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

HTTP Request

GET api/course-activities

Query Parameters

Parameter Status Description
course_id required ID of the course.
page_size required The number of the submissions you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param optional for searching items based on Course category ids, course name and role names.
context required Context for the request.

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):

null

HTTP Request

GET api/course/name/{id}

URL Parameters

Parameter Status Description
id required 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"
}

HTTP Request

POST api/course/enroll/{id}

URL Parameters

Parameter Status Description
id required ID of the course.

Body Parameters

Parameter Type Status Description
studentIds array required 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"
}

HTTP Request

POST api/course/remove/{id}

URL Parameters

Parameter Status Description
id required ID of the course.

Body Parameters

Parameter Type Status Description
enrollmentIds array required 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"
}

HTTP Request

POST api/course/reset/{id}

URL Parameters

Parameter Status Description
id required ID of the course.

Body Parameters

Parameter Type Status Description
enrollmentIds array required 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"
}

HTTP Request

PUT api/course/revoke/{id}

URL Parameters

Parameter Status Description
id required ID of the course.

Body Parameters

Parameter Type Status Description
enrollmentIds array required 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"
}

HTTP Request

PUT api/course/grant/{id}

URL Parameters

Parameter Status Description
id required ID of the course.

Body Parameters

Parameter Type Status Description
enrollmentIds array required 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) "
}

HTTP Request

PUT api/course/setExpiry/{id}

URL Parameters

Parameter Status Description
id required ID of the course.

Body Parameters

Parameter Type Status Description
enrollmentIds array required 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)"
}

HTTP Request

POST api/course/assignCertificate/{id}

URL Parameters

Parameter Status Description
id required ID of the course.

Body Parameters

Parameter Type Status Description
enrollmentIds array required 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"
    }
]

HTTP 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
}

HTTP Request

GET api/progress/course/{id}

URL Parameters

Parameter Status Description
id required Course registration ID for the student of the course you want to see progress.

Query Parameters

Parameter Status Description
userId required 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=voluptatem" \
    -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": "voluptatem",
};
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]"
    }
]

HTTP Request

GET api/enrolled/course/{id}

URL Parameters

Parameter Status Description
id required ID of the course.

Query Parameters

Parameter Status Description
group_id optional ID of the group.
search_term 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"
}

HTTP Request

POST api/course/clone

Body Parameters

Parameter Type Status Description
course_id integer required ID of the course to be cloned.
course_name string required Name of the course about to be cloned.
isDeepCopy boolean required If true, content will be affected in real course if changes made in cloned course.

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

HTTP Request

GET api/courses/launch

Query Parameters

Parameter Status Description
registrationId required 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"
        }
    ]
}

HTTP Request

GET api/coupons/tabularlist

Query Parameters

Parameter Status Description
page_size required The number of the items you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param 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=qui" \
    -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": "qui",
};
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"
    }
]

HTTP Request

GET api/coupons/lookup

Query Parameters

Parameter Status Description
search_term required 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"
    }
]

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

HTTP Request

POST api/coupon/create

Body Parameters

Parameter Type Status Description
code string required code for the coupon.
notes string optional Notes for the coupon.
value numeric required Value of the coupon(discount price or percentage).
type string required Types of the coupon(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": [],
    "categories": []
}

HTTP Request

GET api/coupon/{id}

URL Parameters

Parameter Status Description
id required 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"
}

HTTP Request

PUT api/coupon/{id}

URL Parameters

Parameter Status Description
id optional int required ID of the coupon.

Body Parameters

Parameter Type Status Description
code string required code for the coupon.
notes string optional Notes for the coupon.
value numeric required Value of the coupon(discount price or percentage).
type string required Types of the coupon(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"
}

HTTP Request

POST api/coupon/delete

Body Parameters

Parameter Type Status Description
delete_ids array required 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=8&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": "8",
    "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"
        }
    ]
}

HTTP Request

GET api/modules/discussion

Query Parameters

Parameter Status Description
page_size required The number of the items you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param 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"
}

HTTP Request

POST api/modules/discussion

Body Parameters

Parameter Type Status Description
name string required Name of the discussion module.
content string required Content for the discussion modules that students will see.
should_be_evaluated boolean required 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 disuccion(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/1" \
    -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/1"
);

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

HTTP Request

PUT api/modules/discussion/{id}

Body Parameters

Parameter Type Status Description
name string required Name of the discussion module.
content string required Content for the discussion modules that students will see.
should_be_evaluated boolean required 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 disuccion(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
}

HTTP Request

GET api/modules/discussion/{id}

URL Parameters

Parameter Status Description
id required 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
}

HTTP Request

GET api/module/discussion/details

Query Parameters

Parameter Status Description
registrationId required ID of the course Registration for which this module is attached to.
moduleId required 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=7&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": "7",
    "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": []
        }
    ]
}

HTTP Request

GET api/module/discussion/loadComments

Query Parameters

Parameter Status Description
page_size required The number of the items you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param optional for searching items based on field names.

Post a 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":7}'
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": 7
}

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

HTTP Request

POST api/module/discussion/postComment

Body Parameters

Parameter Type Status Description
statusRowId integer required ID of the ModuleStatus Row belongs to current discussion module.
currentUserId integer required ID of the user who commented.
comment string required 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": []
}

HTTP Request

GET api/module/discussion/submissions

Query Parameters

Parameter Status Description
statusRowId required 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 sucessfully"
}

HTTP Request

POST api/module/discussion/evaluate

Body Parameters

Parameter Type Status Description
statusRowId required optional ID of the Module status of the current discussion.
evaluation required optional Evaluation data by the Instructor(Completed or not).

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&ccedil;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&eacute;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&atilde;o Tom&eacute; and Pr&iacute;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"
}

HTTP 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)"
}

HTTP Request

GET api/states/lookup

Query Parameters

Parameter Status Description
countryCode required 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": "&#x62f;.&#x625;"
    },
    "AFN": {
        "display_name": "Afghan afghani",
        "symbol": "&#x60b;"
    },
    "ALL": {
        "display_name": "Albanian lek",
        "symbol": "L"
    },
    "AMD": {
        "display_name": "Armenian dram",
        "symbol": "AMD"
    },
    "ANG": {
        "display_name": "Netherlands Antillean guilder",
        "symbol": "&fnof;"
    },
    "AOA": {
        "display_name": "Angolan kwanza",
        "symbol": "Kz"
    },
    "ARS": {
        "display_name": "Argentine peso",
        "symbol": "&#36;"
    },
    "AUD": {
        "display_name": "Australian dollar",
        "symbol": "&#36;"
    },
    "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": "&#36;"
    },
    "BDT": {
        "display_name": "Bangladeshi taka",
        "symbol": "&#2547;&nbsp;"
    },
    "BGN": {
        "display_name": "Bulgarian lev",
        "symbol": "&#1083;&#1074;."
    },
    "BHD": {
        "display_name": "Bahraini dinar",
        "symbol": ".&#x62f;.&#x628;"
    },
    "BIF": {
        "display_name": "Burundian franc",
        "symbol": "Fr"
    },
    "BMD": {
        "display_name": "Bermudian dollar",
        "symbol": "&#36;"
    },
    "BND": {
        "display_name": "Brunei dollar",
        "symbol": "&#36;"
    },
    "BOB": {
        "display_name": "Bolivian boliviano",
        "symbol": "Bs."
    },
    "BRL": {
        "display_name": "Brazilian real",
        "symbol": "&#82;&#36;"
    },
    "BSD": {
        "display_name": "Bahamian dollar",
        "symbol": "&#36;"
    },
    "BTC": {
        "display_name": "Bitcoin",
        "symbol": "&#3647;"
    },
    "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": "&#36;"
    },
    "CAD": {
        "display_name": "Canadian dollar",
        "symbol": "&#36;"
    },
    "CDF": {
        "display_name": "Congolese franc",
        "symbol": "Fr"
    },
    "CHF": {
        "display_name": "Swiss franc",
        "symbol": "&#67;&#72;&#70;"
    },
    "CLP": {
        "display_name": "Chilean peso",
        "symbol": "&#36;"
    },
    "CNY": {
        "display_name": "Chinese yuan",
        "symbol": "&yen;"
    },
    "COP": {
        "display_name": "Colombian peso",
        "symbol": "&#36;"
    },
    "CRC": {
        "display_name": "Costa Rican col&oacute;n",
        "symbol": "&#x20a1;"
    },
    "CUC": {
        "display_name": "Cuban convertible peso",
        "symbol": "&#36;"
    },
    "CUP": {
        "display_name": "Cuban peso",
        "symbol": "&#36;"
    },
    "CVE": {
        "display_name": "Cape Verdean escudo",
        "symbol": "&#36;"
    },
    "CZK": {
        "display_name": "Czech koruna",
        "symbol": "&#75;&#269;"
    },
    "DJF": {
        "display_name": "Djiboutian franc",
        "symbol": "Fr"
    },
    "DKK": {
        "display_name": "Danish krone",
        "symbol": "DKK"
    },
    "DOP": {
        "display_name": "Dominican peso",
        "symbol": "RD&#36;"
    },
    "DZD": {
        "display_name": "Algerian dinar",
        "symbol": "&#x62f;.&#x62c;"
    },
    "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": "&euro;"
    },
    "FJD": {
        "display_name": "Fijian dollar",
        "symbol": "&#36;"
    },
    "FKP": {
        "display_name": "Falkland Islands pound",
        "symbol": "&pound;"
    },
    "GBP": {
        "display_name": "Pound sterling",
        "symbol": "&pound;"
    },
    "GEL": {
        "display_name": "Georgian lari",
        "symbol": "&#x20be;"
    },
    "GGP": {
        "display_name": "Guernsey pound",
        "symbol": "&pound;"
    },
    "GHS": {
        "display_name": "Ghana cedi",
        "symbol": "&#x20b5;"
    },
    "GIP": {
        "display_name": "Gibraltar pound",
        "symbol": "&pound;"
    },
    "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": "&#36;"
    },
    "HKD": {
        "display_name": "Hong Kong dollar",
        "symbol": "&#36;"
    },
    "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": "&#70;&#116;"
    },
    "IDR": {
        "display_name": "Indonesian rupiah",
        "symbol": "Rp"
    },
    "ILS": {
        "display_name": "Israeli new shekel",
        "symbol": "&#8362;"
    },
    "IMP": {
        "display_name": "Manx pound",
        "symbol": "&pound;"
    },
    "INR": {
        "display_name": "Indian rupee",
        "symbol": "&#8377;"
    },
    "IQD": {
        "display_name": "Iraqi dinar",
        "symbol": "&#x639;.&#x62f;"
    },
    "IRR": {
        "display_name": "Iranian rial",
        "symbol": "&#xfdfc;"
    },
    "IRT": {
        "display_name": "Iranian toman",
        "symbol": "&#x062A;&#x0648;&#x0645;&#x0627;&#x0646;"
    },
    "ISK": {
        "display_name": "Icelandic kr&oacute;na",
        "symbol": "kr."
    },
    "JEP": {
        "display_name": "Jersey pound",
        "symbol": "&pound;"
    },
    "JMD": {
        "display_name": "Jamaican dollar",
        "symbol": "&#36;"
    },
    "JOD": {
        "display_name": "Jordanian dinar",
        "symbol": "&#x62f;.&#x627;"
    },
    "JPY": {
        "display_name": "Japanese yen",
        "symbol": "&yen;"
    },
    "KES": {
        "display_name": "Kenyan shilling",
        "symbol": "KSh"
    },
    "KGS": {
        "display_name": "Kyrgyzstani som",
        "symbol": "&#x441;&#x43e;&#x43c;"
    },
    "KHR": {
        "display_name": "Cambodian riel",
        "symbol": "&#x17db;"
    },
    "KMF": {
        "display_name": "Comorian franc",
        "symbol": "Fr"
    },
    "KPW": {
        "display_name": "North Korean won",
        "symbol": "&#x20a9;"
    },
    "KRW": {
        "display_name": "South Korean won",
        "symbol": "&#8361;"
    },
    "KWD": {
        "display_name": "Kuwaiti dinar",
        "symbol": "&#x62f;.&#x643;"
    },
    "KYD": {
        "display_name": "Cayman Islands dollar",
        "symbol": "&#36;"
    },
    "KZT": {
        "display_name": "Kazakhstani tenge",
        "symbol": "KZT"
    },
    "LAK": {
        "display_name": "Lao kip",
        "symbol": "&#8365;"
    },
    "LBP": {
        "display_name": "Lebanese pound",
        "symbol": "&#x644;.&#x644;"
    },
    "LKR": {
        "display_name": "Sri Lankan rupee",
        "symbol": "&#xdbb;&#xdd4;"
    },
    "LRD": {
        "display_name": "Liberian dollar",
        "symbol": "&#36;"
    },
    "LSL": {
        "display_name": "Lesotho loti",
        "symbol": "L"
    },
    "LYD": {
        "display_name": "Libyan dinar",
        "symbol": "&#x644;.&#x62f;"
    },
    "MAD": {
        "display_name": "Moroccan dirham",
        "symbol": "&#x62f;.&#x645;."
    },
    "MDL": {
        "display_name": "Moldovan leu",
        "symbol": "MDL"
    },
    "MGA": {
        "display_name": "Malagasy ariary",
        "symbol": "Ar"
    },
    "MKD": {
        "display_name": "Macedonian denar",
        "symbol": "&#x434;&#x435;&#x43d;"
    },
    "MMK": {
        "display_name": "Burmese kyat",
        "symbol": "Ks"
    },
    "MNT": {
        "display_name": "Mongolian t&ouml;gr&ouml;g",
        "symbol": "&#x20ae;"
    },
    "MOP": {
        "display_name": "Macanese pataca",
        "symbol": "P"
    },
    "MRU": {
        "display_name": "Mauritanian ouguiya",
        "symbol": "UM"
    },
    "MUR": {
        "display_name": "Mauritian rupee",
        "symbol": "&#x20a8;"
    },
    "MVR": {
        "display_name": "Maldivian rufiyaa",
        "symbol": ".&#x783;"
    },
    "MWK": {
        "display_name": "Malawian kwacha",
        "symbol": "MK"
    },
    "MXN": {
        "display_name": "Mexican peso",
        "symbol": "&#36;"
    },
    "MYR": {
        "display_name": "Malaysian ringgit",
        "symbol": "&#82;&#77;"
    },
    "MZN": {
        "display_name": "Mozambican metical",
        "symbol": "MT"
    },
    "NAD": {
        "display_name": "Namibian dollar",
        "symbol": "N&#36;"
    },
    "NGN": {
        "display_name": "Nigerian naira",
        "symbol": "&#8358;"
    },
    "NIO": {
        "display_name": "Nicaraguan c&oacute;rdoba",
        "symbol": "C&#36;"
    },
    "NOK": {
        "display_name": "Norwegian krone",
        "symbol": "&#107;&#114;"
    },
    "NPR": {
        "display_name": "Nepalese rupee",
        "symbol": "&#8360;"
    },
    "NZD": {
        "display_name": "New Zealand dollar",
        "symbol": "&#36;"
    },
    "OMR": {
        "display_name": "Omani rial",
        "symbol": "&#x631;.&#x639;."
    },
    "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": "&#8369;"
    },
    "PKR": {
        "display_name": "Pakistani rupee",
        "symbol": "&#8360;"
    },
    "PLN": {
        "display_name": "Polish z&#x142;oty",
        "symbol": "&#122;&#322;"
    },
    "PRB": {
        "display_name": "Transnistrian ruble",
        "symbol": "&#x440;."
    },
    "PYG": {
        "display_name": "Paraguayan guaran&iacute;",
        "symbol": "&#8370;"
    },
    "QAR": {
        "display_name": "Qatari riyal",
        "symbol": "&#x631;.&#x642;"
    },
    "RON": {
        "display_name": "Romanian leu",
        "symbol": "lei"
    },
    "RSD": {
        "display_name": "Serbian dinar",
        "symbol": "&#x434;&#x438;&#x43d;."
    },
    "RUB": {
        "display_name": "Russian ruble",
        "symbol": "&#8381;"
    },
    "RWF": {
        "display_name": "Rwandan franc",
        "symbol": "Fr"
    },
    "SAR": {
        "display_name": "Saudi riyal",
        "symbol": "&#x631;.&#x633;"
    },
    "SBD": {
        "display_name": "Solomon Islands dollar",
        "symbol": "&#36;"
    },
    "SCR": {
        "display_name": "Seychellois rupee",
        "symbol": "&#x20a8;"
    },
    "SDG": {
        "display_name": "Sudanese pound",
        "symbol": "&#x62c;.&#x633;."
    },
    "SEK": {
        "display_name": "Swedish krona",
        "symbol": "&#107;&#114;"
    },
    "SGD": {
        "display_name": "Singapore dollar",
        "symbol": "&#36;"
    },
    "SHP": {
        "display_name": "Saint Helena pound",
        "symbol": "&pound;"
    },
    "SLL": {
        "display_name": "Sierra Leonean leone",
        "symbol": "Le"
    },
    "SOS": {
        "display_name": "Somali shilling",
        "symbol": "Sh"
    },
    "SRD": {
        "display_name": "Surinamese dollar",
        "symbol": "&#36;"
    },
    "SSP": {
        "display_name": "South Sudanese pound",
        "symbol": "&pound;"
    },
    "STN": {
        "display_name": "S&atilde;o Tom&eacute; and Pr&iacute;ncipe dobra",
        "symbol": "Db"
    },
    "SYP": {
        "display_name": "Syrian pound",
        "symbol": "&#x644;.&#x633;"
    },
    "SZL": {
        "display_name": "Swazi lilangeni",
        "symbol": "L"
    },
    "THB": {
        "display_name": "Thai baht",
        "symbol": "&#3647;"
    },
    "TJS": {
        "display_name": "Tajikistani somoni",
        "symbol": "&#x405;&#x41c;"
    },
    "TMT": {
        "display_name": "Turkmenistan manat",
        "symbol": "m"
    },
    "TND": {
        "display_name": "Tunisian dinar",
        "symbol": "&#x62f;.&#x62a;"
    },
    "TOP": {
        "display_name": "Tongan pa&#x2bb;anga",
        "symbol": "T&#36;"
    },
    "TRY": {
        "display_name": "Turkish lira",
        "symbol": "&#8378;"
    },
    "TTD": {
        "display_name": "Trinidad and Tobago dollar",
        "symbol": "&#36;"
    },
    "TWD": {
        "display_name": "New Taiwan dollar",
        "symbol": "&#78;&#84;&#36;"
    },
    "TZS": {
        "display_name": "Tanzanian shilling",
        "symbol": "Sh"
    },
    "UAH": {
        "display_name": "Ukrainian hryvnia",
        "symbol": "&#8372;"
    },
    "UGX": {
        "display_name": "Ugandan shilling",
        "symbol": "UGX"
    },
    "USD": {
        "display_name": "United States (US) dollar",
        "symbol": "&#36;"
    },
    "UYU": {
        "display_name": "Uruguayan peso",
        "symbol": "&#36;"
    },
    "UZS": {
        "display_name": "Uzbekistani som",
        "symbol": "UZS"
    },
    "VEF": {
        "display_name": "Venezuelan bol&iacute;var",
        "symbol": "Bs F"
    },
    "VES": {
        "display_name": "Bol&iacute;var soberano",
        "symbol": "Bs.S"
    },
    "VND": {
        "display_name": "Vietnamese &#x111;&#x1ed3;ng",
        "symbol": "&#8363;"
    },
    "VUV": {
        "display_name": "Vanuatu vatu",
        "symbol": "Vt"
    },
    "WST": {
        "display_name": "Samoan t&#x101;l&#x101;",
        "symbol": "T"
    },
    "XAF": {
        "display_name": "Central African CFA franc",
        "symbol": "CFA"
    },
    "XCD": {
        "display_name": "East Caribbean dollar",
        "symbol": "&#36;"
    },
    "XOF": {
        "display_name": "West African CFA franc",
        "symbol": "CFA"
    },
    "XPF": {
        "display_name": "CFP franc",
        "symbol": "Fr"
    },
    "YER": {
        "display_name": "Yemeni rial",
        "symbol": "&#xfdfc;"
    },
    "ZAR": {
        "display_name": "South African rand",
        "symbol": "&#82;"
    },
    "ZMW": {
        "display_name": "Zambian kwacha",
        "symbol": "ZK"
    }
}

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

HTTP 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":"reiciendis","city":"New Jersey","state":"eius","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": "reiciendis",
    "city": "New Jersey",
    "state": "eius",
    "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"
}

HTTP Request

PUT api/settings/ecommerce/general

Body Parameters

Parameter Type Status Description
addressLine1 string required Address line1 of user.
addressLine2 string optional Address line2 of user. Example:
city string required City of the user.
state string required State of the user. Example:
country string required Country of the user.
currency string required Currency of the user's country.
enableCoupons string required If yes, coupons gets enabled for users.
enableTaxes string required If yes, taxes gets enabled for users.
zipcode string required 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": "&#36;"
}

HTTP Request

GET api/get-shop-base-currency

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": "&#36;",
    "records": [
        {
            "id": 1,
            "status": "PENDING_PAYMENT",
            "total": "3001.00",
            "isTestOrder": false,
            "customer": "Demo Student",
            "created_at": "Aug 25, 2020 12:00 AM"
        }
    ]
}

HTTP Request

GET api/orders/tabularlist

Query Parameters

Parameter Status Description
page_size required The number of the items you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param 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):

null

HTTP Request

GET api/order/download

Query Parameters

Parameter Status Description
orderId required 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):

null

HTTP Request

GET api/order/export

Query Parameters

Parameter Status Description
filters required 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": "&#36;"
    },
    "sumIncome": 0,
    "sumTotalOrder": 0
}

HTTP Request

GET api/order/reports/yearsales

Query Parameters

Parameter Status Description
year required 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": "&#36;"
    },
    "sumIncome": 0,
    "sumTotalOrder": 0
}

HTTP Request

GET api/order/reports/monthlysales

Query Parameters

Parameter Status Description
selectedMonth required 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?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/productbreakdown"
);

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": [
        "Product-1"
    ],
    "totalIncome": [
        0
    ],
    "totalOrders": [
        0
    ],
    "currency": {
        "display_name": "United States (US) dollar",
        "symbol": "&#36;"
    },
    "sumIncome": 0,
    "sumTotalOrder": 0
}

HTTP Request

GET api/order/reports/productbreakdown

Query Parameters

Parameter Status Description
selectedMonth required Month for which you need sales information(month_number-year).

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

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

HTTP Request

POST api/order/delete

Body Parameters

Parameter Type Status Description
delete_ids array required 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":"[{product_id: 1, product_title: \"Product-1\", price: 3001, quantity: 1, total: 3001}]","orderNotes":"[{data: \"note-1\", type: \"PRIVATE\", created_on: \"2020-08-11T17:34:02.125Z\"}]","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": "[{product_id: 1, product_title: \"Product-1\", price: 3001, quantity: 1, total: 3001}]",
    "orderNotes": "[{data: \"note-1\", type: \"PRIVATE\", created_on: \"2020-08-11T17:34:02.125Z\"}]",
    "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"
}

HTTP Request

POST api/order/create

Body Parameters

Parameter Type Status Description
orderDate date required Ordering date.
status string required Different status for the orders like pending, completed, failed, etc.
customerId integer required Ordered by this user Id.
billingAddressId integer optional Billing address Id.
orderItems array required 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": "&#36;"
    },
    "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"
        }
    ]
}

HTTP Request

GET api/order/{id}

URL Parameters

Parameter Status Description
id required 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":"[{product_id: 1, product_title: \"Product-1\", price: 3001, quantity: 1, total: 3001}]","orderNotes":"[{data: \"note-1\", type: \"PRIVATE\", created_on: \"2020-08-11T17:34:02.125Z\"}]","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": "[{product_id: 1, product_title: \"Product-1\", price: 3001, quantity: 1, total: 3001}]",
    "orderNotes": "[{data: \"note-1\", type: \"PRIVATE\", created_on: \"2020-08-11T17:34:02.125Z\"}]",
    "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"
}

HTTP Request

PUT api/order/{id}

URL Parameters

Parameter Status Description
id optional int required ID of the order.

Body Parameters

Parameter Type Status Description
orderDate date required Ordering date.
status string required Different status for the orders like pending, completed, failed, etc.
customerId integer required Ordered by this user Id.
billingAddressId integer optional Billing address Id.
orderItems array required 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"
    }
]

HTTP Request

POST api/order-note/create

Body Parameters

Parameter Type Status Description
data string required Actual content of the note.
orderId integer required ID of the order in which this note is being created.
type string required Type of the note(private or public).

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

HTTP Request

PUT api/order-note/delete/{id}

URL Parameters

Parameter Status Description
id optional int required 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
        }
    ]
}

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

HTTP Request

PUT api/paymentmethod/updateStatus

Body Parameters

Parameter Type Status Description
id integer required ID of the Payement Gateway.
status boolean required 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":"blanditiis","liveSecretKey":"voluptatem"}'
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": "blanditiis",
    "liveSecretKey": "voluptatem"
}

fetch(url, {
    method: "PUT",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "message": "Settings Updated"
}

HTTP Request

PUT api/settings/stripe

Body Parameters

Parameter Type Status Description
gatewayEnabled boolean required 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": ""
}

HTTP 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":"non","clientId":"facere"}'
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": "non",
    "clientId": "facere"
}

fetch(url, {
    method: "PUT",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "message": "Settings Updated"
}

HTTP Request

PUT api/settings/authorizenet

Body Parameters

Parameter Type Status Description
gatewayEnabled boolean required 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 mainting 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": ""
}

HTTP Request

GET api/settings/authorizenet

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

HTTP Request

GET api/products/catalog

Query Parameters

Parameter Status Description
page_size required The number of the items you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param optional for searching items based on field names.

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

HTTP Request

GET api/product/{id}

URL Parameters

Parameter Status Description
id required ID of the product you want to fetch the details of.

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

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

HTTP 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"

HTTP Request

PUT api/products/update-slug/{id}

URL Parameters

Parameter Status Description
id required The ID of the product.

Body Parameters

Parameter Type Status Description
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"
    }
]

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

HTTP Request

GET api/products/tabularlist

Query Parameters

Parameter Status Description
page_size required The number of the items you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param optional for 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=velit" \
    -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": "velit",
};
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"
    }
]

HTTP Request

GET api/products/lookup

Query Parameters

Parameter Status Description
search_term required 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":"2020-10-29 0:00:00","taxIncluded":false,"taxBasedOn":"CUSTOMER-BILLING-ADDR","categories":"[]","courses":"[{value: 1, label: \"course 1\"}]","courseCategories":"[]","seo_title":"awesome-product","seo_description":"includes many good courses"}'
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": "2020-10-29 0:00:00",
    "taxIncluded": false,
    "taxBasedOn": "CUSTOMER-BILLING-ADDR",
    "categories": "[]",
    "courses": "[{value: 1, label: \"course 1\"}]",
    "courseCategories": "[]",
    "seo_title": "awesome-product",
    "seo_description": "includes many good courses"
}

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

HTTP Request

POST api/product/create

Body Parameters

Parameter Type Status Description
title string required Name of the product.
description string required Description for the product.
featuredImageUrl string optional Featured Image for the product.
regular_price numeric required Regular price for the product.
type string required Type of the product(SIMPLE,DOWNLOADABLE).
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 required Status for the product(in-stock, out-of-stock or coming-soon).
expiry date optional On this date this product will get expired.
taxIncluded boolean required Whether tax included or not?.
taxBasedOn string optional Based on the area(required if taxIncluded is true) like CUSTOMER-BILLING-ADDR,CUSTOMER-SHIPPING-ADDR,SHOP-BASE-ADDRESS.
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.

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","taxIncluded":false,"taxBasedOn":"CUSTOMER-BILLING-ADDR","categories":"[]","courses":"[{value: 1, label: \"course 1\"}]","courseCategories":"[]","seo_title":"awesome-product","seo_description":"includes many good courses"}'
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",
    "taxIncluded": false,
    "taxBasedOn": "CUSTOMER-BILLING-ADDR",
    "categories": "[]",
    "courses": "[{value: 1, label: \"course 1\"}]",
    "courseCategories": "[]",
    "seo_title": "awesome-product",
    "seo_description": "includes many good courses"
}

fetch(url, {
    method: "PUT",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "message": "Product updated successfully"
}

HTTP Request

PUT api/product/{id}

URL Parameters

Parameter Status Description
id optional int required ID of the product.

Body Parameters

Parameter Type Status Description
title string required Name of the product.
description string required Description for the product.
featuredImageUrl string optional Featured Image for the product.
regular_price numeric required Regular price for the product.
type string required Type of the product(SIMPLE,DOWNLOADABLE).
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 required Status for the product(in-stock, out-of-stock or coming-soon).
expiry date optional On this date this product will get expired.
taxIncluded boolean required Whether tax included or not?.
taxBasedOn string optional Based on the area(required if taxIncluded is true) like CUSTOMER-BILLING-ADDR,CUSTOMER-SHIPPING-ADDR,SHOP-BASE-ADDRESS.
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.

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

HTTP Request

POST api/product/delete

Body Parameters

Parameter Type Status Description
delete_ids array required 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
}

HTTP Request

GET api/product/price/{id}

URL Parameters

Parameter Status Description
id required 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"
}

HTTP Request

POST api/product/quickEdit

Body Parameters

Parameter Type Status Description
product_ids array required All product IDs which needs to be updated.
outofstock boolean optional If true, it updates the status of the course as out-of-stock.

Evaluation Modules

A evaluation 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 evaluation modules.

Evaluation Modules Tabular List

Returns all the evaluation 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/evaluation?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/evaluation"
);

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": "evaluation",
            "icon": "<i class=\"el-icon-star-off\"><\/i>",
            "author": "Aom Staff",
            "created_at": "Aug 11, 2020 08:12 AM"
        }
    ]
}

HTTP Request

GET api/modules/evaluation

Query Parameters

Parameter Status Description
page_size required The number of the items you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param optional for searching items based on field names.

Create Evaluation Module

To create a evaluation module, you need to use this request. (See parameters) Created evaluation modules can be used in the course as course content.

Returns : id of the evaluation module created and successfull message

Example request:

curl -X POST \
    "https://demo.aomlms.com/api/modules/evaluation" \
    -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 Evaluation","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/evaluation"
);

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 Evaluation",
    "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"
}

HTTP Request

POST api/modules/evaluation

Body Parameters

Parameter Type Status Description
name string required Name of the text module.
content string optional Content for the text modules that students will see.
submitButtonText string required Text for the submit button.
submitOption string required Submission options for students.
fields array required Form fields inside the Evaluation form(like radio, dropdown, rating, text, textarea, etc).
redirect string optional After submission of evaluation, where the students will be redirected.
trackCompletion boolean required If true, the module is being tracked(whether its finished or not) in course player.

Update Evaluation Module

Updates the details of a specified evaluation module. (See parameters) Evaluation modules can be used in the course as course content.

Example request:

curl -X PUT \
    "https://demo.aomlms.com/api/modules/evaluation/1" \
    -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 Evaluation","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/evaluation/1"
);

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 Evaluation",
    "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"
}

HTTP Request

PUT api/modules/evaluation/{id}

Body Parameters

Parameter Type Status Description
name string required Name of the text module.
content string optional Content for the text modules that students will see.
submitButtonText string required Text for the submit button.
submitOption string required Submission options for students.
fields array required Form fields inside the Evaluation form(like radio, dropdown, rating, text, textarea, etc).
redirect string optional After submission of evaluation, where the students will be redirected.
trackCompletion boolean required If true, the module is being tracked(whether its finished or not) in course player.

Retrieve Evaluation module

Retrieves the details of the specified evaluation module. Helps in fetching evaluation module using its ID. (See Parameters)

Example request:

curl -X GET \
    -G "https://demo.aomlms.com/api/modules/evaluation/15" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/modules/evaluation/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 Evaluation",
    "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": []
        }
    ]
}

HTTP Request

GET api/modules/evaluation/{id}

URL Parameters

Parameter Status Description
id required ID of the evaluation module you want to the fetch details of.

Retrieve detailed Evaluation module Info

Retrieves details of evaluation module in depth as well as different modules details that are being used as course content for the same course the current evaluation module is attached to. Returns related fields value. (See Response)

Example request:

curl -X GET \
    -G "https://demo.aomlms.com/api/module/evaluation/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/evaluation/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": "evaluation",
            "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
        }
    }
}

HTTP Request

GET api/module/evaluation/details

Query Parameters

Parameter Status Description
registrationId required ID of the course Registration for which this module is attached to.
moduleId required ID of the evaluation module.

Mark complete evaluation module

Updates the status of the evaluation module to completed. Changes the completion percentage to 100% and mark completed the evaluation module.

Example request:

curl -X PUT \
    "https://demo.aomlms.com/api/module/evaluation/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/evaluation/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"
}

HTTP Request

PUT api/module/evaluation/markComplete

Body Parameters

Parameter Type Status Description
form_id integer required ID of the form, used in evaluation module.
statusRowId integer required ID of the ModuleStatus Row belongs to current evaluation module.
timeSpent number required Total time spent by user in current evaluation 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 evaluation as question and answer. (See response)

Example request:

curl -X GET \
    -G "https://demo.aomlms.com/api/module/evaluation/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/evaluation/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"
    ]
}

HTTP Request

GET api/module/evaluation/student-details

Body Parameters

Parameter Type Status Description
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/evaluation/course-details?course_id=1&page_size=9&page_number=20" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/module/evaluation/course-details"
);

let params = {
    "course_id": "1",
    "page_size": "9",
    "page_number": "20",
};
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
    ]
}

HTTP Request

GET api/module/evaluation/course-details

Query Parameters

Parameter Status Description
course_id required ID of the course you want to fetch the evaluation response reports for.
page_size required The number of the item you want for a page.
page_number required Current page number in pagination.

Save Evaluation 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/evaluation/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/evaluation/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"
}

HTTP Request

POST api/module/evaluation/save-response

Body Parameters

Parameter Type Status Description
name string required name of the evaluation module.
content string optional Content for the evaluation 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 required ID of the course.
form_id integer required ID of the form, used in this evaluation module.
form_fields object optional All form fields value used in form for submission.

Front End API

Endpoints for Front end Marketing Pages

api/integrations/webhook/eventLookup

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 (401):

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/integrations/webhook/eventLookup

api/webhook/create

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}"
const url = new URL(
    "https://demo.aomlms.com/api/webhook/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));

HTTP Request

POST api/webhook/create

api/webhooks

Example request:

curl -X GET \
    -G "https://demo.aomlms.com/api/webhooks" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/webhooks"
);

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

HTTP Request

GET api/webhooks

api/webhook/{id}

Example request:

curl -X PUT \
    "https://demo.aomlms.com/api/webhook/1" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/webhook/1"
);

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));

HTTP Request

PUT api/webhook/{id}

api/webhook/delete/{id}

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));

HTTP Request

DELETE api/webhook/delete/{id}

api/webhook/logs/{id}

Example request:

curl -X GET \
    -G "https://demo.aomlms.com/api/webhook/logs/1" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/webhook/logs/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 (401):

{
    "message": "Unauthenticated."
}

HTTP Request

GET api/webhook/logs/{id}

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

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

HTTP Request

PUT api/settings/emails/general

Body Parameters

Parameter Type Status Description
fromName string required Sender name of the email.
fromEmail string required Sender email.
replyToEmail string required Reply email for emails.
templateDesign string required Template design.
headerLogo string required Header logo of the email.
customHeaderLogoURL string optional Custom header logo.
headerBgColor string required Header background color of the email(in hex form).
bgColor string required Background color of the email.
bodyBgColor string required Body background color of the email.
bodyTextColor string required 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"
}

HTTP Request

PUT api/settings/edit-template

Body Parameters

Parameter Type Status Description
content string optional Content of the email(body).
enabled boolean required If true, this email format is enabled to sent email on events.
subject string required Subject for email.
recipients string required Email recipients.
heading string required Heading of the email.
type string required Which email format is about to get sent.

Retrieve General Email Format

Retrieves the details of the general email formats. Helps in fetching different types of the email format based on type of the email(See Response)

Example request:

curl -X GET \
    -G "https://demo.aomlms.com/api/settings/get-template" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/settings/get-template"
);

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):

[
    {
        "area": "account",
        "type": "new_account_creation_others",
        "subject": "A new account has been created on your site : [site_name]",
        "recipients": null,
        "heading": "New Account",
        "content": "A new account has been created on your site : [site_name]",
        "enabled": false
    }
]

HTTP Request

GET api/settings/get-template

URL Parameters

Parameter Status Description
type[] required Type of the email format type(new_account_creation_others, pwd_reset_request, course_enrollment, etc) you want to fetch the details of.

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

HTTP Request

GET api/settings/general

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":"dolorem","homePage":"1","productCatalogPage":2,"cartPage":5,"checkoutPage":"4"}'
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": "dolorem",
    "homePage": "1",
    "productCatalogPage": 2,
    "cartPage": 5,
    "checkoutPage": "4"
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "message": "Settings Updated"
}

HTTP Request

POST api/settings/general

Body Parameters

Parameter Type Status Description
siteTitle string required Title of the site.
adminEmail string required Email of the admin.
siteLanguage string required Language of the site.
timeZone string required Timezone of the site.
dateFormat string required Format of the date for site.
timeFormat string required Format of the time for site.
privateSite string required Is the site private or not.
customTimeZone string required Custom timezone for site. Example:
homePage string optional int Homepage for site(page Id).
productCatalogPage integer required Product catalog page for site(page Id).
cartPage integer required Cart page for site(page Id).
checkoutPage string required Checkout page for site(page Id).

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 &copy; Your Company Name - All rights reserved."
}

HTTP 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 &copy; Your Company Name - All rights reserved.","logo":"laudantium","logoMini":"rerum","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 &copy; Your Company Name - All rights reserved.",
    "logo": "laudantium",
    "logoMini": "rerum",
    "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"
}

HTTP Request

PUT api/settings/branding

Body Parameters

Parameter Type Status Description
brandColors array required Brand colors for the site(body, background, primary colors).
footerText string required Footer text for the site.
logo string optional Logo for the site. Example:
logoMini string optional Mini Logo for the site. Example:
shouldCompileTheme boolean required Should the theme be compiled.
topBarEmail string required Topbar email for site.
topBarPhone string required 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": ""
}

HTTP 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 Sucessfully"
}

HTTP Request

PUT api/settings/customstyle

Body Parameters

Parameter Type Status Description
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):

{}

HTTP Request

PUT api/settings/update-state

Body Parameters

Parameter Type Status Description
area string required Which email format is going to get enabled or disabled.
isEnabled boolean required If true, the select email format area will get enabled otherwise disabled.
type string required 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"
            }
        ]
    }
]

HTTP Request

POST api/generic-search

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

HTTP Request

GET api/groups/tabularlist

Query Parameters

Parameter Status Description
page_size required The number of the items you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param 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"
    }
]

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

HTTP Request

GET api/group/students/{id}

URL Parameters

Parameter Status Description
id optional int required ID of the group.

Query Parameters

Parameter Status Description
page_size required The number of the items you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param 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": []
}

HTTP Request

GET api/group/courses/{id}

URL Parameters

Parameter Status Description
id optional int required ID of the group.

Query Parameters

Parameter Status Description
page_size required The number of the items you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param 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":"[{id: 1, name: \"course 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": "[{id: 1, name: \"course 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"
}

HTTP Request

POST api/group/create

Body Parameters

Parameter Type Status Description
name string required Name of the group.
referralCode string required Referral code for the course.
brandColor string optional Brand color for the group.
logoUrl string optional Logo URL for the group images.
userAddChoice string required Type of user adding option(newUser or existingUser).
existingUserId integer optional Existing user Id.
courseSeats array optional which courses are being added to this group and how many seats for each course.

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

HTTP Request

GET api/group/{id}

URL Parameters

Parameter Status Description
id required 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":"[{id: 1, name: \"course 1\", seats: 120}]"}'
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": "[{id: 1, name: \"course 1\", seats: 120}]"
}

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

HTTP Request

PUT api/group/{id}

URL Parameters

Parameter Status Description
id optional int required ID of the group.

Body Parameters

Parameter Type Status Description
name string required Name of the group.
referralCode string required Referral code for the course.
brandColor string optional Brand color for the group.
logoUrl string optional Logo URL for the group images.
userAddChoice string required Type of user adding option(newUser or existingUser).
existingUserId integer optional Existing user Id.
courseSeats array optional which courses are being added to this group and how many seats for each course.

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.

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": 7,
        "name": "REST API Access",
        "identifier": "rest-api-access",
        "description": "Now you can leverage RESTFull services. Enable this feature to work with different apps.",
        "logo_url": "\/images\/google-analytics.svg",
        "is_enabled": true,
        "implementer_class": null,
        "created_by": 1,
        "updated_by": 1,
        "created_at": null,
        "updated_at": "2020-08-07 11:21:27"
    },
    {
        "id": 5,
        "name": "Zoom Meetings",
        "identifier": "zoom-meetings",
        "description": "Zoom is a web-based video conferencing tool. Set API details to use it 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": 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": 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": 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
    }
]

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

HTTP Request

PUT api/integrations/settings/{id}

URL Parameters

Parameter Status Description
id optional int required ID of the integration.

Body Parameters

Parameter Type Status Description
is_enabled boolean required 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>"
    }
}

HTTP Request

GET api/integrations/settings/{id}

URL Parameters

Parameter Status Description
id optional int required 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"
}

HTTP Request

PUT api/integrations/updateStatus

Body Parameters

Parameter Type Status Description
id integer required ID of the integration.
status boolean required Whether this integration is enabled or not.

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

HTTP Request

POST api/media

Query Parameters

Parameter Status Description
resumableChunkNumber required Chunk number for the media.
resumableChunkSize required Chunk size for the media in bits.
resumableCurrentChunkSize required Current uploading chunk size for the media in bits.
resumableTotalSize required Total chunk size for the media in bits.
resumableType required Type of the media in that is going to be uploaded.
resumableIdentifier required Identifier for the media that is going to be uploaded.
resumableFilename required Name of the media that is going to be uploaded.
resumableRelativePath required Relative path of the media that is going to be uploaded.
resumableTotalChunks required Total chunks.
file required 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"
        }
    ]
}

HTTP Request

GET api/media/tabularlist

Query Parameters

Parameter Status Description
page_size required The number of the items you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param 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"
}

HTTP Request

POST api/media/delete

Body Parameters

Parameter Type Status Description
delete_ids array required All media IDs which needs to be deleted.

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

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

HTTP Request

GET api/menus/items/{id}

URL Parameters

Parameter Status Description
id optional int required 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"
}

HTTP Request

POST api/menus

Body Parameters

Parameter Type Status Description
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 Evaluation. 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>"
}

HTTP Request

POST api/modules/addBlank

Body Parameters

Parameter Type Status Description
name string required Name of the module that you want to create.
type string required 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=qui" \
    -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": "qui",
};
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>"
    }
]

HTTP Request

GET api/modules/lookup

Query Parameters

Parameter Status Description
search_term required 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
        }
    ]
}

HTTP 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": "evaluation",
        "display_value": "Evaluation"
    }
]

HTTP Request

GET api/modules/type/lookup

FormField Types Lookup

Retrieves all the type of the form fields that platform supports for Evaluation module. Helps while showing form fields types in form elements like dropdown while creating evaluation 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"
    }
]

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

HTTP Request

GET api/modules/tabularlist

Query Parameters

Parameter Status Description
page_size required The number of the items you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param 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"

HTTP Request

PUT api/modules/update-slug/{id}

URL Parameters

Parameter Status Description
id required The ID of the module.

Body Parameters

Parameter Type Status Description
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"
}

HTTP Request

POST api/module/quickEdit

Body Parameters

Parameter Type Status Description
module_ids array required 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."
}

HTTP Request

POST api/modules/delete

Body Parameters

Parameter Type Status Description
delete_ids array required 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 quizzzes 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"
    }
]

HTTP Request

GET api/quiz/lookup

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

HTTP Request

GET api/modules/pdf

Query Parameters

Parameter Status Description
page_size required The number of the items you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param 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":"aut","instructions":"<p>This is the short description here<\/p>","url":"https:\/\/drive.google.com\/file\/d\/0B5cbJMbHsJ1gc3RhcnRlcl9maWX2Rhc2hlclYw\/view?usp=sharing","trackCompletion":true,"allowDownload":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": "aut",
    "instructions": "<p>This is the short description here<\/p>",
    "url": "https:\/\/drive.google.com\/file\/d\/0B5cbJMbHsJ1gc3RhcnRlcl9maWX2Rhc2hlclYw\/view?usp=sharing",
    "trackCompletion": true,
    "allowDownload": 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"
}

HTTP Request

POST api/modules/pdf

Body Parameters

Parameter Type Status Description
name string required Name of the pdf module.
content string required Content for the pdf module that students will see. Example:
instructions string required Description for the pdf module that students will see.
url string required URL or actual path of the pdf module that students will see.
trackCompletion boolean required If true, the module is being tracked(whether its finished or not) in course player.
allowDownload boolean required If true, the pdf can be downloaded(by the students) otherwise not 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
}

HTTP Request

GET api/modules/pdf/{id}

URL Parameters

Parameter Status Description
id required 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}'
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
}

fetch(url, {
    method: "PUT",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "message": "Module updated successfully"
}

HTTP Request

PUT api/modules/pdf/{id}

URL Parameters

Parameter Status Description
id optional int required ID of the pdf module.

Body Parameters

Parameter Type Status Description
name string required Name of the pdf module.
content string required Content for the text modules that students will see.
url string required URL or actual path of the pdf module that students will see.
trackCompletion boolean required If true, the module is being tracked(whether its finished or not) in course player.
allowDownload boolean required If true, the pdf can be downloaded(by the students) otherwise not 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
}

HTTP Request

GET api/module/pdf/details

Query Parameters

Parameter Status Description
registrationId required ID of the course Registration for which this module is attached to.
moduleId required ID of the pdf module.

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.

Retrieve Page Layout

Retrieves all pages name and the code snippet that is being used for making that page that user has ever created in this platform. (See response)

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}"
const url = new URL(
    "https://demo.aomlms.com/api/pages/layouts"
);

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):

{
    "homepage1": {
        "name": "Home Page Layout 1",
        "html": "<div class=\"jumbotron jumbotron-fluid bg-transparent\" style=\"background-blend-mode: overlay;background-image: url('https:\/\/www.academyofmine.com\/wp-content\/uploads\/2020\/01\/geometric-bg-overlay-01.jpg'),linear-gradient(60deg,#a117,#17b9e6 100%)!important\">\r\n            <div class=\"container\">\r\n                <h1 class=\"text-center text-white mb-2\"><b>A better way to enhance your skills<\/b><\/h1>\r\n                <h2 class=\"text-center text-white mb-4\">Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos.<\/h2>\r\n                <p class=\"text-center text-white\">Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque sed odio at nibh consectetur dapibus. Sed rhoncus molestie ornare. Interdum et malesuada fames ac ante ipsum primis in faucibus. Suspendisse imperdiet quam magna, ut vestibulum quam faucibus vitae. Fusce accumsan varius nisl quis suscipit. Phasellus libero eros, consequat&nbsp;<\/p>\r\n                <div class=\"d-sm-flex align-items-center justify-content-center\">\r\n                    <div class=\"m-4 text-center\"><a href=\"\/course-catalog\" class=\"btn btn-block btn-light btn-lg\">View All Courses<i class=\"ml-2 fas fa-arrow-right\"><\/i><\/a><\/div>\r\n                  <div class=\"m-4 text-center\"><a href=\"\/register\" class=\"btn btn-lg btn-block btn-outline-light\" style=\"\">Register <i class=\"fas fa-user-plus mr-2\"><\/i><\/a><\/div>\r\n                <\/div>\r\n            <\/div>\r\n        <\/div>\r\n        <h1 class=\"my-4 text-center\"><b>Why Choose Us?<\/b><\/h1>\r\n        <div class=\"container pt-4\">\r\n            <div class=\"row\">\r\n                <div class=\"col col-md-4\">\r\n                    <div class=\"d-flex justify-content-center\">\r\n                        <div class=\"icon-wrapper p-4 rounded bg-primary rounded-circle\">\r\n                            <p class=\"m-0 text-white\" style=\"font-size:50px;line-height:1\"><i class=\"fab fa-battle-net\"><\/i><\/p>\r\n                        <\/div>\r\n                    <\/div>\r\n                    <h2 class=\"mt-4 text-center\"><b>Deep Industry Experience<\/b><\/h2>\r\n                    <p class=\"text-center\">We have more than 10 Years experience in delivering quality learning on professional training<\/p>\r\n                <\/div>\r\n                <div class=\"col col-md-4\">\r\n                    <div class=\"d-flex justify-content-center\">\r\n                        <div class=\"icon-wrapper p-4 rounded bg-primary rounded-circle\">\r\n                            <p class=\"m-0 text-white\" style=\"font-size:50px;line-height:1\"><i class=\"far fa-thumbs-up\"><\/i><\/p>\r\n                        <\/div>\r\n                    <\/div>\r\n                    <h2 class=\"mt-4 text-center\"><b>Best-In-Class Instructors<\/b><\/h2>\r\n                    <p class=\"text-center\">Our engaging curriculum and dedicated staff helps you to learn techniques easily.<\/p>\r\n                <\/div>\r\n                <div class=\"col col-md-4\">\r\n                    <div class=\"d-flex justify-content-center\">\r\n                        <div class=\"icon-wrapper p-4 rounded bg-primary rounded-circle\">\r\n                            <p class=\"m-0 text-white\" style=\"font-size:50px;line-height:1\"><i class=\"fas fa-chart-line\"><\/i><\/p>\r\n                        <\/div>\r\n                    <\/div>\r\n                    <h2 class=\"mt-4 text-center\"><b>Grow your business<\/b><\/h2>\r\n                    <p class=\"text-center\">Learn the skills you need to grow your business as per industry standards.<\/p>\r\n                <\/div>\r\n            <\/div>\r\n        <\/div>\r\n        <section class=\"my-4 bg-primary text-center\">\r\n            <h1 class=\"py-5 text-white text-center\"><b>Click below to view all our Course Offerings<\/b><\/h1><a href=\"\/course-catalog\" class=\"btn btn-light btn-lg mb-4\">View All Courses<i class=\"ml-2 fas fa-arrow-right\"><\/i><\/a><\/section>\r\n        <h1 class=\"text-center my-4 py-5\"><strong>What Other Students Are Saying about us?<\/strong><\/h1>\r\n        <div class=\"container\">\r\n            <div class=\"row\">\r\n                <div class=\"col col-md-4\">\r\n                    <blockquote class=\"border bg-gray rounded p-4\">\r\n                        <p style=\"font-size:70px\" class=\"text-muted\"><i class=\"fas fa-quote-left\"><\/i><\/p>\r\n                        <p class=\"lead\">Some really great information and very well presented<\/p>\r\n                        <p><cite><b>Yvette M. Northrop<br>1533 Spring Haven Trail, NJ 07017<\/b><\/cite><\/p>\r\n                    <\/blockquote>\r\n                <\/div>\r\n                <div class=\"col col-md-4\">\r\n                    <blockquote class=\"border bg-gray rounded p-4\">\r\n                        <p style=\"font-size:70px\" class=\"text-muted\"><i class=\"fas fa-quote-left\"><\/i><\/p>\r\n                        <p class=\"lead\">Course Curriculum is easy to follow and instructors are awesome.<\/p>\r\n                        <p><cite><b>Yvette M. Northrop<br>569 Private Lane Cordele, GA 31015<\/b><\/cite><\/p>\r\n                    <\/blockquote>\r\n                <\/div>\r\n                <div class=\"col col-md-4\">\r\n                    <blockquote class=\"border bg-gray rounded p-4\">\r\n                        <p style=\"font-size:70px\" class=\"text-muted\"><i class=\"fas fa-quote-left\"><\/i><\/p>\r\n                        <p class=\"lead\">All videos are well arranged and easy to follow in step by step<\/p>\r\n                        <p><cite><b>Yvette M. Northrop<br>2018 Wright Court, AL 35546<\/b><\/cite><\/p>\r\n                    <\/blockquote>\r\n                <\/div>\r\n            <\/div>\r\n        <\/div>"
    },
    "aboutus1": {
        "name": "About Us",
        "html": "<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\">&nbsp;<\/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&amp;dpr=2&amp;h=150&amp;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.&nbsp;<\/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&amp;h=650&amp;auto=compress&amp;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&amp;h=650&amp;auto=compress&amp;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&amp;cs=tinysrgb&amp;dpr=2&amp;h=650&amp;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>"
    }
}

HTTP Request

GET api/pages/layouts

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\">&nbsp;<\/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>"
    }
}

HTTP Request

GET api/pages/snippets

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));

HTTP Request

POST api/contact-form

Body Parameters

Parameter Type Status Description
firstName string required First Name of the sender.
lastName string optional Last Name of the sender.
email string required Email of the sender.
toEmail string required Email of the receiver.
phoneNo string required Phone number of the sender.
content string required 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"
        }
    ]
}

HTTP Request

GET api/pages/tabularlist

Query Parameters

Parameter Status Description
page_size required The number of the items you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param optional for searching items based on field names.
type optional Type of the page(trashed, published).

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

HTTP Request

GET api/pages/dropdownlist

Query Parameters

Parameter Status Description
group_id required ID of the group.

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": "Page with no headers"
    }
]

HTTP Request

GET api/pages/layout/lookup

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\">&nbsp;<\/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&amp;dpr=2&amp;h=150&amp;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.&nbsp;<\/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&amp;h=650&amp;auto=compress&amp;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&amp;h=650&amp;auto=compress&amp;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&amp;cs=tinysrgb&amp;dpr=2&amp;h=650&amp;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": []
}

HTTP Request

GET api/page/{id}

URL Parameters

Parameter Status Description
id required ID of the page you want to fetch the details of.

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):

{
    "message": "Menu updated successfully"
}

HTTP Request

POST api/pages

Body Parameters

Parameter Type Status Description
title string required Title for the page.
content string optional Content(HTML, CSS, JS) for the page.
layout string required Layout type for the page(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"
}

HTTP Request

POST api/pages/delete

Body Parameters

Parameter Type Status Description
page_ids array required 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"
}

HTTP Request

POST api/pages/harddelete

Body Parameters

Parameter Type Status Description
page_ids array required 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"
}

HTTP Request

POST api/pages/restore

Body Parameters

Parameter Type Status Description
page_ids array required 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"

HTTP Request

PUT api/page/update-slug/{id}

URL Parameters

Parameter Status Description
id required The ID of the page.

Body Parameters

Parameter Type Status Description
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"
}

HTTP Request

PUT api/page/{id}

URL Parameters

Parameter Status Description
id optional int required ID of the page that needs to be updated.

Body Parameters

Parameter Type Status Description
title string required Title for the page.
content string optional Content(HTML, CSS, JS) for the page.
layout string required Layout type for the page(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.

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

HTTP Request

GET api/questions/tabularlist

Query Parameters

Parameter Status Description
page_size required The number of the items you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param optional for searching items based on field names.

Question types Lookup

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

HTTP 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=et" \
    -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": "et",
};
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?"
    }
]

HTTP Request

GET api/question/lookup

Query Parameters

Parameter Status Description
search_term required 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"
}

HTTP Request

POST api/questions/quickEdit

Body Parameters

Parameter Type Status Description
question_ids array required 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":"[{value: \"Elon Musk\", is_correct: true}, {value: \"Jeff bezos\", is_correct: false}]"}'
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": "[{value: \"Elon Musk\", is_correct: true}, {value: \"Jeff bezos\", is_correct: false}]"
}

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

HTTP Request

POST api/questions

Body Parameters

Parameter Type Status Description
title string required Title of the question.
type string required Type of the question(multiple choice, multiple answer, etc).
content string required 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": []
}

HTTP Request

GET api/question/{id}

URL Parameters

Parameter Status Description
id required 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/1" \
    -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":"[{value: \"Elon Musk\", is_correct: true}, {value: \"Jeff bezos\", is_correct: false}]"}'
const url = new URL(
    "https://demo.aomlms.com/api/question/1"
);

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": "[{value: \"Elon Musk\", is_correct: true}, {value: \"Jeff bezos\", is_correct: false}]"
}

fetch(url, {
    method: "PUT",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "message": "Question updated successfully"
}

HTTP Request

PUT api/question/{id}

Body Parameters

Parameter Type Status Description
title string required Title of the question.
type string required Type of the question(multiple choice, multiple answer, etc).
content string required 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."
}

HTTP Request

POST api/question/delete

Body Parameters

Parameter Type Status Description
delete_ids array required 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 occured 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"
        }
    ]
}

HTTP Request

POST api/question/bulkUpload

Body Parameters

Parameter Type Status Description
questionList array required All questions which needs to be added(should in excel data form).
quizIds array required All existing quizzes the questions are going to be added.
quiztype string required 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"
        }
    ]
}

HTTP Request

GET api/modules/quiz

Query Parameters

Parameter Status Description
page_size required The number of the items you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param 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":"[{id: 3, title: \"Is red a color?\"}]","showCorrectAnswerOption":"always","shuffleQuestions":false}'
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": "[{id: 3, title: \"Is red a color?\"}]",
    "showCorrectAnswerOption": "always",
    "shuffleQuestions": false
}

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

HTTP Request

POST api/modules/quiz

Body Parameters

Parameter Type Status Description
name string required Name of the pdf module.
content string optional Content for the pdf module that students will see.
type string required Type of the quiz.
forceSequential boolean required 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 required After attempting the quiz, show the correct answer.
shuffleQuestions boolean required Shuffle the questions?.

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

HTTP Request

GET api/modules/quiz/{id}

URL Parameters

Parameter Status Description
id required 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/1" \
    -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":"[{id: 3, title: \"Is red a color?\"}]","showCorrectAnswerOption":"always","shuffleQuestions":false}'
const url = new URL(
    "https://demo.aomlms.com/api/modules/quiz/1"
);

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": "[{id: 3, title: \"Is red a color?\"}]",
    "showCorrectAnswerOption": "always",
    "shuffleQuestions": false
}

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

HTTP Request

PUT api/modules/quiz/{id}

Body Parameters

Parameter Type Status Description
name string required Name of the pdf module.
content string optional Content for the pdf module that students will see.
type string required Type of the quiz.
forceSequential boolean required 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 required After attempting the quiz, show the correct answer.
shuffleQuestions boolean required Shuffle the questions?.

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
}

HTTP Request

GET api/module/quiz/details

Query Parameters

Parameter Status Description
registrationId required ID of the course Registration for which this module is attached to.
moduleId required 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"
}

HTTP Request

PUT api/modules/quiz/{id}/saveAnswer

URL Parameters

Parameter Status Description
id optional int required ID of the quiz module.

Query Parameters

Parameter Status Description
questionId required ID of the question is user is answering.
moduleStatusId required ID of the Module status of the current quiz.
markedAnswer required Answer marked by the user.
retakeCounter required 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"
}

HTTP Request

PUT api/modules/quiz/{id}/submitQuiz

URL Parameters

Parameter Status Description
id optional int required ID of the quiz module.

Body Parameters

Parameter Type Status Description
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",
    "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
}

HTTP Request

GET api/module/quiz/results

Query Parameters

Parameter Status Description
statusRowId required 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"
    }
]

HTTP Request

GET api/static-quiz/dropdownlist

SCORM Packages

SCORM packages can be used in course as course scorm module. Endpoints for managing SCORM Packages.

Create SCROM 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 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"
    }
}

HTTP Request

POST api/scormpackage

Query Parameters

Parameter Status Description
resumableChunkNumber required Chunk number for the scorm.
resumableChunkSize required Chunk size for the scorm in bits.
resumableCurrentChunkSize required Current uploading chunk size for the scorm in bits.
resumableTotalSize required Total chunk size for the scorm in bits.
resumableType required Type of the scorm in that is going to be uploaded.
resumableIdentifier required Identifier for the scorm that is going to be uploaded.
resumableFilename required Name of the scorm that is going to be uploaded.
resumableRelativePath required Relative path of the scorm that is going to be uploaded.
resumableTotalChunks required Total chunks.
file required 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"
        }
    ]
}

HTTP Request

GET api/scormpackages/tabularlist

Query Parameters

Parameter Status Description
page_size required The number of the items you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param 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"
    }
]

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

HTTP Request

GET api/scormpackage/{id}

URL Parameters

Parameter Status Description
id required 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."
}

HTTP Request

POST api/scormpackage/delete

Body Parameters

Parameter Type Status Description
delete_ids array required 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"
        }
    ]
}

HTTP Request

GET api/modules/scorm

Query Parameters

Parameter Status Description
page_size required The number of the items you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param 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"
}

HTTP Request

POST api/modules/scorm

Body Parameters

Parameter Type Status Description
name string required 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 required Id of the Scorm package.
trackCompletion boolean required 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/1" \
    -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/1"
);

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

HTTP Request

PUT api/modules/scorm/{id}

Body Parameters

Parameter Type Status Description
name string required 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 required Id of the Scorm package.
trackCompletion boolean required 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"
}

HTTP Request

GET api/modules/scorm/{id}

URL Parameters

Parameter Status Description
id required 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
}

HTTP Request

GET api/module/scorm/details

Query Parameters

Parameter Status Description
registrationId required ID of the course Registration for which this module is attached to.
moduleId required ID of the scorm module.

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

HTTP Request

GET api/modules/text

Query Parameters

Parameter Status Description
page_size required The number of the items you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param 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
}

HTTP Request

GET api/modules/text/{id}

URL Parameters

Parameter Status Description
id required 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"
}

HTTP Request

POST api/modules/text

Body Parameters

Parameter Type Status Description
name string required Name of the text module.
content string required Content for the text modules that students will see.
trackCompletion boolean required 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"
}

HTTP Request

PUT api/modules/text/{id}

URL Parameters

Parameter Status Description
id optional int required ID of the text module.

Body Parameters

Parameter Type Status Description
name string required Name of the text module.
content string required Content for the text modules that students will see.
trackCompletion boolean required 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
}

HTTP Request

GET api/module/text/details

Query Parameters

Parameter Status Description
registrationId required ID of the course Registration for which this module is attached to.
moduleId required 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"
}

HTTP Request

PUT api/module/text/markComplete

Body Parameters

Parameter Type Status Description
statusRowId required optional ID of the ModuleStatus Row belongs to current text 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": 2,
        "name": "admin",
        "display_name": "Admin"
    },
    {
        "id": 3,
        "name": "groupadmin",
        "display_name": "Group Admin"
    },
    {
        "id": 4,
        "name": "student",
        "display_name": "Student"
    }
]

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

HTTP Request

GET api/users/tabularlist

Query Parameters

Parameter Status Description
page_size required The number of the user you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param 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=dolore" \
    -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": "dolore",
};
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])"
        }
    ]
}

HTTP Request

GET api/users/getUsersByRole

Query Parameters

Parameter Status Description
role required The role of the 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]m"
    },
    {
        "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]"
    }
]

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

HTTP Request

POST api/user/create

Body Parameters

Parameter Type Status Description
firstName string required First Name of the user.
lastName string optional Last Name of the user.
email string required Email of the user.
password string required Password for the user.
role integer required Role(student/client-admin) for the user.

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

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

HTTP Request

POST api/user/bulkUpload

Body Parameters

Parameter Type Status Description
userList array required 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.

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
}

HTTP Request

GET api/user/{id}

URL Parameters

Parameter Status Description
id required 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":"{\"id\":4,\"name\":\"student\",\"display_name\":\"Student\"}","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": "{\"id\":4,\"name\":\"student\",\"display_name\":\"Student\"}",
    "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"
}

HTTP Request

PUT api/user/{id}

URL Parameters

Parameter Status Description
id required ID of the user.

Body Parameters

Parameter Type Status Description
firstName string required First Name of the user.
lastName string optional Last Name of the user.
email string required Email of the user.
lastLoggedIn string required Datetime or Never.
avatar string required Avatar svg icon for the user.
role json required Role of the user.
disabled boolean required User needs to be disabled or not.

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

HTTP Request

PUT api/user/updatePassword/{id}

URL Parameters

Parameter Status Description
id required ID of the user.

Body Parameters

Parameter Type Status Description
password string required 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",
            "statusIn18": "Not Started",
            "accessStatus": "Allowed",
            "percentComplete": 0,
            "registered_on": "Aug 09, 2020",
            "started_on": "",
            "completed_on": "",
            "expire_on": "Never",
            "isExpired": false
        }
    ]
}

HTTP Request

GET api/users/enrolled-courses

Query Parameters

Parameter Status Description
user_id required ID of the user.
page_size required number of the results you want in each page.
page_number required Current Page number.
order_by optional returns details in some order.
search_param 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):

null

HTTP Request

POST api/user/delete

Body Parameters

Parameter Type Status Description
delete_ids array required 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"
}

HTTP Request

POST api/user/quickEdit

Body Parameters

Parameter Type Status Description
user_ids array required All user IDs which needs to be updated.
disabled array required 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"
}

HTTP Request

POST api/user/{id}/addAddress

URL Parameters

Parameter Status Description
userId required User ID for which we want to add address.

Body Parameters

Parameter Type Status Description
fullName string required Full Name of the user.
addressLine1 string required Address line1 of the user.
addressLine2 string optional Address line2 of the user.
zipcode string required Zipcode of the user address.
city string required City of the user address.
state string optional State of the user address.
country string required Country of the user address.
isDefault boolean required 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"
    }
]

HTTP Request

GET api/user/userAddress/{id}

URL Parameters

Parameter Status Description
id required 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
    }
}

HTTP Request

GET api/user/dashboard/statistics

Query Parameters

Parameter Status Description
user_id required ID of the user.
page_size required number of the results you want in each page.
page_number required Current Page number.
order_by optional returns details in some order.
search_param 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"
        }
    ]
}

HTTP Request

GET api/user-activities

Query Parameters

Parameter Status Description
user_id required ID of the user.
page_size required number of the results you want in each page.
page_number required Current Page number.
order_by optional returns details in some order.
search_param optional Search parameters related to course.
context required 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": "&#36;",
    "records": []
}

HTTP Request

GET api/user-orders

Query Parameters

Parameter Status Description
user_id required ID of the user.
page_size required number of the results you want in each page.
page_number required Current Page number.
order_by required 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"
        }
    ]
}

HTTP Request

GET api/user-certificates/{id}

URL Parameters

Parameter Status Description
id required ID of the user.

Query Parameters

Parameter Status Description
page_size required number of the results you want in each page.
page_number required Current Page number.
order_by optional returns details in some order.
search_param 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/1/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/1/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"
}

HTTP Request

PUT api/user/{id}/delete-certificate

Body Parameters

Parameter Type Status Description
id integer required 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"
}

HTTP Request

PUT api/update-certificate-issue-date

Body Parameters

Parameter Type Status Description
rowId integer required ID of the user certificate.
newIssueDate datetime required 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"
    }
]

HTTP Request

GET api/default-address/{id}

URL Parameters

Parameter Status Description
id required ID of the user.

Retrieve address by ID

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

HTTP Request

GET api/getaddress/{id}

URL Parameters

Parameter Status Description
id required 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"
}

HTTP Request

POST api/user/updateAddress/{id}

URL Parameters

Parameter Status Description
id required User Address row id for UsersAddress model.

Body Parameters

Parameter Type Status Description
fullName string required Full Name of the user.
addressLine1 string required Address line1 of the user.
addressLine2 string optional Address line2 of the user.
zipcode string required Zipcode of the user address.
city string required City of the user address.
state string optional State of the user address.
country string required Country of the user address.
isDefault boolean required Is the address default for billing.

Retrieve user basic details

Retrieve basic details for a specified user. Basic details includes name, email, avatar, etc. (See parameters)

Example request:

curl -X POST \
    "https://demo.aomlms.com/api/user/basicDetail/4" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/user/basicDetail/4"
);

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):

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

HTTP Request

POST api/user/basicDetail/{id}

URL Parameters

Parameter Status Description
id required ID of the user.

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

HTTP Request

GET api/user/reports/user-detailed

Query Parameters

Parameter Status Description
user_id required ID of the user.
group_id optional ID of the group.
page_size required Number of the result row you want in each page.
page_number required Current Page number.
order_by optional Returns details in some order.
search_param optional Returns search filtered data.

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

HTTP Request

GET api/user-meta/2fa

Query Parameters

Parameter Status Description
user_id optional int required 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"
}

HTTP Request

POST api/user/prepareTwoFactorAuth

Body Parameters

Parameter Type Status Description
user_id integer required 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"
}

HTTP Request

POST api/user/confirmTwoFactorAuth

Body Parameters

Parameter Type Status Description
user_id integer required ID of the user.
secretCode number required secret code from users authenticator app.
qrCode string required QR code generated by prepareTwoFactor method.
stringCode string required 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
}

HTTP Request

POST api/user/disableTwoFactorAuth

Body Parameters

Parameter Type Status Description
user_id integer required 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"
        }
    ]
}

HTTP Request

GET api/modules/video

Query Parameters

Parameter Status Description
page_size required The number of the items you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param 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":"cum","url":"https:\/\/player.vimeo.com\/video\/382947752","provider":"vimeo","trackCompletion":true,"disableForwardSeek":true}'
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": "cum",
    "url": "https:\/\/player.vimeo.com\/video\/382947752",
    "provider": "vimeo",
    "trackCompletion": true,
    "disableForwardSeek": true
}

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

HTTP Request

POST api/modules/video

Body Parameters

Parameter Type Status Description
name string required Name of the video module.
content string required Content for the video modules that students will see.
coverUrl string optional Cover url path for the video module. Example:
url string required Url path for the video module.
provider string required Provider of the video(whether vimeo or upload manually).
trackCompletion boolean required If true, the module is being tracked(whether its finished or not) in course player.
disableForwardSeek boolean required If true, students will not be able to skip forward in the video.

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

HTTP Request

GET api/modules/video/{id}

URL Parameters

Parameter Status Description
id required 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/1" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -H "Authorization: Bearer {token}" \
    -d '{"name":"My-video-lesson","content":"Updated Brief Description","coverUrl":"quis","url":"https:\/\/player.vimeo.com\/video\/382947752","provider":"vimeo","trackCompletion":true,"disableForwardSeek":true}'
const url = new URL(
    "https://demo.aomlms.com/api/modules/video/1"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "Bearer {token}",
};

let body = {
    "name": "My-video-lesson",
    "content": "Updated Brief Description",
    "coverUrl": "quis",
    "url": "https:\/\/player.vimeo.com\/video\/382947752",
    "provider": "vimeo",
    "trackCompletion": true,
    "disableForwardSeek": 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"
}

HTTP Request

PUT api/modules/video/{id}

Body Parameters

Parameter Type Status Description
name string required Name of the video module.
content string required Content for the video modules that students will see.
coverUrl string optional Cover url path for the video module. Example:
url string required Url path for the video module.
provider string required Provider of the video(whether vimeo or upload manually).
trackCompletion boolean required If true, the module is being tracked(whether its finished or not) in course player.
disableForwardSeek boolean required If true, students will not be able to skip forward in the video.

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
}

HTTP Request

GET api/module/video/details

Query Parameters

Parameter Status Description
registrationId required ID of the course Registration for which this module is attached to.
moduleId required 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"
}

HTTP Request

PUT api/module/video/markComplete

Query Parameters

Parameter Status Description
statusRowId required ID of the ModuleStatus Row belongs to current video module.
videoDuration required Duration of the video of current 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=2&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": "2",
    "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": []
}

HTTP Request

GET api/modules/webinar

Query Parameters

Parameter Status Description
page_size required The number of the items you want for a page.
page_number required Current page number in pagination.
order_by optional For ordering items based on columns provided in JSON format.
search_param 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"}'
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"
}

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

HTTP Request

POST api/modules/webinar

Body Parameters

Parameter Type Status Description
name string required Name of the webinar module.
content string required Content for the webinar modules that students will see.
service_provider string required Service Provider of the webinar(Zoom, Vimeo, Big blue button).
meeting_url string optional URL of the webinar where students can join..
start_time string required Start time of the webinar.
end_time string required End time of the webinar.

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/1" \
    -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"}'
const url = new URL(
    "https://demo.aomlms.com/api/modules/webinar/1"
);

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

fetch(url, {
    method: "PUT",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "message": "Module updated successfully"
}

HTTP Request

PUT api/modules/webinar/{id}

Body Parameters

Parameter Type Status Description
name string required Name of the webinar module.
content string required Content for the webinar modules that students will see.
service_provider string required Service Provider of the webinar(Zoom, Vimeo, Big blue button).
meeting_url string optional URL of the webinar where students can join..
start_time string required Start time of the webinar.
end_time string required End time of the webinar.

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

HTTP Request

GET api/modules/webinar/{id}

URL Parameters

Parameter Status Description
id required 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": []
}

HTTP Request

GET api/module/webinar/details

Query Parameters

Parameter Status Description
registrationId required ID of the course Registration for which this module is attached to.
moduleId required 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"
    }
}

HTTP Request

GET api/module/webinar/launch

Query Parameters

Parameter Status Description
moduleId required 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"
}

HTTP Request

PUT api/module/webinar/markComplete

Query Parameters

Parameter Status Description
statusRowId required ID of the ModuleStatus Row belongs to current webinar module.