MENU navbar-image

Introduction

List of all API endpoints

Welcome to our API documentation!

Authenticating requests

This API is not authenticated.

Users

You can perform user management tasks like creating, deleting and updating users.

Retrieve Custom User Fields that needs to be shown onthe Registration page

Retrieves the details of pre saved Custom User Fields.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/users/customRegistrationFields" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/users/customRegistrationFields"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "fields": [
        {
            "id": 1,
            "type": "text",
            "label": "How you left",
            "defaultValue": null,
            "isRequired": false,
            "optionLabel": [],
            "isFieldOnRegistrationPage": false,
            "isFieldOnCertificate": true,
            "includeInReportExports": [
                "export-users",
                "export-orders"
            ]
        },
        {
            "id": 2,
            "type": "textarea",
            "label": "What is your home address",
            "defaultValue": null,
            "isRequired": true,
            "optionLabel": [],
            "isFieldOnRegistrationPage": true,
            "isFieldOnCertificate": false,
            "includeInReportExports": []
        }
    ]
}
 

Request   

GET api/users/customRegistrationFields

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

User Type

Retrieve all user types

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/userType/lookup" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/userType/lookup"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "db_value": "admin",
        "display_name": "Admin"
    },
    {
        "db_value": "owner",
        "display_name": "Owner"
    },
    {
        "db_value": "staff",
        "display_name": "Staff"
    },
    {
        "db_value": "group_admin",
        "display_name": "Group Admin"
    },
    {
        "db_value": "general",
        "display_name": "General"
    }
]
 

Request   

GET api/userType/lookup

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

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

Example request:
curl --request GET \
    --get "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%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/users/tabularlist"
);

const params = {
    "page_size": "10",
    "page_number": "1",
    "order_by": "{"colName":"created_at","direction":"desc"}",
    "search_param": "{"courseCategoryIds":[],"courseName":"course 1"}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.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>",
            "user_type": "general",
            "display_user_type": "General",
            "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>",
            "user_type": "owner",
            "display_user_type": "Owner",
            "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>",
            "user_type": "general",
            "display_user_type": "General",
            "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>",
            "user_type": "admin",
            "display_user_type": "Admin",
            "created_at": "Aug 03, 2020 09:31 AM",
            "last_login": "1 minute ago"
        }
    ]
}
 

Request   

GET api/users/tabularlist

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

page_size   string   

The number of the user you want for a page. Example: 10

page_number   string   

Current page number in pagination. Example: 1

order_by   string  optional  

For ordering items based on columns provided in JSON format. Example: {"colName":"created_at","direction":"desc"}

search_param   string  optional  

for searching items based on Course category ids, course name. Example: {"courseCategoryIds":[],"courseName":"course 1"}

User Type

Retrieve details of users of type Staff

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/users/getUsersByType?userType=10" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/users/getUsersByType"
);

const params = {
    "userType": "10",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "records": [
        {
            "id": 4,
            "name": "John Doe([email protected])"
        }
    ]
}
 

Request   

GET api/users/getUsersByType

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

userType   string  optional  

The type of user. Example: 10

User Lookup

Retrieves all the users. Helps in showing users in forms elements like dropdown.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/users/lookup" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/users/lookup"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 1,
        "full_name": "Aom Staff",
        "email": "[email protected]"
    },
    {
        "id": 2,
        "full_name": "Client Admin",
        "email": "[email protected]"
    },
    {
        "id": 3,
        "full_name": "Demoss Student",
        "email": "[email protected]"
    },
    {
        "id": 4,
        "full_name": "John Doe",
        "email": "[email protected]"
    }
]
 

Request   

GET api/users/lookup

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Create User

To create user, you need to use this request.

Example request:
curl --request POST \
    "https://demo.aomlms.com/api/user/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"firstName\": \"John\",
    \"lastName\": \"Doe\",
    \"email\": \"[email protected]\",
    \"password\": \"somePassword\",
    \"password_confirmation\": \"somePassword\"
}"
const url = new URL(
    "https://demo.aomlms.com/api/user/create"
);

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

let body = {
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "password": "somePassword",
    "password_confirmation": "somePassword"
};

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

Example response (200):


{
    "id": 11,
    "message": "User created successfully"
}
 

Request   

POST api/user/create

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

firstName   string   

First Name of the user. Example: John

lastName   string  optional  

Last Name of the user. Example: Doe

email   string   

Email of the user. Example: [email protected]

password   string   

Password for the user. Example: somePassword

password_confirmation   string   

Password for the user. Example: somePassword

Bulk Upload

To create users in bulk, you need to use this request.

Example request:
curl --request POST \
    "https://demo.aomlms.com/api/user/bulkUpload" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"userList\": [
        {
            \"email\": \"[email protected]\",
            \"first_name\": \"Fake FName\",
            \"last_name\": \"Fake LName\",
            \"password\": \"Qwerty@123\"
        },
        {
            \"email\": \"[email protected]\",
            \"first_name\": \"Fake FName 2\",
            \"last_name\": \"Fake LName 2\",
            \"password\": \"\"
        }
    ],
    \"groupId\": 1,
    \"selectedCourses\": [
        1,
        2
    ],
    \"membershipId\": 12,
    \"classIds\": [
        1,
        2
    ]
}"
const url = new URL(
    "https://demo.aomlms.com/api/user/bulkUpload"
);

const 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": "Qwerty@123"
        },
        {
            "email": "[email protected]",
            "first_name": "Fake FName 2",
            "last_name": "Fake LName 2",
            "password": ""
        }
    ],
    "groupId": 1,
    "selectedCourses": [
        1,
        2
    ],
    "membershipId": 12,
    "classIds": [
        1,
        2
    ]
};

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

Example response (200):


{
    "message": "User(s) uploaded successfully"
}
 

Request   

POST api/user/bulkUpload

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

userList   string[]   

Users list that needs to be added.

groupId   integer  optional  

Creates all users under specified group. Example: 1

selectedCourses   string[]  optional  

creates all users and add users in specified courses.

membershipId   integer  optional  

creates all users under specified membership. Example: 12

classIds   string[]  optional  

creates all users and add users in specified classes.

Retrieve Sample file for Bulk Upload

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/user/getBulkUploadSampleFile" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/user/getBulkUploadSampleFile"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "headers": [
        "email",
        "first_name",
        "last_name",
        "password"
    ],
    "records": [
        {
            "email": "[email protected]",
            "first_name": "Fake FName1",
            "last_name": "Fake LName1",
            "password": "Qwerty@123"
        },
        {
            "email": "[email protected]",
            "first_name": "Fake FName2",
            "last_name": "Fake LName2",
            "password": ""
        }
    ]
}
 

Request   

GET api/user/getBulkUploadSampleFile

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Retrieve User By ID

This endpoint returns the user details based on the ID specified.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/user/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/user/1"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.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>",
    "disabled": false
}
 

Request   

GET api/user/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

The ID of the user. Example: 1

Update User

Updates user details using parameters mentioned.

Example request:
curl --request PUT \
    "https://demo.aomlms.com/api/user/11" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"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>\",
    \"disabled\": false,
    \"customUserMetas\": [
        \"dolores\"
    ]
}"
const url = new URL(
    "https://demo.aomlms.com/api/user/11"
);

const 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>",
    "disabled": false,
    "customUserMetas": [
        "dolores"
    ]
};

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

Example response (200):


{
    "message": "User updated successfully"
}
 

Request   

PUT api/user/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the user. Example: 11

Body Parameters

firstName   string   

First Name of the user. Example: John

lastName   string  optional  

Last Name of the user. Example: Doe

email   string   

Email of the user. Example: [email protected]

lastLoggedIn   string   

Datetime or Never. Example: Never

avatar   string    AW" data-component="body">

Avatar svg icon for the user. Example: <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>

disabled   boolean   

User needs to be disabled or not. Example: false

customUserMetas   string[]  optional  

of metas if there are any custom usermetas present on the platform else empty array

Update User's Membership

Updates user membership plan using parameters mentioned.

Example request:
curl --request PUT \
    "https://demo.aomlms.com/api/user/11/update-membership" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"membership\": \"{\\\"id\\\":4,\\\"name\\\":\\\"Gold Plan\\\",\\\"expired_at\\\": \\\"2021-10-01 23:00:00\\\"}\"
}"
const url = new URL(
    "https://demo.aomlms.com/api/user/11/update-membership"
);

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

let body = {
    "membership": "{\"id\":4,\"name\":\"Gold Plan\",\"expired_at\": \"2021-10-01 23:00:00\"}"
};

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

Example response (200):


{
    "message": "User updated successfully"
}
 

Request   

PUT api/user/{id}/update-membership

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the user. Example: 11

Body Parameters

membership   json   

Membership plan for the user. Example: {"id":4,"name":"Gold Plan","expired_at": "2021-10-01 23:00:00"}

Update Password

Updates password for the user.

Example request:
curl --request PUT \
    "https://demo.aomlms.com/api/user/updatePassword/11" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"password\": \"somePassword\",
    \"confirmPassword\": \"Doe\"
}"
const url = new URL(
    "https://demo.aomlms.com/api/user/updatePassword/11"
);

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

let body = {
    "password": "somePassword",
    "confirmPassword": "Doe"
};

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

Example response (200):


{
    "message": "Password updated successfully"
}
 

Request   

PUT api/user/updatePassword/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the user. Example: 11

Body Parameters

password   string   

Password for the user. Example: somePassword

confirmPassword   string  optional  

Confirm Password for the user. Example: Doe

Enrolled Courses

Retrieves all the courses opted by specified user. You can apply filters using search_param via status(course status)

Example request:
curl --request GET \
    --get "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" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/users/enrolled-courses"
);

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

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "records": [
        {
            "id": 6,
            "courseId": 1,
            "featuredImageUrl": null,
            "courseSlug": "http://localhost:8000/course/course-1",
            "courseName": "course 1",
            "lastAccessed": "Never",
            "status": "Not Started",
            "display_status": "Not Started",
            "accessStatus": "Allowed",
            "percentComplete": 0,
            "registered_on": "Aug 09, 2020",
            "started_on": "",
            "completed_on": "",
            "expire_on": "Never",
            "isExpired": false
        }
    ]
}
 

Request   

GET api/users/enrolled-courses

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

user_id   string   

ID of the user. Example: 4

page_size   string   

Number of the results you want in each page. Example: 10

page_number   string   

Current Page number. Example: 1

order_by   string  optional  

Returns details in some order. Example: registered_on

search_param   string  optional  

Search parameters related to course. Example: {"status":["In Progress","Not Started"]}

Delete User

To delete a user, you need to use this request.

Example request:
curl --request POST \
    "https://demo.aomlms.com/api/user/delete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"delete_ids\": [
        2,
        3,
        4
    ]
}"
const url = new URL(
    "https://demo.aomlms.com/api/user/delete"
);

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

let body = {
    "delete_ids": [
        2,
        3,
        4
    ]
};

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

Example response (200):


{
    "message": "2 student(s) not deleted as they has enrollments. Please remove the student(s) from the course and try again."
}
 

Request   

POST api/user/delete

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

delete_ids   string[]   

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 --request POST \
    "https://demo.aomlms.com/api/user/quickEdit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"user_ids\": [
        4,
        2
    ],
    \"disabled\": false,
    \"course_ids\": [
        1,
        2
    ]
}"
const url = new URL(
    "https://demo.aomlms.com/api/user/quickEdit"
);

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

let body = {
    "user_ids": [
        4,
        2
    ],
    "disabled": false,
    "course_ids": [
        1,
        2
    ]
};

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

Example response (200):


{
    "message": "Users updated Successfully"
}
 

Request   

POST api/user/quickEdit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

user_ids   string[]   

All user IDs which needs to be updated.

disabled   string[]   

Whether user will be disabled or not. Example: false

course_ids   string[]  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 --request POST \
    "https://demo.aomlms.com/api/user/1/addAddress" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"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"
);

const 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,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Address added successfully"
}
 

Request   

POST api/user/{id}/addAddress

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

userId   string   

User ID for which we want to add address. Example: 4

Body Parameters

fullName   string   

Full Name of the user. Example: John Doe

addressLine1   string   

Address line1 of the user. Example: Boring Street

addressLine2   string  optional  

Address line2 of the user. Example: Awesome Colony

zipcode   string   

Zipcode of the user address. Example: 123456

city   string   

City of the user address. Example: Mumbai

state   string  optional  

State of the user address. Example: NY

country   string   

Country of the user address. Example: US

isDefault   boolean   

Is the address default for billing. Example: false

Retrieve Addresses

Retrieves all the addresses which are added by the specified user.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/user/userAddress/4" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/user/userAddress/4"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 1,
        "isDefault": false,
        "fullName": "John Doe",
        "addressLine1": "Boring Street",
        "addressLine2": "Awesome Colony",
        "zipcode": "123456",
        "city": "Mumbai",
        "state": "MH",
        "country": "IN"
    }
]
 

Request   

GET api/user/userAddress/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the user. Example: 4

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 --request GET \
    --get "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" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/user/dashboard/statistics"
);

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

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "notStarted": 1,
    "inProgress": 0,
    "completed": 0,
    "total": 1,
    "studentName": "John Doe",
    "timeSpent": {
        "hours": 0,
        "minutes": 0,
        "seconds": 0,
        "totalSeconds": 0
    }
}
 

Request   

GET api/user/dashboard/statistics

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

user_id   string   

ID of the user. Example: 4

page_size   string   

Number of the results you want in each page. Example: 10

page_number   string   

Current Page number. Example: 1

order_by   string  optional  

Returns details in some order. Example: registered_on

search_param   string  optional  

Search parameters related to course. Example: {"status":["In Progress","Not Started"]}

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 --request GET \
    --get "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" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/user-activities"
);

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

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "avatar": "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"40\" height=\"40\" viewBox=\"0 0 40 40\"><circle cx=\"20\" cy=\"20\" r=\"20\" stroke=\"background\" stroke-width=\"0\" fill=\"#03A9F4\" /><text x=\"20\" y=\"20\" font-size=\"14\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">JD</text></svg>",
    "name": "John Doe",
    "email": "[email protected]",
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "records": [
        {
            "id": 15,
            "verb": "ENROLLED",
            "created_at": "Aug 09, 2020 10:27 AM",
            "message": "John Doe is enrolled to course 1",
            "course": "course 1"
        }
    ]
}
 

Request   

GET api/user-activities

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

user_id   string   

ID of the user. Example: 4

page_size   string   

Number of the results you want in each page. Example: 10

page_number   string   

Current Page number. Example: 1

order_by   string  optional  

Returns details in some order. Example: {"colName":"created_at", "direction": "desc"}}

search_param   string  optional  

Search parameters related to course. Example: {"courseCategoryIds":[],"courseName":"course-1","status":"In Progress"}

context   string   

Context for the details. Example: admin

Retrieve User Orders

Retrieve order details, purchased by a specified user. Returned data is in pagination form.

Example request:
curl --request GET \
    --get "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" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/user-orders"
);

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

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.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": []
}
 

Request   

GET api/user-orders

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

user_id   string   

ID of the user. Example: 4

page_size   string   

Number of the results you want in each page. Example: 10

page_number   string   

Current Page number. Example: 1

order_by   string   

Returns details in some order. Example: {"colName":"created_at", "direction": "desc"}}

Retrieve Certificates

Retrieve all certificates earned by the user for every course they pursued/completed.

Example request:
curl --request GET \
    --get "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%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/user-certificates/4"
);

const params = {
    "page_size": "10",
    "page_number": "1",
    "order_by": "{"colName":"created_at", "direction": "desc"}}",
    "search_param": "{"courseCategoryIds":[],"courseName":""}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "records": [
        {
            "id": 1,
            "courseId": 1,
            "userId": 3,
            "templateId": 1,
            "courseName": "course 1",
            "coursefeaturedImage": null,
            "issueDate": "Aug 03, 2020 10:02 AM"
        }
    ]
}
 

Request   

GET api/user-certificates/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the user. Example: 4

Query Parameters

page_size   string   

Number of the results you want in each page. Example: 10

page_number   string   

Current Page number. Example: 1

order_by   string  optional  

Returns details in some order. Example: {"colName":"created_at", "direction": "desc"}}

search_param   string  optional  

Apply search parameter. Example: {"courseCategoryIds":[],"courseName":""}

Remove Certificate

To removes the certificate for a specified user, you need to use this request.

Example request:
curl --request PUT \
    "https://demo.aomlms.com/api/user/{id}/delete-certificate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"id\": 1
}"
const url = new URL(
    "https://demo.aomlms.com/api/user/{id}/delete-certificate"
);

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

let body = {
    "id": 1
};

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

Example response (200):


{
    "message": "Certificate Deleted Successfully"
}
 

Request   

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

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

id   integer   

ID of the certificate belongs to user. Example: 1

Update Certificate Issue Date

Updates the Issue date of Certificate for a user.

Example request:
curl --request PUT \
    "https://demo.aomlms.com/api/update-certificate-issue-date" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"rowId\": 1,
    \"newIssueDate\": \"2020-08-04 00:00:00\"
}"
const url = new URL(
    "https://demo.aomlms.com/api/update-certificate-issue-date"
);

const 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,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Issue Date Updated Successfully"
}
 

Request   

PUT api/update-certificate-issue-date

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

rowId   integer   

ID of the user certificate. Example: 1

newIssueDate   datetime   

New datetime for the certificate. Example: 2020-08-04 00:00:00

Retrieve Default Address

Retrieves the default address for the specified user.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/default-address/4" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/default-address/4"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 1,
        "addresstype": null,
        "isDefault": true,
        "fullName": "John Doe",
        "addressLine1": "Boring Street",
        "addressLine2": "Awesome Colony",
        "zipcode": "123456",
        "city": "Mumbai",
        "state": "MH",
        "country": "IN"
    }
]
 

Request   

GET api/default-address/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the user. Example: 4

Retrieve User Address

Retrieves the address for the specified user address ID.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/getaddress/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/getaddress/1"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 1,
        "isDefault": false,
        "fullName": "John Doe",
        "addressLine1": "Boring Street",
        "addressLine2": "Awesome Colony",
        "zipcode": "123456",
        "city": "Mumbai",
        "state": "MH",
        "country": "IN"
    }
]
 

Request   

GET api/getaddress/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the user address row from UsersAddress Model. Example: 1

Update Address

Updates the address for a specified user using UserAddress ID. (See Parameters)

Example request:
curl --request POST \
    "https://demo.aomlms.com/api/user/updateAddress/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"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"
);

const 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,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Address updated successfully"
}
 

Request   

POST api/user/updateAddress/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

User Address row id for UsersAddress model. Example: 1

Body Parameters

fullName   string   

Full Name of the user. Example: John Doe

addressLine1   string   

Address line1 of the user. Example: Boring Street

addressLine2   string  optional  

Address line2 of the user. Example: Awesome Colony

zipcode   string   

Zipcode of the user address. Example: 123456

city   string   

City of the user address. Example: Mumbai

state   string  optional  

State of the user address. Example: NY

country   string   

Country of the user address. Example: US

isDefault   boolean   

Is the address default for billing. Example: false

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 --request GET \
    --get "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" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/user/reports/user-detailed"
);

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

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "totalNotStarted": 1,
    "totalInProgress": 0,
    "totalCompleted": 0,
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "records": [
        {
            "courseName": "course 1",
            "status": "Not Started",
            "percent_complete": 0,
            "access_status": "Allowed",
            "registered_on": "Aug 09, 2020",
            "started_on": "",
            "completed_on": "",
            "expire_on": "Never",
            "last_accessed_on": "Never",
            "total_time_spent": "0h 0m",
            "certifcate_issued": "No"
        }
    ]
}
 

Request   

GET api/user/reports/user-detailed

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

user_id   string   

ID of the user. Example: 4

group_id   string  optional  

ID of the group. Example: 1

page_size   string   

Number of the result row you want in each page. Example: 10

page_number   string   

Current Page number. Example: 1

order_by   string  optional  

Returns details in some order. Example: {"colName":"created_at", "direction": "desc"}}

search_param   string  optional  

Returns search filtered data. Example: {"course":"1","status":["In Progress"]}

Retrieve User Report With Custom User Data

Retrieves detailed report for all user.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/users/report?page_size=10&page_number=1&registered_between=%7B%22first_name%22%3A%22Aom%22%2C%22last_name%22Staff%22%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/users/report"
);

const params = {
    "page_size": "10",
    "page_number": "1",
    "registered_between": "{"first_name":"Aom","last_name"Staff"}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "totalNotStarted": 1,
    "totalInProgress": 0,
    "totalCompleted": 0,
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "records": [
        {
            "first_name": "Aom",
            "last_name": "Staff",
            "email": "[email protected]",
            "user_type": "General",
            "created_at": "Aug 09, 2020",
            "last_login": "Oct 09, 2020"
        }
    ]
}
 

Request   

GET api/users/report

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

page_size   string   

Number of the result row you want in each page. Example: 10

page_number   string   

Current Page number. Example: 1

registered_between   string  optional  

Returns search filtered data. Example: {"first_name":"Aom","last_name"Staff"}

Retrieve User Subscription Tabular List

Returns all the user subscriptions created in a tabular list format. You can apply filter using search_param.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/user-subscriptions" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"user_id\": 4,
    \"page_size\": \"10\",
    \"page_number\": \"1\",
    \"order_by\": \"{\\\"colName\\\":\\\"created_at\\\",\\\"direction\\\":\\\"desc\\\"}\",
    \"search_param\": \"Active\"
}"
const url = new URL(
    "https://demo.aomlms.com/api/user-subscriptions"
);

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

let body = {
    "user_id": 4,
    "page_size": "10",
    "page_number": "1",
    "order_by": "{\"colName\":\"created_at\",\"direction\":\"desc\"}",
    "search_param": "Active"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "avatar": 4,
    "recordsTotal": 1,
    "currencySymbol": "$",
    "recordsFiltered": 1,
    "name": "Aom Staff",
    "email": "[email protected]",
    "records": [
        {
            "id": 3,
            "item": "Professional Training and Education",
            "status": "Active",
            "total": "100",
            "created_at": "Aug 10, 2020 12:43 PM"
        }
    ]
}
 

Request   

GET api/user-subscriptions

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

user_id   integer   

ID of the user. Example: 4

page_size   required  optional  

The number of the user you want for a page. Example: 10

page_number   required  optional  

Current page number in pagination. Example: 1

order_by   For  optional  

Ordering items based on columns provided in JSON format. Example: {"colName":"created_at","direction":"desc"}

search_param   for  optional  

Searching items based on status. Example: Active

Get Membership Content

Retrieves all the Membership contents in a tabular list format with pagination mode. You can apply filter using search_param via content-type (course or modules), content name or Description

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/membership/user-contents?page_size=10&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C%22direction%22%3A%22desc%22%7D&search_param=%7B%22type%22%3A%5B%27course%27%5D%2C%22nameOrDescription%22%3A%22course+1+description%22%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/membership/user-contents"
);

const params = {
    "page_size": "10",
    "page_number": "1",
    "order_by": "{"colName":"created_at","direction":"desc"}",
    "search_param": "{"type":['course'],"nameOrDescription":"course 1 description"}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.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>",
            "user_type": "general",
            "display_user_type": "General",
            "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>",
            "user_type": "owner",
            "display_user_type": "Owner",
            "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>",
            "user_type": "general",
            "display_user_type": "General",
            "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>",
            "user_type": "admin",
            "display_user_type": "Admin",
            "created_at": "Aug 03, 2020 09:31 AM",
            "last_login": "1 minute ago"
        }
    ]
}
 

Request   

GET api/membership/user-contents

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

page_size   string   

The number of the user you want for a page. Example: 10

page_number   string   

Current page number in pagination. Example: 1

order_by   string  optional  

For ordering items based on columns provided in JSON format. Example: {"colName":"created_at","direction":"desc"}

search_param   string  optional  

for searching items based on Course category ids, course name. Example: {"type":['course'],"nameOrDescription":"course 1 description"}

Retrieve List of User Source

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/user-source" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/user-source"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "records": [
        {
            "id": 1,
            "name": "Excel",
            "identifier": "excel",
            "description": "Bulk upload user from excel.",
            "logoUrl": "https://demo.aomlms.com/images/excel.svg"
        },
        {
            "id": 2,
            "name": "Hubspot",
            "identifier": "hubspot",
            "description": "Bulk import user from hubspot.",
            "logoUrl": "https://demo.aomlms.com/images/hubspot.svg"
        }
    ]
}
 

Request   

GET api/user-source

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Custom User Field Types Lookup

Retrieves all the type of the custom user fields that platform supports. Helps while showing fields types in form elements like dropdown while creating Custom User Fields. Returns a list of all custom user field types. (See Response)

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/users/fieldtype/lookup" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/users/fieldtype/lookup"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "db_value": "text",
        "display_value": "Text"
    },
    {
        "db_value": "textarea",
        "display_value": "Text Area"
    },
    {
        "db_value": "date",
        "display_value": "Date"
    },
    {
        "db_value": "radio",
        "display_value": "Single Select"
    },
    {
        "db_value": "checkbox",
        "display_value": "Multiple Select"
    },
    {
        "db_value": "dropdown",
        "display_value": "Drop Down"
    }
]
 

Request   

GET api/users/fieldtype/lookup

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Retrieve Custom User Fields

Retrieves the details of pre saved Custom User Fields.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/users/customUserFields" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/users/customUserFields"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "fields": [
        {
            "id": 1,
            "type": "text",
            "label": "How you left",
            "defaultValue": null,
            "isRequired": false,
            "optionLabel": [],
            "isFieldOnRegistrationPage": false,
            "isFieldOnCertificate": true,
            "includeInReportExports": [
                "export-users",
                "export-orders"
            ]
        },
        {
            "id": 2,
            "type": "textarea",
            "label": "What is your home address",
            "defaultValue": null,
            "isRequired": true,
            "optionLabel": [],
            "isFieldOnRegistrationPage": true,
            "isFieldOnCertificate": false,
            "includeInReportExports": []
        }
    ]
}
 

Request   

GET api/users/customUserFields

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Update Custom User fields

Updates the Custom User Fields. (See parameters) Custom User Fields can be used to collect additional details from the user from registration page and user profile page.

Example request:
curl --request PUT \
    "https://demo.aomlms.com/api/users/customUserFields" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"fields\": [
        {
            \"type\": \"text\",
            \"label\": \"How you left\",
            \"defaultValue\": \"\",
            \"isRequired\": false,
            \"optionLabel\": [],
            \"isFieldOnRegistrationPage\": true,
            \"isFieldOnCertificate\": true,
            \"includeInReportExports\": []
        },
        {
            \"type\": \"date\",
            \"label\": \"What is your Date of Birth\",
            \"defaultValue\": \"\",
            \"isRequired\": false,
            \"optionLabel\": [],
            \"isFieldOnRegistrationPage\": false,
            \"isFieldOnCertificate\": true,
            \"includeInReportExports\": []
        }
    ]
}"
const url = new URL(
    "https://demo.aomlms.com/api/users/customUserFields"
);

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

let body = {
    "fields": [
        {
            "type": "text",
            "label": "How you left",
            "defaultValue": "",
            "isRequired": false,
            "optionLabel": [],
            "isFieldOnRegistrationPage": true,
            "isFieldOnCertificate": true,
            "includeInReportExports": []
        },
        {
            "type": "date",
            "label": "What is your Date of Birth",
            "defaultValue": "",
            "isRequired": false,
            "optionLabel": [],
            "isFieldOnRegistrationPage": false,
            "isFieldOnCertificate": true,
            "includeInReportExports": []
        }
    ]
};

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

Example response (200):


{
    "message": "Fields updated successfully"
}
 

Request   

PUT api/users/customUserFields

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

fields   string[]   

Form fields (like radio, dropdown, text, textarea, date etc).

Custom User Field Reports Lookup

Retrieves all the Reports that can include the Custom User Field as an additional column in its export. Helps while showing report name in form field like dropdown while creating Custom User Fields. Returns a list of reports that supports Custom User Fields. (See Response)

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/users/customUserFieldsReports/lookup" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/users/customUserFieldsReports/lookup"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "db_value": "export-users",
        "display_value": "Export Users"
    },
    {
        "db_value": "course-insight",
        "display_value": "Course Insight"
    },
    {
        "db_value": "export-orders",
        "display_value": "Export Orders"
    }
]
 

Request   

GET api/users/customUserFieldsReports/lookup

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Check if the given Custom User Field is eligible for deletion

To delete a custom field, you need to use this request.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/users/can-delete-field" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"fieldToDelete\": \"{\\\"id\\\":2,\\\"type\\\":\\\"text\\\",\\\"displayType\\\":\\\"Text\\\",\\\"label\\\":\\\"Source\\\",\\\"defaultValue\\\":\\\"Enter Source\\\",\\\"isRequired\\\":false,\\\"userMetaKey\\\":\\\"source\\\",\\\"optionLabel\\\":[],\\\"isFieldOnRegistrationPage\\\":false,\\\"isFieldOnCertificate\\\":false,\\\"includeInReportExports\\\":[],\\\"display_order\\\":0,\\\"error\\\":false}\"
}"
const url = new URL(
    "https://demo.aomlms.com/api/users/can-delete-field"
);

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

let body = {
    "fieldToDelete": "{\"id\":2,\"type\":\"text\",\"displayType\":\"Text\",\"label\":\"Source\",\"defaultValue\":\"Enter Source\",\"isRequired\":false,\"userMetaKey\":\"source\",\"optionLabel\":[],\"isFieldOnRegistrationPage\":false,\"isFieldOnCertificate\":false,\"includeInReportExports\":[],\"display_order\":0,\"error\":false}"
};

fetch(url, {
    method: "GET",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "canDeleteField": true,
    "message": "",
    "certificateTemplates": ""
}
 

Request   

GET api/users/can-delete-field

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

fieldToDelete   required  optional  

Fields required. Example: {"id":2,"type":"text","displayType":"Text","label":"Source","defaultValue":"Enter Source","isRequired":false,"userMetaKey":"source","optionLabel":[],"isFieldOnRegistrationPage":false,"isFieldOnCertificate":false,"includeInReportExports":[],"display_order":0,"error":false}

Update class status of the student

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/users/update-class-status?id=3&status=Attended&classId=1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/users/update-class-status"
);

const params = {
    "id": "3",
    "status": "Attended",
    "classId": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "Status Updated Successfully"
}
 

Request   

GET api/users/update-class-status

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

id   string  optional  

enrollment ID of the student. Example: 3

status   string  optional  

The status of the class. It can be Registered, Attended, No Show, Cancelled. Example: Attended

classId   string  optional  

ID of the class. Example: 1

Retrieve enrolled class details

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/users/enrolled-classes?user_id=3&page_size=50&page_number=1&search_param=%7B%22course_id%22%3A%22%22%7D&order_by=%7B%22colName%22%3A%22registered_on%22%2C%22direction%22%3A%22desc%22%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/users/enrolled-classes"
);

const params = {
    "user_id": "3",
    "page_size": "50",
    "page_number": "1",
    "search_param": "{"course_id":""}",
    "order_by": "{"colName":"registered_on","direction":"desc"}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "records": [
        {
            "id": 6,
            "webinarId": null,
            "classId": 57,
            "title": "test ilt",
            "courseId": 34,
            "studyMethod": "instructor_led",
            "featuredImageUrl": null,
            "launchUrl": "https://staging.aomlms.com/class/test-ilt/launch/webinar/NTc=",
            "classStudyMaterial": "https://staging.aomlms.com/class/test-ilt/study-material/launch/NTc=",
            "status": "Registered",
            "display_status": "Registered",
            "registered_on": "Jan 04, 2024",
            "last_accessed_on": "Never",
            "startDate": "11-Jan-2024",
            "startTime": "21:00 PM",
            "endDate": "31-Jan-2024",
            "endTime": "04:00 AM",
            "location": "Cherry Hill",
            "start": "2024-01-11 21:00:00",
            "end": "2024-01-31 04:00:00",
            "instructor": "t t",
            "class": "orange",
            "add_calendar_link": "https://calendar.google.com/calendar/r/eventedit?text=test+ilt&dates=20240111T210000Z%2F20240131T040000Z&details=test+ilt.+For+details%2C+link+here+%3A+https%3A%2F%2Fstaging.aomlms.com"
        }
    ]
}
 

Request   

GET api/users/enrolled-classes

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

user_id   string  optional  

The ID of the user. Example: 3

page_size   string   

The number of the items you want for a page. Example: 50

page_number   string   

Current page number in pagination. Example: 1

search_param   string  optional  

For searching items based on field names. Example: {"course_id":""}

order_by   string  optional  

For ordering items based on columns provided in JSON format. Example: {"colName":"registered_on","direction":"desc"}

Retrieve enrolled class details

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/user/class/reports?user_id=3&page_size=50&page_number=1&group_id=1&order_by=%7B%22colName%22%3A%22registered_on%22%2C%22direction%22%3A%22desc%22%7D&search_param=%7B%22course%22%3A%22%22%2C%22status%22%3A%5B%5D%2C%22started_on%22%3A%5B%5D%2C%22completed_on%22%3A%5B%5D%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/user/class/reports"
);

const params = {
    "user_id": "3",
    "page_size": "50",
    "page_number": "1",
    "group_id": "1",
    "order_by": "{"colName":"registered_on","direction":"desc"}",
    "search_param": "{"course":"","status":[],"started_on":[],"completed_on":[]}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "totalAttended": 0,
    "totalNoshow": 0,
    "totalCancelled": 0,
    "totalRegistered": 1,
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "records": [
        {
            "courseName": "test ilt",
            "start_time": "11-Jan-2024 21:00 PM",
            "end_time": "31-Jan-2024 04:00 AM",
            "location": "Cherry Hill",
            "status": "Registered",
            "display_status": "Registered",
            "registered_on": "Jan 04, 2024",
            "last_accessed_on": "Never",
            "certificate_issued": "No"
        }
    ]
}
 

Request   

GET api/user/class/reports

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

user_id   string  optional  

The ID of the user. Example: 3

page_size   string   

The number of the items you want for a page. Example: 50

page_number   string   

Current page number in pagination. Example: 1

group_id   string  optional  

The ID of the group. Example: 1

order_by   string  optional  

For ordering items based on columns provided in JSON format. Example: {"colName":"registered_on","direction":"desc"}

search_param   string  optional  

For searching items based on field names. Example: {"course":"","status":[],"started_on":[],"completed_on":[]}

Retrieve user badges

This endpoint returns the badges gained based on the user ID specified.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/user/badges/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/user/badges/1"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 1,
        "title": "1",
        "badgeIconUrl": "/images/badges/Badge_1.png",
        "points": 1,
        "organizationId": "97852067",
        "count": 2
    }
]
 

Request   

GET api/user/badges/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

The ID of the user. Example: 1

Retrieve leaderboard details

This endpoint returns the leaderboard detials based on the user ID specified.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/user/leaderboard/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/user/leaderboard/1"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "rankedUsers": [
        {
            "id": 24,
            "rank": 1,
            "firstName": "John",
            "lastName": "Doe",
            "points": "6",
            "badgeCount": 2
        },
        {
            "id": 1,
            "rank": 2,
            "firstName": "Aom",
            "lastName": "Staff",
            "points": 0,
            "badgeCount": 0
        }
    ],
    "userTier": "Level 1",
    "userRank": 1
}
 

Request   

GET api/user/leaderboard/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

The ID of the user. Example: 1

Retrieve 2fa

Retrieves two factor authentication details for a specified user. Returned data includes QR code and String code.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/user-meta/2fa?user_id=4" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/user-meta/2fa"
);

const params = {
    "user_id": "4",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "as_qr_code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<svg xmlns=\"http://www.w3.org/2000/svg\" version=\"1.1\" width=\"200\" height=\"200\" viewBox=\"0 0 200 200\"><rect x=\"0\" y=\"0\" width=\"200\" height=\"200\" fill=\"#fefefe\"/><g transform=\"scale(4.444)\"><g transform=\"translate(0,0)\"><path fill-rule=\"evenodd\" d=\"M10 0L10 1L8 1L8 2L9 2L9 3L8 3L8 4L10 4L10 5L8 5L8 7L9 7L9 6L10 6L10 8L6 8L6 9L8 9L8 10L5 10L5 8L0 8L0 9L4 9L4 11L7 11L7 12L5 12L5 13L7 13L7 12L8 12L8 11L9 11L9 14L10 14L10 11L9 11L9 10L10 10L10 8L11 8L11 9L12 9L12 8L11 8L11 6L12 6L12 7L13 7L13 8L14 8L14 7L15 7L15 6L14 6L14 7L13 7L13 6L12 6L12 5L13 5L13 4L12 4L12 2L13 2L13 3L14 3L14 2L16 2L16 3L15 3L15 4L14 4L14 5L15 5L15 4L17 4L17 5L16 5L16 8L18 8L18 9L17 9L17 12L16 12L16 11L15 11L15 10L16 10L16 9L15 9L15 10L14 10L14 9L13 9L13 10L11 10L11 13L12 13L12 12L13 12L13 13L14 13L14 14L13 14L13 15L14 15L14 16L8 16L8 17L10 17L10 18L11 18L11 19L12 19L12 21L14 21L14 22L15 22L15 24L16 24L16 22L15 22L15 21L20 21L20 23L19 23L19 24L20 24L20 25L18 25L18 24L17 24L17 25L18 25L18 26L17 26L17 28L16 28L16 27L15 27L15 26L16 26L16 25L15 25L15 26L14 26L14 25L13 25L13 24L14 24L14 23L13 23L13 24L12 24L12 25L11 25L11 22L9 22L9 21L10 21L10 20L8 20L8 18L6 18L6 17L7 17L7 16L6 16L6 15L7 15L7 14L3 14L3 16L1 16L1 14L2 14L2 13L1 13L1 11L2 11L2 12L3 12L3 10L1 10L1 11L0 11L0 13L1 13L1 14L0 14L0 16L1 16L1 17L0 17L0 20L1 20L1 21L0 21L0 22L1 22L1 23L0 23L0 24L1 24L1 25L4 25L4 26L2 26L2 28L3 28L3 29L2 29L2 30L3 30L3 29L4 29L4 32L5 32L5 33L8 33L8 34L6 34L6 35L8 35L8 36L6 36L6 37L8 37L8 39L9 39L9 40L8 40L8 45L12 45L12 43L11 43L11 42L12 42L12 41L13 41L13 43L14 43L14 44L13 44L13 45L14 45L14 44L15 44L15 45L17 45L17 44L16 44L16 43L14 43L14 41L13 41L13 40L14 40L14 39L12 39L12 38L13 38L13 37L11 37L11 35L12 35L12 36L14 36L14 35L16 35L16 37L14 37L14 38L16 38L16 37L20 37L20 38L19 38L19 40L20 40L20 41L18 41L18 40L17 40L17 41L18 41L18 42L17 42L17 43L18 43L18 42L20 42L20 44L18 44L18 45L20 45L20 44L21 44L21 45L23 45L23 44L24 44L24 45L26 45L26 44L28 44L28 42L34 42L34 43L37 43L37 41L39 41L39 44L38 44L38 45L44 45L44 44L43 44L43 41L42 41L42 40L45 40L45 39L44 39L44 38L45 38L45 36L44 36L44 34L45 34L45 33L44 33L44 34L43 34L43 33L41 33L41 34L39 34L39 33L35 33L35 34L34 34L34 32L35 32L35 31L37 31L37 32L39 32L39 31L38 31L38 30L35 30L35 31L34 31L34 30L33 30L33 29L35 29L35 28L36 28L36 29L38 29L38 28L36 28L36 27L38 27L38 25L42 25L42 26L43 26L43 27L41 27L41 28L39 28L39 30L40 30L40 32L43 32L43 31L44 31L44 32L45 32L45 31L44 31L44 30L45 30L45 27L44 27L44 26L45 26L45 25L44 25L44 22L45 22L45 21L44 21L44 20L43 20L43 19L44 19L44 18L45 18L45 17L44 17L44 16L43 16L43 14L45 14L45 13L43 13L43 11L44 11L44 10L45 10L45 9L44 9L44 8L43 8L43 9L44 9L44 10L42 10L42 8L41 8L41 12L42 12L42 14L39 14L39 15L37 15L37 14L38 14L38 13L37 13L37 12L38 12L38 11L39 11L39 10L40 10L40 8L39 8L39 10L38 10L38 8L37 8L37 6L36 6L36 7L35 7L35 6L34 6L34 5L37 5L37 3L36 3L36 1L37 1L37 0L36 0L36 1L35 1L35 4L32 4L32 3L31 3L31 2L33 2L33 3L34 3L34 2L33 2L33 1L34 1L34 0L32 0L32 1L31 1L31 0L28 0L28 1L26 1L26 0L25 0L25 1L24 1L24 0L23 0L23 3L22 3L22 2L21 2L21 1L22 1L22 0L21 0L21 1L19 1L19 2L18 2L18 0L16 0L16 1L13 1L13 0L12 0L12 1L11 1L11 0ZM28 1L28 2L30 2L30 1ZM10 2L10 4L11 4L11 5L12 5L12 4L11 4L11 2ZM17 2L17 4L18 4L18 6L17 6L17 7L18 7L18 6L19 6L19 7L20 7L20 5L19 5L19 4L20 4L20 3L21 3L21 4L22 4L22 3L21 3L21 2L19 2L19 4L18 4L18 2ZM23 3L23 4L24 4L24 3ZM27 3L27 4L26 4L26 5L27 5L27 7L26 7L26 6L25 6L25 8L27 8L27 9L26 9L26 10L29 10L29 12L27 12L27 11L25 11L25 12L24 12L24 11L20 11L20 12L19 12L19 13L15 13L15 12L14 12L14 11L13 11L13 12L14 12L14 13L15 13L15 15L16 15L16 17L11 17L11 18L13 18L13 19L15 19L15 20L14 20L14 21L15 21L15 20L16 20L16 19L15 19L15 18L16 18L16 17L17 17L17 20L19 20L19 18L21 18L21 19L20 19L20 20L23 20L23 18L24 18L24 16L25 16L25 15L26 15L26 18L25 18L25 19L24 19L24 20L26 20L26 22L28 22L28 23L26 23L26 26L27 26L27 27L26 27L26 28L25 28L25 29L26 29L26 30L25 30L25 33L24 33L24 34L17 34L17 36L18 36L18 35L19 35L19 36L20 36L20 35L22 35L22 36L23 36L23 35L25 35L25 37L26 37L26 38L25 38L25 39L26 39L26 38L28 38L28 39L29 39L29 38L30 38L30 40L26 40L26 42L24 42L24 41L20 41L20 42L24 42L24 44L25 44L25 43L27 43L27 42L28 42L28 41L31 41L31 40L32 40L32 41L34 41L34 42L35 42L35 37L36 37L36 36L39 36L39 34L38 34L38 35L36 35L36 34L35 34L35 36L34 36L34 35L33 35L33 32L34 32L34 31L33 31L33 32L32 32L32 31L30 31L30 30L27 30L27 29L31 29L31 28L32 28L32 29L33 29L33 27L32 27L32 25L33 25L33 26L35 26L35 27L34 27L34 28L35 28L35 27L36 27L36 26L35 26L35 24L36 24L36 23L34 23L34 22L36 22L36 21L34 21L34 20L36 20L36 19L32 19L32 21L31 21L31 22L32 22L32 23L30 23L30 22L29 22L29 20L26 20L26 18L27 18L27 19L28 19L28 17L29 17L29 16L30 16L30 15L31 15L31 16L32 16L32 17L33 17L33 18L35 18L35 17L33 17L33 16L36 16L36 17L37 17L37 16L36 16L36 14L35 14L35 13L36 13L36 11L38 11L38 10L35 10L35 9L37 9L37 8L35 8L35 7L34 7L34 6L33 6L33 7L34 7L34 8L32 8L32 6L31 6L31 5L30 5L30 4L31 4L31 3ZM28 4L28 5L29 5L29 6L28 6L28 8L29 8L29 6L30 6L30 9L29 9L29 10L31 10L31 9L32 9L32 8L31 8L31 6L30 6L30 5L29 5L29 4ZM21 5L21 8L24 8L24 5ZM22 6L22 7L23 7L23 6ZM19 8L19 9L18 9L18 11L19 11L19 9L20 9L20 10L24 10L24 9L20 9L20 8ZM32 10L32 11L33 11L33 12L34 12L34 11L35 11L35 10L34 10L34 11L33 11L33 10ZM30 11L30 12L31 12L31 13L30 13L30 14L28 14L28 13L27 13L27 12L26 12L26 13L25 13L25 14L23 14L23 15L25 15L25 14L26 14L26 15L27 15L27 16L29 16L29 15L30 15L30 14L32 14L32 16L33 16L33 15L34 15L34 14L32 14L32 12L31 12L31 11ZM21 12L21 14L20 14L20 13L19 13L19 14L17 14L17 15L19 15L19 16L18 16L18 18L19 18L19 16L20 16L20 17L23 17L23 16L22 16L22 15L21 15L21 14L22 14L22 13L23 13L23 12ZM26 13L26 14L27 14L27 15L28 15L28 14L27 14L27 13ZM19 14L19 15L20 15L20 16L21 16L21 15L20 15L20 14ZM39 15L39 17L38 17L38 18L39 18L39 20L41 20L41 19L40 19L40 17L41 17L41 18L42 18L42 19L43 19L43 18L42 18L42 17L43 17L43 16L42 16L42 17L41 17L41 16L40 16L40 15ZM5 16L5 17L6 17L6 16ZM2 17L2 21L1 21L1 22L2 22L2 23L1 23L1 24L2 24L2 23L3 23L3 21L4 21L4 20L3 20L3 19L5 19L5 20L7 20L7 19L6 19L6 18L3 18L3 17ZM29 18L29 19L31 19L31 18ZM5 21L5 24L8 24L8 21ZM21 21L21 24L24 24L24 21ZM32 21L32 22L34 22L34 21ZM37 21L37 24L40 24L40 21ZM6 22L6 23L7 23L7 22ZM17 22L17 23L18 23L18 22ZM22 22L22 23L23 23L23 22ZM38 22L38 23L39 23L39 22ZM9 23L9 24L10 24L10 23ZM28 23L28 24L27 24L27 25L28 25L28 24L29 24L29 26L28 26L28 27L27 27L27 28L29 28L29 26L31 26L31 25L32 25L32 24L33 24L33 23L32 23L32 24L31 24L31 25L30 25L30 23ZM42 24L42 25L43 25L43 24ZM6 25L6 26L5 26L5 27L4 27L4 28L5 28L5 27L6 27L6 28L9 28L9 30L8 30L8 29L5 29L5 30L7 30L7 31L5 31L5 32L7 32L7 31L9 31L9 32L8 32L8 33L9 33L9 34L8 34L8 35L9 35L9 34L12 34L12 33L10 33L10 30L11 30L11 29L13 29L13 30L14 30L14 29L16 29L16 31L15 31L15 32L16 32L16 33L13 33L13 34L16 34L16 33L18 33L18 32L17 32L17 31L18 31L18 30L19 30L19 31L20 31L20 30L19 30L19 29L23 29L23 30L24 30L24 29L23 29L23 28L21 28L21 27L23 27L23 26L24 26L24 27L25 27L25 26L24 26L24 25L23 25L23 26L21 26L21 27L20 27L20 26L18 26L18 28L19 28L19 29L16 29L16 28L14 28L14 29L13 29L13 25L12 25L12 26L11 26L11 27L10 27L10 26L9 26L9 25ZM0 26L0 28L1 28L1 26ZM6 26L6 27L8 27L8 26ZM11 27L11 28L12 28L12 27ZM30 27L30 28L31 28L31 27ZM41 28L41 29L40 29L40 30L41 30L41 31L42 31L42 30L41 30L41 29L42 29L42 28ZM43 29L43 30L44 30L44 29ZM0 30L0 31L1 31L1 32L0 32L0 34L2 34L2 33L3 33L3 31L1 31L1 30ZM21 30L21 31L22 31L22 33L23 33L23 31L22 31L22 30ZM26 30L26 31L27 31L27 32L26 32L26 33L27 33L27 32L29 32L29 33L28 33L28 35L27 35L27 34L25 34L25 35L26 35L26 36L27 36L27 37L28 37L28 36L30 36L30 38L32 38L32 39L34 39L34 38L33 38L33 37L34 37L34 36L33 36L33 37L32 37L32 36L30 36L30 35L29 35L29 33L30 33L30 34L32 34L32 32L30 32L30 31L27 31L27 30ZM13 31L13 32L14 32L14 31ZM1 32L1 33L2 33L2 32ZM19 32L19 33L21 33L21 32ZM4 34L4 35L1 35L1 36L0 36L0 37L1 37L1 36L3 36L3 37L5 37L5 34ZM40 35L40 36L41 36L41 35ZM8 36L8 37L9 37L9 36ZM43 36L43 37L41 37L41 40L42 40L42 38L43 38L43 37L44 37L44 36ZM21 37L21 40L24 40L24 37ZM37 37L37 40L40 40L40 37ZM10 38L10 39L11 39L11 40L10 40L10 41L9 41L9 42L11 42L11 41L12 41L12 39L11 39L11 38ZM17 38L17 39L18 39L18 38ZM22 38L22 39L23 39L23 38ZM38 38L38 39L39 39L39 38ZM15 41L15 42L16 42L16 41ZM41 41L41 42L40 42L40 43L42 43L42 41ZM44 42L44 43L45 43L45 42ZM9 43L9 44L11 44L11 43ZM21 43L21 44L23 44L23 43ZM29 43L29 44L30 44L30 45L32 45L32 44L31 44L31 43ZM34 44L34 45L35 45L35 44ZM36 44L36 45L37 45L37 44ZM0 0L0 7L7 7L7 0ZM1 1L1 6L6 6L6 1ZM2 2L2 5L5 5L5 2ZM38 0L38 7L45 7L45 0ZM39 1L39 6L44 6L44 1ZM40 2L40 5L43 5L43 2ZM0 38L0 45L7 45L7 38ZM1 39L1 44L6 44L6 39ZM2 40L2 43L5 43L5 40Z\" fill=\"#000000\"/></g></g></svg>\n",
    "as_uri": "otpauth://totp/Laravel%[email protected]?issuer=Laravel&label=john%40aom.com&secret=CREPRUYTMCBSCPEAG2LGKOFYOF25BL4A&algorithm=SHA1&digits=6",
    "as_string": "CREPRUYTMCBSCPEAG2LGKOFYOF25BL4A"
}
 

Request   

GET api/user-meta/2fa

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

user_id   string   

ID of the user. Example: 4

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 --request POST \
    "https://demo.aomlms.com/api/user/prepareTwoFactorAuth" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"user_id\": 4
}"
const url = new URL(
    "https://demo.aomlms.com/api/user/prepareTwoFactorAuth"
);

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

let body = {
    "user_id": 4
};

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

Example response (200):


{
    "as_qr_code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<svg xmlns=\"http://www.w3.org/2000/svg\" version=\"1.1\" width=\"200\" height=\"200\" viewBox=\"0 0 200 200\"><rect x=\"0\" y=\"0\" width=\"200\" height=\"200\" fill=\"#fefefe\"/><g transform=\"scale(4.444)\"><g transform=\"translate(0,0)\"><path fill-rule=\"evenodd\" d=\"M10 0L10 1L8 1L8 2L9 2L9 3L8 3L8 4L10 4L10 5L8 5L8 7L9 7L9 6L10 6L10 8L6 8L6 9L8 9L8 10L5 10L5 8L0 8L0 9L4 9L4 11L7 11L7 12L5 12L5 13L7 13L7 12L8 12L8 11L9 11L9 14L10 14L10 11L9 11L9 10L10 10L10 8L11 8L11 9L12 9L12 8L11 8L11 6L12 6L12 7L13 7L13 8L14 8L14 7L15 7L15 6L14 6L14 7L13 7L13 6L12 6L12 5L13 5L13 4L12 4L12 2L13 2L13 3L14 3L14 2L16 2L16 3L15 3L15 4L14 4L14 5L15 5L15 4L17 4L17 5L16 5L16 8L18 8L18 9L17 9L17 12L16 12L16 11L15 11L15 10L16 10L16 9L15 9L15 10L14 10L14 9L13 9L13 10L11 10L11 13L12 13L12 12L13 12L13 13L14 13L14 14L13 14L13 15L14 15L14 16L8 16L8 17L10 17L10 18L11 18L11 19L12 19L12 21L14 21L14 22L15 22L15 24L16 24L16 22L15 22L15 21L20 21L20 23L19 23L19 24L20 24L20 25L18 25L18 24L17 24L17 25L18 25L18 26L17 26L17 28L16 28L16 27L15 27L15 26L16 26L16 25L15 25L15 26L14 26L14 25L13 25L13 24L14 24L14 23L13 23L13 24L12 24L12 25L11 25L11 22L9 22L9 21L10 21L10 20L8 20L8 18L6 18L6 17L7 17L7 16L6 16L6 15L7 15L7 14L3 14L3 16L1 16L1 14L2 14L2 13L1 13L1 11L2 11L2 12L3 12L3 10L1 10L1 11L0 11L0 13L1 13L1 14L0 14L0 16L1 16L1 17L0 17L0 20L1 20L1 21L0 21L0 22L1 22L1 23L0 23L0 24L1 24L1 25L4 25L4 26L2 26L2 28L3 28L3 29L2 29L2 30L3 30L3 29L4 29L4 32L5 32L5 33L8 33L8 34L6 34L6 35L8 35L8 36L6 36L6 37L8 37L8 39L9 39L9 40L8 40L8 45L12 45L12 43L11 43L11 42L12 42L12 41L13 41L13 43L14 43L14 44L13 44L13 45L14 45L14 44L15 44L15 45L17 45L17 44L16 44L16 43L14 43L14 41L13 41L13 40L14 40L14 39L12 39L12 38L13 38L13 37L11 37L11 35L12 35L12 36L14 36L14 35L16 35L16 37L14 37L14 38L16 38L16 37L20 37L20 38L19 38L19 40L20 40L20 41L18 41L18 40L17 40L17 41L18 41L18 42L17 42L17 43L18 43L18 42L20 42L20 44L18 44L18 45L20 45L20 44L21 44L21 45L23 45L23 44L24 44L24 45L26 45L26 44L28 44L28 42L34 42L34 43L37 43L37 41L39 41L39 44L38 44L38 45L44 45L44 44L43 44L43 41L42 41L42 40L45 40L45 39L44 39L44 38L45 38L45 36L44 36L44 34L45 34L45 33L44 33L44 34L43 34L43 33L41 33L41 34L39 34L39 33L35 33L35 34L34 34L34 32L35 32L35 31L37 31L37 32L39 32L39 31L38 31L38 30L35 30L35 31L34 31L34 30L33 30L33 29L35 29L35 28L36 28L36 29L38 29L38 28L36 28L36 27L38 27L38 25L42 25L42 26L43 26L43 27L41 27L41 28L39 28L39 30L40 30L40 32L43 32L43 31L44 31L44 32L45 32L45 31L44 31L44 30L45 30L45 27L44 27L44 26L45 26L45 25L44 25L44 22L45 22L45 21L44 21L44 20L43 20L43 19L44 19L44 18L45 18L45 17L44 17L44 16L43 16L43 14L45 14L45 13L43 13L43 11L44 11L44 10L45 10L45 9L44 9L44 8L43 8L43 9L44 9L44 10L42 10L42 8L41 8L41 12L42 12L42 14L39 14L39 15L37 15L37 14L38 14L38 13L37 13L37 12L38 12L38 11L39 11L39 10L40 10L40 8L39 8L39 10L38 10L38 8L37 8L37 6L36 6L36 7L35 7L35 6L34 6L34 5L37 5L37 3L36 3L36 1L37 1L37 0L36 0L36 1L35 1L35 4L32 4L32 3L31 3L31 2L33 2L33 3L34 3L34 2L33 2L33 1L34 1L34 0L32 0L32 1L31 1L31 0L28 0L28 1L26 1L26 0L25 0L25 1L24 1L24 0L23 0L23 3L22 3L22 2L21 2L21 1L22 1L22 0L21 0L21 1L19 1L19 2L18 2L18 0L16 0L16 1L13 1L13 0L12 0L12 1L11 1L11 0ZM28 1L28 2L30 2L30 1ZM10 2L10 4L11 4L11 5L12 5L12 4L11 4L11 2ZM17 2L17 4L18 4L18 6L17 6L17 7L18 7L18 6L19 6L19 7L20 7L20 5L19 5L19 4L20 4L20 3L21 3L21 4L22 4L22 3L21 3L21 2L19 2L19 4L18 4L18 2ZM23 3L23 4L24 4L24 3ZM27 3L27 4L26 4L26 5L27 5L27 7L26 7L26 6L25 6L25 8L27 8L27 9L26 9L26 10L29 10L29 12L27 12L27 11L25 11L25 12L24 12L24 11L20 11L20 12L19 12L19 13L15 13L15 12L14 12L14 11L13 11L13 12L14 12L14 13L15 13L15 15L16 15L16 17L11 17L11 18L13 18L13 19L15 19L15 20L14 20L14 21L15 21L15 20L16 20L16 19L15 19L15 18L16 18L16 17L17 17L17 20L19 20L19 18L21 18L21 19L20 19L20 20L23 20L23 18L24 18L24 16L25 16L25 15L26 15L26 18L25 18L25 19L24 19L24 20L26 20L26 22L28 22L28 23L26 23L26 26L27 26L27 27L26 27L26 28L25 28L25 29L26 29L26 30L25 30L25 33L24 33L24 34L17 34L17 36L18 36L18 35L19 35L19 36L20 36L20 35L22 35L22 36L23 36L23 35L25 35L25 37L26 37L26 38L25 38L25 39L26 39L26 38L28 38L28 39L29 39L29 38L30 38L30 40L26 40L26 42L24 42L24 41L20 41L20 42L24 42L24 44L25 44L25 43L27 43L27 42L28 42L28 41L31 41L31 40L32 40L32 41L34 41L34 42L35 42L35 37L36 37L36 36L39 36L39 34L38 34L38 35L36 35L36 34L35 34L35 36L34 36L34 35L33 35L33 32L34 32L34 31L33 31L33 32L32 32L32 31L30 31L30 30L27 30L27 29L31 29L31 28L32 28L32 29L33 29L33 27L32 27L32 25L33 25L33 26L35 26L35 27L34 27L34 28L35 28L35 27L36 27L36 26L35 26L35 24L36 24L36 23L34 23L34 22L36 22L36 21L34 21L34 20L36 20L36 19L32 19L32 21L31 21L31 22L32 22L32 23L30 23L30 22L29 22L29 20L26 20L26 18L27 18L27 19L28 19L28 17L29 17L29 16L30 16L30 15L31 15L31 16L32 16L32 17L33 17L33 18L35 18L35 17L33 17L33 16L36 16L36 17L37 17L37 16L36 16L36 14L35 14L35 13L36 13L36 11L38 11L38 10L35 10L35 9L37 9L37 8L35 8L35 7L34 7L34 6L33 6L33 7L34 7L34 8L32 8L32 6L31 6L31 5L30 5L30 4L31 4L31 3ZM28 4L28 5L29 5L29 6L28 6L28 8L29 8L29 6L30 6L30 9L29 9L29 10L31 10L31 9L32 9L32 8L31 8L31 6L30 6L30 5L29 5L29 4ZM21 5L21 8L24 8L24 5ZM22 6L22 7L23 7L23 6ZM19 8L19 9L18 9L18 11L19 11L19 9L20 9L20 10L24 10L24 9L20 9L20 8ZM32 10L32 11L33 11L33 12L34 12L34 11L35 11L35 10L34 10L34 11L33 11L33 10ZM30 11L30 12L31 12L31 13L30 13L30 14L28 14L28 13L27 13L27 12L26 12L26 13L25 13L25 14L23 14L23 15L25 15L25 14L26 14L26 15L27 15L27 16L29 16L29 15L30 15L30 14L32 14L32 16L33 16L33 15L34 15L34 14L32 14L32 12L31 12L31 11ZM21 12L21 14L20 14L20 13L19 13L19 14L17 14L17 15L19 15L19 16L18 16L18 18L19 18L19 16L20 16L20 17L23 17L23 16L22 16L22 15L21 15L21 14L22 14L22 13L23 13L23 12ZM26 13L26 14L27 14L27 15L28 15L28 14L27 14L27 13ZM19 14L19 15L20 15L20 16L21 16L21 15L20 15L20 14ZM39 15L39 17L38 17L38 18L39 18L39 20L41 20L41 19L40 19L40 17L41 17L41 18L42 18L42 19L43 19L43 18L42 18L42 17L43 17L43 16L42 16L42 17L41 17L41 16L40 16L40 15ZM5 16L5 17L6 17L6 16ZM2 17L2 21L1 21L1 22L2 22L2 23L1 23L1 24L2 24L2 23L3 23L3 21L4 21L4 20L3 20L3 19L5 19L5 20L7 20L7 19L6 19L6 18L3 18L3 17ZM29 18L29 19L31 19L31 18ZM5 21L5 24L8 24L8 21ZM21 21L21 24L24 24L24 21ZM32 21L32 22L34 22L34 21ZM37 21L37 24L40 24L40 21ZM6 22L6 23L7 23L7 22ZM17 22L17 23L18 23L18 22ZM22 22L22 23L23 23L23 22ZM38 22L38 23L39 23L39 22ZM9 23L9 24L10 24L10 23ZM28 23L28 24L27 24L27 25L28 25L28 24L29 24L29 26L28 26L28 27L27 27L27 28L29 28L29 26L31 26L31 25L32 25L32 24L33 24L33 23L32 23L32 24L31 24L31 25L30 25L30 23ZM42 24L42 25L43 25L43 24ZM6 25L6 26L5 26L5 27L4 27L4 28L5 28L5 27L6 27L6 28L9 28L9 30L8 30L8 29L5 29L5 30L7 30L7 31L5 31L5 32L7 32L7 31L9 31L9 32L8 32L8 33L9 33L9 34L8 34L8 35L9 35L9 34L12 34L12 33L10 33L10 30L11 30L11 29L13 29L13 30L14 30L14 29L16 29L16 31L15 31L15 32L16 32L16 33L13 33L13 34L16 34L16 33L18 33L18 32L17 32L17 31L18 31L18 30L19 30L19 31L20 31L20 30L19 30L19 29L23 29L23 30L24 30L24 29L23 29L23 28L21 28L21 27L23 27L23 26L24 26L24 27L25 27L25 26L24 26L24 25L23 25L23 26L21 26L21 27L20 27L20 26L18 26L18 28L19 28L19 29L16 29L16 28L14 28L14 29L13 29L13 25L12 25L12 26L11 26L11 27L10 27L10 26L9 26L9 25ZM0 26L0 28L1 28L1 26ZM6 26L6 27L8 27L8 26ZM11 27L11 28L12 28L12 27ZM30 27L30 28L31 28L31 27ZM41 28L41 29L40 29L40 30L41 30L41 31L42 31L42 30L41 30L41 29L42 29L42 28ZM43 29L43 30L44 30L44 29ZM0 30L0 31L1 31L1 32L0 32L0 34L2 34L2 33L3 33L3 31L1 31L1 30ZM21 30L21 31L22 31L22 33L23 33L23 31L22 31L22 30ZM26 30L26 31L27 31L27 32L26 32L26 33L27 33L27 32L29 32L29 33L28 33L28 35L27 35L27 34L25 34L25 35L26 35L26 36L27 36L27 37L28 37L28 36L30 36L30 38L32 38L32 39L34 39L34 38L33 38L33 37L34 37L34 36L33 36L33 37L32 37L32 36L30 36L30 35L29 35L29 33L30 33L30 34L32 34L32 32L30 32L30 31L27 31L27 30ZM13 31L13 32L14 32L14 31ZM1 32L1 33L2 33L2 32ZM19 32L19 33L21 33L21 32ZM4 34L4 35L1 35L1 36L0 36L0 37L1 37L1 36L3 36L3 37L5 37L5 34ZM40 35L40 36L41 36L41 35ZM8 36L8 37L9 37L9 36ZM43 36L43 37L41 37L41 40L42 40L42 38L43 38L43 37L44 37L44 36ZM21 37L21 40L24 40L24 37ZM37 37L37 40L40 40L40 37ZM10 38L10 39L11 39L11 40L10 40L10 41L9 41L9 42L11 42L11 41L12 41L12 39L11 39L11 38ZM17 38L17 39L18 39L18 38ZM22 38L22 39L23 39L23 38ZM38 38L38 39L39 39L39 38ZM15 41L15 42L16 42L16 41ZM41 41L41 42L40 42L40 43L42 43L42 41ZM44 42L44 43L45 43L45 42ZM9 43L9 44L11 44L11 43ZM21 43L21 44L23 44L23 43ZM29 43L29 44L30 44L30 45L32 45L32 44L31 44L31 43ZM34 44L34 45L35 45L35 44ZM36 44L36 45L37 45L37 44ZM0 0L0 7L7 7L7 0ZM1 1L1 6L6 6L6 1ZM2 2L2 5L5 5L5 2ZM38 0L38 7L45 7L45 0ZM39 1L39 6L44 6L44 1ZM40 2L40 5L43 5L43 2ZM0 38L0 45L7 45L7 38ZM1 39L1 44L6 44L6 39ZM2 40L2 43L5 43L5 40Z\" fill=\"#000000\"/></g></g></svg>\n",
    "as_uri": "otpauth://totp/Laravel%[email protected]?issuer=Laravel&label=john%40aom.com&secret=CREPRUYTMCBSCPEAG2LGKOFYOF25BL4A&algorithm=SHA1&digits=6",
    "as_string": "CREPRUYTMCBSCPEAG2LGKOFYOF25BL4A"
}
 

Request   

POST api/user/prepareTwoFactorAuth

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

user_id   integer   

ID of the user. Example: 4

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 --request POST \
    "https://demo.aomlms.com/api/user/confirmTwoFactorAuth" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"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"
);

const 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,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "status": "success",
    "message": "Two Factor Authentication activated"
}
 

Request   

POST api/user/confirmTwoFactorAuth

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

user_id   integer   

ID of the user. Example: 4

secretCode   number   

secret code from users authenticator app. Example: 250987

qrCode   string    \n<\/g><\/g><\/svg>\n" data-component="body">

QR code generated by prepareTwoFactor method. Example: <?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   string   

String code generated by prepareTwoFactor method. Example: CREPRUYTMCBSCPEAG2LGKOFYOF25BLR3E

Disable 2fa

To disables Two factor authentication feature in system for specified user, you need to use this request. (See parameters)

Example request:
curl --request POST \
    "https://demo.aomlms.com/api/user/disableTwoFactorAuth" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"user_id\": 4
}"
const url = new URL(
    "https://demo.aomlms.com/api/user/disableTwoFactorAuth"
);

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

let body = {
    "user_id": 4
};

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

Example response (200):


{
    "message": "2factor authentication disabled successfully",
    "qrcode": null,
    "stringcode": null
}
 

Request   

POST api/user/disableTwoFactorAuth

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

user_id   integer   

ID of the user. Example: 4

Resend New Account Email

Send New Account Created email again.

Example request:
curl --request POST \
    "https://demo.aomlms.com/api/email/resendNewAccountEmail" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"user_id\": 4
}"
const url = new URL(
    "https://demo.aomlms.com/api/email/resendNewAccountEmail"
);

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

let body = {
    "user_id": 4
};

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

Example response (200):


[
    {
        "status": "success",
        "message": "New Password is created and New Account Email Sent."
    }
]
 

Request   

POST api/email/resendNewAccountEmail

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

user_id   integer   

ID of the user. Example: 4

Accredible

It allows users to receive digital credentials

Validate Accredible Key

Validates whether the given key is correct.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/accredible/validate-key/3cc557a91d67378f7fc29fed973e5c94" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/accredible/validate-key/3cc557a91d67378f7fc29fed973e5c94"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "Success",
    "status": "success"
}
 

Request   

GET api/accredible/validate-key/{key}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

key   string   

Key of the accredible needs to be validated. Example: 3cc557a91d67378f7fc29fed973e5c94

Accredible Groups Lookup

Retrieves all the accredible groups. Helps while showing group names in dropdown elements.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/accredible/group/lookup" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/accredible/group/lookup"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "isEnabled": true,
    "data": [
        {
            "id": 353767,
            "name": "group_aom_course"
        },
        {
            "id": 353282,
            "name": "intro-ce"
        },
        {
            "id": 352594,
            "name": "aom"
        }
    ]
}
 

Request   

GET api/accredible/group/lookup

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

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 --request POST \
    "https://demo.aomlms.com/api/announcement" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"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"
);

const 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,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "id": 1,
    "message": "Announcement Created Successfully"
}
 

Request   

POST api/announcement

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

heading   string   

Heading of the announcement. Example: New Announcement

content   string   

Content(Body) for the announcement that students will see. Example: This is for test purpose

expiry   date  optional  

Till what date, the announcement is active for users. Example: 2020-08-05

sending_rules   string   

Rule for sending announcement, based on this rule announcement will be sent to all or specific users or users of specific courses. Sending rules options: all, specific_users or specific_course_users. Example: all

user_ids   string[]  optional  

Id of the users which needs to receive announcement specifically (required if sending_rules set as student wise).

course_ids   string[]  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 --request GET \
    --get "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" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/announcement/tabularlist"
);

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

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "records": [
        {
            "id": 1,
            "heading": "New Announcement",
            "author": "Aom Staff",
            "content": "This is for test purpose",
            "created_at": "Aug 11, 2020 01:25 PM",
            "sent_to": "All"
        }
    ]
}
 

Request   

GET api/announcement/tabularlist

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

page_size   string   

The number of the items you want for a page. Example: 50

page_number   string   

Current page number in pagination. Example: 1

order_by   string  optional  

For ordering items based on columns provided in JSON format. Example: {"colName":"created_at", "direction": "desc"}}

search_param   string  optional  

For searching items based on field names. Example: {"heading":""}

Update Announcement

Updates the details of a specified announcement. (See parameters) Announcement can be used to send out messages to students.

Example request:
curl --request PUT \
    "https://demo.aomlms.com/api/announcement/2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"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"
);

const 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,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Announcement Updated Successfully"
}
 

Request   

PUT api/announcement/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the announcement needs to be updated. Example: 2

Body Parameters

heading   string   

Heading of the announcement. Example: New Announcement

content   string   

Content(Body) for the announcement that students will see. Example: This is for test purpose

expiry   date  optional  

Till what date, the announcement is active for users. Example: 2020-08-05

sending_rules   string   

Rule for sending announcement, based on this rule announcement will be sent to all or specific users or users of specific courses. Sending rules options: all, specific_users or specific_course_users. Example: all

user_ids   string[]  optional  

Id of the users which needs to receive announcement specifically (required if sending_rules set as student wise).

course_ids   string[]  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 --request GET \
    --get "https://demo.aomlms.com/api/announcement/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/announcement/1"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 1,
    "heading": "New Announcement",
    "content": "This is for test purpose",
    "sending_rules": "all",
    "expiry": "2020-08-05"
}
 

Request   

GET api/announcement/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the announcement you want to fetch the details of. Example: 1

Delete Announcement

To delete an announcement, you need to use this request. Returns number of announcement deleted. (See Response)

Example request:
curl --request POST \
    "https://demo.aomlms.com/api/announcement/delete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"delete_ids\": [
        1,
        12,
        15
    ]
}"
const url = new URL(
    "https://demo.aomlms.com/api/announcement/delete"
);

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

let body = {
    "delete_ids": [
        1,
        12,
        15
    ]
};

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

Example response (200):


{
    "message": "3 announcement(s) deleted "
}
 

Request   

POST api/announcement/delete

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

delete_ids   string[]   

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 --request GET \
    --get "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" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/student/announcements"
);

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

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "avatar": "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"40\" height=\"40\" viewBox=\"0 0 40 40\"><circle cx=\"20\" cy=\"20\" r=\"20\" stroke=\"background\" stroke-width=\"0\" fill=\"#00BCD4\" /><text x=\"20\" y=\"20\" font-size=\"14\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">AS</text></svg>",
    "recordsTotal": 1,
    "recordsFiltered": 0,
    "records": []
}
 

Request   

GET api/student/announcements

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

page_size   string   

The number of the items you want for a page. Example: 5

page_number   string   

Current page number in pagination. Example: 1

order_by   string  optional  

For ordering items based on columns provided in JSON format. Example: {"colName":"created_at","direction":"desc"}

search_param   string  optional  

For searching items based on field names. Example: {"heading":""}

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 --request GET \
    --get "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" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/modules/assignment"
);

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

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "recordsTotal": 2,
    "recordsFiltered": 2,
    "records": [
        {
            "id": 4,
            "name": "assign",
            "slug": "assign",
            "type": "assignment",
            "submissionType": "file",
            "totalPoints": 50,
            "icon": "<i class=\"el-icon-edit-outline\"></i>",
            "author": "Aom Staff",
            "created_at": "Aug 10, 2020 06:43 AM"
        },
        {
            "id": 2,
            "name": "assignment 1",
            "slug": "assignment-1",
            "type": "assignment",
            "submissionType": "text",
            "totalPoints": 100,
            "icon": "<i class=\"el-icon-edit-outline\"></i>",
            "author": "Aom Staff",
            "created_at": "Aug 09, 2020 07:25 AM"
        }
    ]
}
 

Request   

GET api/modules/assignment

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

page_size   string   

The number of the items you want for a page. Example: 50

page_number   string   

Current page number in pagination. Example: 1

order_by   string  optional  

For ordering items based on columns provided in JSON format. Example: {"colName":"created_at", "direction": "desc"}}

search_param   string  optional  

For searching items based on field names. Example: {"associatedCourse":"","moduleName":""}

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 --request POST \
    "https://demo.aomlms.com/api/modules/assignment" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"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"
);

const 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,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "id": 10,
    "message": "Module saved successfully"
}
 

Request   

POST api/modules/assignment

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

name   string   

Name of the assignment module. Example: Essay on LMS

content   string   

Content for the assignment modules that students will see. Example: A brief description

submission_type   string   

Type for the assignment module(file based or text based). Submission type options: text or file. Example: file

totalPoints   integer  optional  

Student will get this number if they complete the assignment. Example: 25

allowed_filetypes   string  optional  

Allowed file types that will be submitted by the students when the submission_type is file(required). Example: ["image", "pdf"]

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 --request PUT \
    "https://demo.aomlms.com/api/modules/assignment/{id}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"name\": \"Essay on LMS\",
    \"content\": \"An Updated brief description\",
    \"submission_type\": \"file\",
    \"totalPoints\": 25,
    \"allowed_filetypes\": \"[\\\"image\\\", \\\"pdf\\\"]\"
}"
const url = new URL(
    "https://demo.aomlms.com/api/modules/assignment/{id}"
);

const 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,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Module updated successfully"
}
 

Request   

PUT api/modules/assignment/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

name   string   

Name of the assignment module. Example: Essay on LMS

content   string   

Content for the assignment modules that students will see. Example: An Updated brief description

submission_type   string   

Type for the assignment module(file based or text based). Submission type options: text or file. Example: file

totalPoints   integer  optional  

Student will get this number if they complete the assignment. Example: 25

allowed_filetypes   string  optional  

Allowed file types that will be submitted by the students when the submission_type is file(required). Example: ["image", "pdf"]

Retrieve Assignment Modules

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

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/modules/assignment/2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/modules/assignment/2"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "name": "assignment 1",
    "slug": "assignment-1",
    "content": "Hola",
    "totalPoints": 100,
    "submission_type": "text",
    "allowed_filetypes": [
        ""
    ]
}
 

Request   

GET api/modules/assignment/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the assignment module you want to fetch the details of. Example: 2

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 --request GET \
    --get "https://demo.aomlms.com/api/module/assignment/details?registrationId=1&moduleId=9" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/module/assignment/details"
);

const params = {
    "registrationId": "1",
    "moduleId": "9",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "name": "Essay on LMS",
    "slug": "essay-on-lms",
    "content": "A brief description",
    "courseName": "course 1",
    "courseSlug": "http://localhost:8000/course/course-1",
    "totalPoints": 25,
    "submissionType": "text",
    "maxUploadSize": 5,
    "min_time_spent": 0,
    "allowedFileTypes": ".",
    "otherModules": [
        {
            "module_id": 1,
            "name": "test",
            "slug": "test",
            "type": "text",
            "icon": "<i class=\"el-icon-tickets\"></i>",
            "is_locked": false,
            "lock_reason": "",
            "is_dripped": false,
            "drip_message": "",
            "is_current": false,
            "status_row_id": 1,
            "status": "Completed",
            "started_on": "2020-08-03T10:02:33.000000Z",
            "completed_on": "2020-08-03T10:02:41.000000Z",
            "last_accessed_on": "8 hours ago",
            "total_time_spent": {
                "hours": 0,
                "minutes": 0,
                "seconds": 6,
                "totalSeconds": 6
            },
            "completion_percentage": 100,
            "no_of_times_accessed": 3
        },
        {
            "module_id": 4,
            "name": "assign",
            "slug": "assign",
            "type": "assignment",
            "icon": "<i class=\"el-icon-edit-outline\"></i>",
            "is_locked": false,
            "lock_reason": "",
            "is_dripped": false,
            "drip_message": "",
            "is_current": true,
            "status_row_id": -1,
            "status": "Not Started",
            "started_on": "",
            "completed_on": "",
            "last_accessed_on": "Never",
            "total_time_spent": "",
            "points_awarded": "",
            "completion_percentage": 0,
            "no_of_times_accessed": 0
        },
        {
            "module_id": 7,
            "name": "First-quiz",
            "slug": "first-quiz",
            "type": "quiz",
            "icon": "<i class=\"el-icon-discover\"></i>",
            "is_locked": false,
            "lock_reason": "",
            "is_dripped": false,
            "drip_message": "",
            "is_current": false,
            "status_row_id": -1,
            "status": "Not Started",
            "started_on": "",
            "completed_on": "",
            "last_accessed_on": "Never",
            "total_time_spent": "",
            "points_awarded": "",
            "completion_percentage": 0,
            "no_of_times_accessed": 0
        },
        {
            "module_id": 9,
            "name": "My-video-lesson",
            "slug": "my-video-lesson",
            "type": "video",
            "icon": "<i class=\"el-icon-video-play\"></i>",
            "is_locked": false,
            "lock_reason": "",
            "is_dripped": false,
            "drip_message": "",
            "is_current": false,
            "status_row_id": 4,
            "status": "In Progress",
            "started_on": "2020-08-10T20:04:14.000000Z",
            "completed_on": null,
            "last_accessed_on": "6 hours ago",
            "total_time_spent": {
                "hours": 0,
                "minutes": 0,
                "seconds": 0,
                "totalSeconds": null
            },
            "completion_percentage": 0,
            "no_of_times_accessed": 1
        },
        {
            "module_id": 10,
            "name": "Essay on LMS",
            "slug": "essay-on-lms",
            "type": "assignment",
            "icon": "<i class=\"el-icon-edit-outline\"></i>",
            "is_locked": false,
            "lock_reason": "",
            "is_dripped": false,
            "drip_message": "",
            "is_current": false,
            "status_row_id": 5,
            "status": "Completed",
            "started_on": "2020-08-11T02:47:32.000000Z",
            "completed_on": "2020-08-11T02:47:32.000000Z",
            "last_accessed_on": "46 seconds ago",
            "total_time_spent": {
                "hours": 0,
                "minutes": 0,
                "seconds": 0,
                "totalSeconds": null
            },
            "completion_percentage": 100,
            "no_of_times_accessed": 1
        }
    ],
    "launchCheck": {
        "canbeLaunched": true,
        "errTitle": "",
        "errDesc": ""
    },
    "prevSlug": "my-video-lesson",
    "nextSlug": "",
    "status": "Completed",
    "statusRowId": 5,
    "timeSpent": null,
    "prevSubmission": []
}
 

Request   

GET api/module/assignment/details

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

registrationId   string   

ID of the course Registration for which this module is attached to. Example: 1

moduleId   string   

ID of the assignment module. Example: 9

Retrieve Assignment Submissions

Retrieves the submissions of the assigment the student have given. Helps in grading a student. (See Response)

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/module/assignment/submissions?statusRowId=7" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/module/assignment/submissions"
);

const params = {
    "statusRowId": "7",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "courseId": 1,
    "courseName": "course 1",
    "assignmentName": "assign",
    "status": "Submitted",
    "content": "Desc",
    "totalPoints": 50,
    "submissions": [
        {
            "id": 1,
            "file_path": "https://aom-uploads-test.s3.us-west-2.amazonaws.com/assignments/aom-sample-bulkupload_1597042007.csv",
            "student_message": null,
            "instructor_message": null,
            "points_awarded": null,
            "evaluated_by": "",
            "submitted_on": "Aug 10, 2020",
            "evaluated_on": ""
        }
    ]
}
 

Request   

GET api/module/assignment/submissions

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

statusRowId   string   

ID of the Module status of the current assignment. Example: 7

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 --request POST \
    "https://demo.aomlms.com/api/module/assignment/submit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"statusRowId\": \"7\",
    \"submission\": \"This is text based assignment submission\"
}"
const url = new URL(
    "https://demo.aomlms.com/api/module/assignment/submit"
);

const 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,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Assignment submitted successfully"
}
 

Request   

POST api/module/assignment/submit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

statusRowId   required  optional  

ID of the Module status of the current assignment. Example: 7

submission   required  optional  

Submission data(file or text). Example: This is text based assignment submission

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 --request POST \
    "https://demo.aomlms.com/api/module/assignment/upload" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"file\": \"binary\"
}"
const url = new URL(
    "https://demo.aomlms.com/api/module/assignment/upload"
);

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

let body = {
    "file": "binary"
};

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

Example response (200):


{
    "s3_url": "https://s3.aws.com/wTsycTYRCLKIUVXXIYFYVXBXIXUGIXB"
}
 

Request   

POST api/module/assignment/upload

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

file   required  optional  

File to be uploaded for current assignment. Example: binary

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 --request POST \
    "https://demo.aomlms.com/api/module/assignment/evaluate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"statusRowId\": \"7\",
    \"evaluation\": \"{instructorMessage : \'Assignment looks good\', pointsAwarded: \'50\', isAccepted : true }\"
}"
const url = new URL(
    "https://demo.aomlms.com/api/module/assignment/evaluate"
);

const 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,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Assignment evaluated successfully"
}
 

Request   

POST api/module/assignment/evaluate

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

statusRowId   required  optional  

ID of the Module status of the current assignment. Example: 7

evaluation   required  optional  

Evaluation data by the Instructor(Completed or not). Example: {instructorMessage : 'Assignment looks good', pointsAwarded: '50', isAccepted : true }

Audit Logs

It allows you to track the user activity in the LMS.

Tabular List

Retrieves all the audit log activities in a tabular list format with pagination mode. You can apply filter using search_param via user_id, activityName or dates

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/audit-activities?page_size=10&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C%22direction%22%3A%22desc%22%7D&search_param=%7B%22performed_by%22%3A%22Aom+Staff%22%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/audit-activities"
);

const params = {
    "page_size": "10",
    "page_number": "1",
    "order_by": "{"colName":"created_at","direction":"desc"}",
    "search_param": "{"performed_by":"Aom Staff"}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "records": [
        {
            "performed_by": "Aom Staff",
            "effect_on": "User",
            "subject": "User",
            "action": "Created",
            "created_at": "Aug 06, 2020 07:20 AM",
            "details": []
        }
    ],
    "performedOnList": []
}
 

Request   

GET api/audit-activities

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

page_size   string   

The number of the user you want for a page. Example: 10

page_number   string   

Current page number in pagination. Example: 1

order_by   string  optional  

For ordering items based on columns provided in JSON format. Example: {"colName":"created_at","direction":"desc"}

search_param   string  optional  

For searching items based on performed_by, user and dates. Example: {"performed_by":"Aom Staff"}

Audit Activity Lookup

Retrieves all the activity for the user. Helps showing options in dropdowns elements

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/audit-activities/verb/lookup" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/audit-activities/verb/lookup"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "db_value": "login",
        "display_value": "LOGIN"
    },
    {
        "db_value": "created",
        "display_value": "CREATED"
    },
    {
        "db_value": "updated",
        "display_value": "UPDATED"
    },
    {
        "db_value": "deleted",
        "display_value": "DELETED"
    }
]
 

Request   

GET api/audit-activities/verb/lookup

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Badge

Endpoints for handling and managing Gamification badges

Retrieve Badge details

Retrieves the details of badges. (See Parameters)

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/badges/tabularlist?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%22title%22%3A%22%22%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/badges/tabularlist"
);

const params = {
    "page_size": "50",
    "page_number": "1",
    "order_by": "{"colName":"created_at","direction":"desc"}",
    "search_param": "{"title":""}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "records": [
        {
            "id": 1,
            "title": "1",
            "badgeIconUrl": "/images/badges/Badge_1.png",
            "points": 1
        }
    ]
}
 

Request   

GET api/badges/tabularlist

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

page_size   string   

The number of the items you want for a page. Example: 50

page_number   string   

Current page number in pagination. Example: 1

order_by   string  optional  

For ordering items based on columns provided in JSON format. Example: {"colName":"created_at","direction":"desc"}

search_param   string  optional  

For searching items based on title. Example: {"title":""}

Create Badge

Create a new badge.

Example request:
curl --request POST \
    "https://demo.aomlms.com/api/badge/create?title=Gold&points=100&badgeIconUrl=https%3A%2F%2Fapi.example.com%2Fabc.jpg&defaultIconUrl=https%3A%2F%2Fapi.example.com%2Fabc.jpg&organizationId=AOM1234" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/badge/create"
);

const params = {
    "title": "Gold",
    "points": "100",
    "badgeIconUrl": "https://api.example.com/abc.jpg",
    "defaultIconUrl": "https://api.example.com/abc.jpg",
    "organizationId": "AOM1234",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):


{
    "id": 3,
    "message": "Badge created successfully"
}
 

Request   

POST api/badge/create

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

title   string   

string The title of the badge. Example: Gold

points   integer  optional  

The points associated with the badge. Example: 100

badgeIconUrl   string   

string The URL to the badge icon image. Example: https://api.example.com/abc.jpg

defaultIconUrl   string  optional  

nullable The URL to the default icon image for the badge. Example: https://api.example.com/abc.jpg

organizationId   string  optional  

nullable string The identifier of the organization to which the badge belongs. Example: AOM1234

Retrieve default Badges details

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/badges/defaultBadgeLookUp" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/badges/defaultBadgeLookUp"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "value": "Badge 1",
        "url": "/images/badges/Badge_1.png"
    },
    {
        "value": "Badge 2",
        "url": "/images/badges/Badge_2.png"
    },
    {
        "value": "Badge 3",
        "url": "/images/badges/Badge_3.png"
    },
    {
        "value": "Badge 4",
        "url": "/images/badges/Badge_4.png"
    }
]
 

Request   

GET api/badges/defaultBadgeLookUp

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Retrieve details of specific badge

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/badge/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/badge/1"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 1,
    "title": "Gold",
    "points": 1,
    "organizationId": "97852067",
    "badgeIconUrl": "/images/badges/Badge_1.png"
}
 

Request   

GET api/badge/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the badge needs to be retrieved. Example: 1

Update Badge

Update the existing badge.

Example request:
curl --request PUT \
    "https://demo.aomlms.com/api/badge/3?title=Gold&points=100&badgeIconUrl=https%3A%2F%2Fapi.example.com%2Fabc.jpg&defaultIconUrl=https%3A%2F%2Fapi.example.com%2Fabc.jpg&organizationId=AOM1234" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/badge/3"
);

const params = {
    "title": "Gold",
    "points": "100",
    "badgeIconUrl": "https://api.example.com/abc.jpg",
    "defaultIconUrl": "https://api.example.com/abc.jpg",
    "organizationId": "AOM1234",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):


{
    "id": 3,
    "message": "Badge updated successfully"
}
 

Request   

PUT api/badge/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   integer   

The ID of the badge to be updated. Example: 3

Query Parameters

title   string   

string The title of the badge. Example: Gold

points   integer  optional  

The points associated with the badge. Example: 100

badgeIconUrl   string   

string The URL to the badge icon image. Example: https://api.example.com/abc.jpg

defaultIconUrl   string  optional  

nullable The URL to the default icon image for the badge. Example: https://api.example.com/abc.jpg

organizationId   string  optional  

nullable string The identifier of the organization to which the badge belongs. Example: AOM1234

Delete badge

Delete a badge by ID.

Example request:
curl --request POST \
    "https://demo.aomlms.com/api/badge/delete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/badge/delete"
);

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

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

Example response (200):


{
    "message": "1 badge(s) deleted. 0 badge(s) not deleted as they are assigned to users. 0 badge(s) not deleted as they are used in gamification events."
}
 

Request   

POST api/badge/delete

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string  optional  

array required The ID of the badge to be deleted. Example: [1, 2, 3]

Categories

Categories represents Course category, Product category, Question category. Helps performimg operations in all these models.

Product Category Lookup

Retrieves all the categories of the product user has ever created. This request helps in showing all product categories in form elements like dropdown, etc. Returns ID and name of the product category.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/categories/product/lookup" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/categories/product/lookup"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 4,
        "name": "Question-cat"
    }
]
 

Request   

GET api/categories/product/lookup

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

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 --request GET \
    --get "https://demo.aomlms.com/api/categories/course/lookup" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/categories/course/lookup"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 1,
        "name": "Category-1"
    }
]
 

Request   

GET api/categories/course/lookup

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Module category Lookup

Retrieves all the categories of the module user has ever created. This request helps in showing all module categories in form elements like dropdown, etc. Returns ID and name of the module category.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/categories/module/lookup" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/categories/module/lookup"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 1,
        "name": "Category-1"
    }
]
 

Request   

GET api/categories/module/lookup

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Question Category Lookup

Retrieves all the categories of the question user has ever created. This request helps in showing all question categories in form elements like dropdown, etc. Returns ID and name of the question category.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/categories/question/lookup" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/categories/question/lookup"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 4,
        "name": "Question-cat"
    }
]
 

Request   

GET api/categories/question/lookup

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

User Category Lookup

Retrieves all the categories of the user user has ever created. This request helps in showing all user categories in form elements like dropdown, etc. Returns ID and name of the user category.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/categories/user/lookup" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/categories/user/lookup"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 4,
        "name": "User-cat"
    }
]
 

Request   

GET api/categories/user/lookup

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

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 --request GET \
    --get "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" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/coursecategory/tabularlist"
);

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

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "recordsTotal": 4,
    "recordsFiltered": 3,
    "records": [
        {
            "id": 3,
            "name": "superman_postman",
            "author": "Client Admin",
            "count": 0,
            "created_at": "Aug 10, 2020 12:43 PM"
        },
        {
            "id": 2,
            "name": "category-new",
            "author": "Aom Staff",
            "count": 0,
            "created_at": "Aug 10, 2020 12:37 PM"
        },
        {
            "id": 1,
            "name": "Category-1",
            "author": "Aom Staff",
            "count": 1,
            "created_at": "Aug 09, 2020 06:20 PM"
        }
    ]
}
 

Request   

GET api/coursecategory/tabularlist

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

page_size   string   

The number of the items you want for a page. Example: 9

page_number   string   

Current page number in pagination. Example: 1

order_by   string  optional  

For ordering items based on columns provided in JSON format. Example: {"colName":"created_at", "direction": "desc"}}

search_param   string  optional  

For searching items based on category name. Example: {"categoryName":""}

Module Category Tabular List

Returns all the module categories in a tabular list format in paginated mode. You can apply filter using search_param via categoryName.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/modulecategory/tabularlist?page_size=9&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22categoryName%22%3A%22%22%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/modulecategory/tabularlist"
);

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

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "recordsTotal": 2,
    "recordsFiltered": 1,
    "records": [
        {
            "id": 2,
            "name": "module memberships",
            "author": "Aom Staff",
            "count": 1,
            "created_at": "May 10, 2022 03:39 AM"
        }
    ]
}
 

Request   

GET api/modulecategory/tabularlist

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

page_size   string   

The number of the items you want for a page. Example: 9

page_number   string   

Current page number in pagination. Example: 1

order_by   string  optional  

For ordering items based on columns provided in JSON format. Example: {"colName":"created_at", "direction": "desc"}}

search_param   string  optional  

For searching items based on category name. Example: {"categoryName":""}

Product Category Tabular List

Returns all the product categories in a tabular list format in paginated mode. You can apply filter using search_param via categoryName.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/productcategory/tabularlist?page_size=9&page_number=1&order_by=%7B%22colName%22%3A%22created_at%22%2C+%22direction%22%3A+%22desc%22%7D%7D&search_param=%7B%22categoryName%22%3A%22%22%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/productcategory/tabularlist"
);

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

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "recordsTotal": 4,
    "recordsFiltered": 3,
    "records": [
        {
            "id": 3,
            "name": "superman_postman",
            "author": "Client Admin",
            "count": 0,
            "created_at": "Aug 10, 2020 12:43 PM"
        },
        {
            "id": 2,
            "name": "category-new",
            "author": "Aom Staff",
            "count": 0,
            "created_at": "Aug 10, 2020 12:37 PM"
        },
        {
            "id": 1,
            "name": "Category-1",
            "author": "Aom Staff",
            "count": 1,
            "created_at": "Aug 09, 2020 06:20 PM"
        }
    ]
}
 

Request   

GET api/productcategory/tabularlist

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

page_size   string   

The number of the items you want for a page. Example: 9

page_number   string   

Current page number in pagination. Example: 1

order_by   string  optional  

For ordering items based on columns provided in JSON format. Example: {"colName":"created_at", "direction": "desc"}}

search_param   string  optional  

For searching items based on category name. Example: {"categoryName":""}

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 --request GET \
    --get "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" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/questioncategory/tabularlist"
);

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

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "recordsTotal": 4,
    "recordsFiltered": 1,
    "records": [
        {
            "id": 4,
            "name": "Question-cat",
            "author": "Aom Staff",
            "count": 0,
            "created_at": "Aug 10, 2020 01:58 PM"
        }
    ]
}
 

Request   

GET api/questioncategory/tabularlist

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

page_size   string   

The number of the items you want for a page. Example: 9

page_number   string   

Current page number in pagination. Example: 1

order_by   string  optional  

For ordering items based on columns provided in JSON format. Example: {"colName":"created_at", "direction": "desc"}}

search_param   string  optional  

For searching items based on category name. Example: {"categoryName":""}

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 --request POST \
    "https://demo.aomlms.com/api/category/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"category_name\": \"category-new\",
    \"categoryType\": \"course\"
}"
const url = new URL(
    "https://demo.aomlms.com/api/category/create"
);

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

let body = {
    "category_name": "category-new",
    "categoryType": "course"
};

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

Example response (200):


{
    "message": "Category Created Successfully"
}
 

Request   

POST api/category/create

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

category_name   string   

Name of the course category. Example: category-new

categoryType   string   

Type for the category that is being created. Type options: course, question, product and module. Example: course

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 --request PUT \
    "https://demo.aomlms.com/api/category/3" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"category_name\": \"category-new-updated\"
}"
const url = new URL(
    "https://demo.aomlms.com/api/category/3"
);

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

let body = {
    "category_name": "category-new-updated"
};

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

Example response (200):


{
    "message": "Category Updated Successfully"
}
 

Request   

PUT api/category/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the category. Example: 3

Body Parameters

category_name   string   

Name of the category. Example: category-new-updated

Retrieve Category

Retrieves category details for specified category ID.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/category/3" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/category/3"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "id": 3,
    "name": "superman_postman",
    "type": "course",
    "created_by": 2,
    "updated_by": null,
    "deleted_by": null,
    "created_at": "2020-08-10 12:43:12",
    "updated_at": "2020-08-10 12:56:37",
    "deleted_at": null
}
 

Request   

GET api/category/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the category. Example: 3

Delete Category

To delete a category, you need to use this request. Returns number of category deleted(if multiple selected)

Example request:
curl --request POST \
    "https://demo.aomlms.com/api/category/delete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"delete_ids\": [
        1
    ]
}"
const url = new URL(
    "https://demo.aomlms.com/api/category/delete"
);

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

let body = {
    "delete_ids": [
        1
    ]
};

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

Example response (200):


{
    "message": "1 category(s) deleted "
}
 

Request   

POST api/category/delete

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

delete_ids   string[]   

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 --request GET \
    --get "https://demo.aomlms.com/api/certificate_templates/lookup" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/certificate_templates/lookup"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 1,
        "name": "cert 1"
    }
]
 

Request   

GET api/certificate_templates/lookup

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

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 --request GET \
    --get "https://demo.aomlms.com/api/certificate_templates/tabularlist?page_size=50&page_number=impedit&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" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/certificate_templates/tabularlist"
);

const params = {
    "page_size": "50",
    "page_number": "impedit",
    "order_by": "{"colName":"created_at", "direction": "desc"}}",
    "search_param": "{"templateName":"","courseId":""}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "records": [
        {
            "id": 1,
            "name": "cert 1",
            "author": "Aom Staff",
            "courses": "course 1, Awesome Course, course 1_copy",
            "created_at": "Aug 03, 2020 09:58 AM"
        }
    ]
}
 

Request   

GET api/certificate_templates/tabularlist

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

page_size   string   

The number of the items you want for a page. Example: 50

page_number   string   

Current page number in pagination. Example: impedit

order_by   string  optional  

For ordering items based on columns provided in JSON format. Example: {"colName":"created_at", "direction": "desc"}}

search_param   string  optional  

For searching items based on field names. Example: {"templateName":"","courseId":""}

Quick Edit

Updates the details in bulk for specified certificate templates. Parameters is provided which needs to be updated. (See Parameters)

Example request:
curl --request POST \
    "https://demo.aomlms.com/api/certificate_templates/quickEdit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"template_ids\": [
        3,
        1
    ],
    \"author_id\": 1
}"
const url = new URL(
    "https://demo.aomlms.com/api/certificate_templates/quickEdit"
);

const 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,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Certificate Templates updated Successfully"
}
 

Request   

POST api/certificate_templates/quickEdit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

template_ids   string[]   

All certificate template IDs which needs to be updated.

author_id   integer  optional  

Update the instructor/Author for the selected certificate templates. Example: 1

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 --request GET \
    --get "https://demo.aomlms.com/api/certificate_template/keysLookup" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/certificate_template/keysLookup"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "db_value": "student_first_name",
        "display_value": "Student First Name"
    },
    {
        "db_value": "student_last_name",
        "display_value": "Student Last Name"
    },
    {
        "db_value": "student_full_name",
        "display_value": "Student Full Name"
    },
    {
        "db_value": "course_name",
        "display_value": "Course Name"
    },
    {
        "db_value": "issue_date",
        "display_value": "Date of Issue"
    },
    {
        "db_value": "expiry_date",
        "display_value": "Date of Expiry"
    },
    {
        "db_value": "instructor_name",
        "display_value": "Instructor Name"
    },
    {
        "db_value": "certificate_code",
        "display_value": "Certificate Code"
    },
    {
        "db_value": "course_credit",
        "display_value": "Course Credit"
    },
    {
        "db_value": "custom_text",
        "display_value": "Custom Text"
    }
]
 

Request   

GET api/certificate_template/keysLookup

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

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 --request GET \
    --get "https://demo.aomlms.com/api/certificate_template/fontFamilyLookup" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/certificate_template/fontFamilyLookup"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "db_value": "Arial",
        "display_value": "Arial",
        "is_selected": "true"
    },
    {
        "db_value": "Courier",
        "display_value": "Courier"
    },
    {
        "db_value": "Times-Roman",
        "display_value": "Times-Roman"
    },
    {
        "db_value": "Helvetica",
        "display_value": "Helvetica"
    },
    {
        "db_value": "Times-Bold",
        "display_value": "Times-Bold"
    },
    {
        "db_value": "Courier-Bold",
        "display_value": "Courier-Bold"
    },
    {
        "db_value": "DejaVuSans-Bold",
        "display_value": "DejaVuSans-Bold"
    },
    {
        "db_value": "DejaVuSansMono-Bold",
        "display_value": "DejaVuSansMono-Bold"
    }
]
 

Request   

GET api/certificate_template/fontFamilyLookup

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

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 --request POST \
    "https://demo.aomlms.com/api/certificate_template" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"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"
);

const 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,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "id": 2,
    "message": "Certificate Template created successfully"
}
 

Request   

POST api/certificate_template

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

name   string   

Name of the certificate template. Example: Completion-Certificate

bg_url   string  optional  

Background for the certificate template. Example: http://aom.com/images/default-certificate.png

height   integer   

Height size for the certificate template. Example: 680

width   integer   

Width size for the certificate template. Example: 1075

fields   string[]  optional  

All the certificate fields user have added to appear in certificate template(student name, instructor name, course name, etc).

Retrieve Certificate Template

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

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/certificate_template/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/certificate_template/1"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "name": "cert 1",
    "bg_url": "https://v3.academyofmine.net/wp-content/uploads/2020/07/default-certificate.png",
    "height": 827,
    "width": 1070,
    "fields": [
        {
            "key": "student_full_name",
            "value": "Student Full Name",
            "font_size": 20,
            "font_family": "Arial",
            "font_color": "#222",
            "top": 401,
            "left": 443,
            "align_center": false,
            "width": 200,
            "height": 60
        }
    ]
}
 

Request   

GET api/certificate_template/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the certificate template you want to fetch the details of. Example: 1

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 --request GET \
    --get "https://demo.aomlms.com/api/certificate_template/preview/2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/certificate_template/preview/2"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


pdf file as download option
 

Request   

GET api/certificate_template/preview/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the Certificate template. Example: 2

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 --request PUT \
    "https://demo.aomlms.com/api/certificate_template/2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"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"
);

const 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,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "id": 2,
    "message": "Certificate Template created successfully"
}
 

Request   

PUT api/certificate_template/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the certificate template Example: 2

Body Parameters

name   string   

Name of the certificate template. Example: Updated-Completion-Certificate

bg_url   string  optional  

Background for the certificate template. Example: http://aom.com/images/default-certificate.png

height   integer   

Height size for the certificate template. Example: 780

width   integer   

Width size for the certificate template. Example: 1075

fields   string[]  optional  

All the certificate fields user have added to appear in certificate template(student name, instructor name, course name, etc).

Delete Certificate Template

To delete a certificate template, you need to use this request. Returns number of certificate template deleted(if multiple selected) and also not deleted. (See Response)

Example request:
curl --request POST \
    "https://demo.aomlms.com/api/certificate_template/delete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"delete_ids\": [
        1,
        12,
        15
    ]
}"
const url = new URL(
    "https://demo.aomlms.com/api/certificate_template/delete"
);

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

let body = {
    "delete_ids": [
        1,
        12,
        15
    ]
};

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

Example response (200):


{
    "message": "2 template(s) deleted 1 template(s) not deleted as it is used in course. Please remove the template(s) from the course and try again."
}
 

Request   

POST api/certificate_template/delete

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

delete_ids   string[]   

All certificate template IDs which needs to be deleted.

Class

You can perform operations like create, edit, delete on classes.

Retrieve List of classes

Return list of classes

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/class/tabularlist?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%22location%22%3A%22%22%2C%22courseName%22%3A%22%22%2C%22dates%22%3A%5B%5D%7D&group_id=1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/class/tabularlist"
);

const params = {
    "page_size": "50",
    "page_number": "1",
    "order_by": "{"colName":"created_at","direction":"desc"}",
    "search_param": "{"location":"","courseName":"","dates":[]}",
    "group_id": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{"recordsTotal": 56, "recordsFiltered": 56, "records": [{"id": 56, "course_name": "Professional Development", "start_time": "01-Jan-2024 02:00 AM", "end_time": "31-Jan-2024 14:00 PM", "location": "New Jersey", "courseEdit": "https:\/\/staging.aomlms.com\/dashboard\/course\/edit\/34?start=2024-01-01&end=2024-01-31", "isAbleToEdit": true }}
 

Request   

GET api/class/tabularlist

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

page_size   string   

The number of the items you want for a page. Example: 50

page_number   string   

Current page number in pagination. Example: 1

order_by   string  optional  

For ordering items based on columns provided in JSON format. Example: {"colName":"created_at","direction":"desc"}

search_param   string  optional  

For searching items based on location, course name, dates. Example: {"location":"","courseName":"","dates":[]}

group_id   string  optional  

The ID of the group. Example: 1

Retrieve Schedules of a class

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/class/get-class-schedules?courseId=1&search_param=%7B%22location%22%3A1%7D&group_id=1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/class/get-class-schedules"
);

const params = {
    "courseId": "1",
    "search_param": "{"location":1}",
    "group_id": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "classes": [
        {
            "id": 56,
            "startDate": "01-Jan-2024",
            "endDate": "31-Jan-2024",
            "startTime": "02:00 AM",
            "endTime": "14:00 PM",
            "location_id": 2,
            "location": "New Jersey",
            "instructor_id": 8,
            "instructor": "John Doe",
            "start_time": "2024-01-01T09:00:00.000000Z"
        }
    ]
}
 

Request   

GET api/class/get-class-schedules

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

courseId   string  optional  

The ID of the course. Example: 1

search_param   string  optional  

For searching items based on location. Example: {"location":1}

group_id   string  optional  

The ID of the group. Example: 1

Create Class

To create class, you need to use this request. (See parameters)

Returns : id of the class created and successfull message

Example request:
curl --request POST \
    "https://demo.aomlms.com/api/class/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"allowDownload\": false,
    \"courseId\": 34,
    \"disabled\": true,
    \"endTime\": \"2024-01-1 10:00:00\",
    \"instructor\": 2,
    \"location\": 2,
    \"recurrence\": \"velit\",
    \"starttime\": \"2024-01-31 10:00:00\",
    \"type\": \"onetime\",
    \"webinarProvider\": \"magni\",
    \"zoom_host_pwd\": \"dolorem\",
    \"zoom_meeting_id\": \"dolores\"
}"
const url = new URL(
    "https://demo.aomlms.com/api/class/create"
);

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

let body = {
    "allowDownload": false,
    "courseId": 34,
    "disabled": true,
    "endTime": "2024-01-1 10:00:00",
    "instructor": 2,
    "location": 2,
    "recurrence": "velit",
    "starttime": "2024-01-31 10:00:00",
    "type": "onetime",
    "webinarProvider": "magni",
    "zoom_host_pwd": "dolorem",
    "zoom_meeting_id": "dolores"
};

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

Example response (200):


{
    "id": 62,
    "message": "Class saved successfully"
}
 

Request   

POST api/class/create

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

allowDownload   boolean   

Set true to allow downloading class recordings. Example: false

courseId   integer   

ID of the class. Example: 34

disabled   boolean   

. Example : false Example: true

endTime   datetime  optional  

End time of the class. Example: 2024-01-1 10:00:00

instructor   integer   

ID of the instructor. Example: 2

location   integer  optional  

Id of the location. Example: 2

recurrence   recurrence  optional  

of the class. Example : {classDays: "", startDate: "", startTime: "", endTime: "", interval: "", frequency: "", end: ""} Example: velit

starttime   datetime  optional  

Start time of the class. Example: 2024-01-31 10:00:00

type   string  optional  

Type of class, onetime or recurring: Example: onetime

webinarProvider   string  optional  

Example: magni

zoom_host_pwd   string  optional  

Example: dolorem

zoom_meeting_id   string  optional  

Example: dolores

Retrieve class details

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/class/edit?classId=1&courseId=1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/class/edit"
);

const params = {
    "classId": "1",
    "courseId": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "classDetails": {
        "id": 56,
        "courseId": "34",
        "startTime": "2024-01-01 09:00:00",
        "endTime": "2024-01-31 21:00:00",
        "location": 2,
        "instructor": 8,
        "webinarProvider": "",
        "allowDownload": false,
        "zoom_meeting_id": null,
        "zoom_host_pwd": null,
        "studyMaterial": []
    }
}
 

Request   

GET api/class/edit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

classId   string  optional  

ID of the class. Example: 1

courseId   string  optional  

ID of the course. Example: 1

Update event details with specified parameters.

Example request:
curl --request POST \
    "https://demo.aomlms.com/api/class/update?allowDownload=&courseId=%2219%22&endTime=%222024-01-31+23%3A09%3A00%22&id=2&instructor=6&location=2&startTime=%222024-01-09+02%3A00%3A00%22&studyMaterial[]=assumenda&studyMaterial%5B0%5D%5Bmedia_id%5D=2&studyMaterial%5B0%5D%5Bname%5D=%22elephantsdream-2-a0c4eea6d83f7d0141e36e30cc7b0369.mp4%22&studyMaterial%5B0%5D%5Btype%5D=%22Videos%22&webinarProvider=%22%22&zoom_host_pwd=null&zoom_meeting_id=null" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/class/update"
);

const params = {
    "allowDownload": "0",
    "courseId": ""19"",
    "endTime": ""2024-01-31 23:09:00"",
    "id": "2",
    "instructor": "6",
    "location": "2",
    "startTime": ""2024-01-09 02:00:00"",
    "studyMaterial[0]": "assumenda",
    "studyMaterial[0][media_id]": "2",
    "studyMaterial[0][name]": ""elephantsdream-2-a0c4eea6d83f7d0141e36e30cc7b0369.mp4"",
    "studyMaterial[0][type]": ""Videos"",
    "webinarProvider": """",
    "zoom_host_pwd": "null",
    "zoom_meeting_id": "null",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):


{
    "message": "Class updated Successfully"
}
 

Request   

POST api/class/update

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

allowDownload   boolean  optional  

Flag indicating whether downloads are allowed. Example: false

courseId   string  optional  

The ID of the course. Example: "19"

endTime   string  optional  

The end time of the class. Example: "2024-01-31 23:09:00"

id   integer  optional  

The ID of the class. Example: 2

instructor   integer  optional  

The ID of the instructor for the class. Example: 6

location   integer  optional  

The ID of the location for the class. Example: 2

startTime   string  optional  

The start time of the class. Example: "2024-01-09 02:00:00"

studyMaterial   string[]  optional  

JSON-encoded array of study materials for the event.

studyMaterial[0][media_id]   integer  optional  

The media ID of the study material. Example: 2

studyMaterial[0][name]   string  optional  

The name of the study material. Example: "elephantsdream-2-a0c4eea6d83f7d0141e36e30cc7b0369.mp4"

studyMaterial[0][type]   string  optional  

The type of the study material. Example: "Videos"

webinarProvider   string  optional  

The provider for the webinar. Example: ""

zoom_host_pwd   string  optional  

string|null The password for the Zoom host. Example: null

zoom_meeting_id   string  optional  

string|null The meeting ID for the Zoom meeting. Example: null

Retrieve details of course and class associated with it

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/class/get-course-classes?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%22location%22%3A%22%22%2C%22instructor%22%3A%22%22%2C%22dates%22%3A%5B%5D%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/class/get-course-classes"
);

const params = {
    "course_id": "1",
    "group_id": "1",
    "page_size": "50",
    "page_number": "1",
    "order_by": "{"colName":"registered_on","direction":"desc"}",
    "search_param": "{"location":"","instructor":"","dates":[]}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "courseName": "Professional Development",
    "instructions": null,
    "featuredImage": null,
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "records": [
        {
            "id": 56,
            "startDate": "01-Jan-2024",
            "endDate": "31-Jan-2024",
            "startTime": "09:00 AM",
            "endTime": "21:00 PM",
            "location": "New Jersey",
            "instructor": "John",
            "classSize": 0
        }
    ]
}
 

Request   

GET api/class/get-course-classes

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

course_id   string  optional  

The ID of the course. Example: 1

group_id   string  optional  

The ID of the group. Example: 1

page_size   integer  optional  

The number of the items you want for a page. Example: 50

page_number   integer  optional  

Current page number in pagination. Example: 1

order_by   string  optional  

For ordering items based on columns provided in JSON format. Example: {"colName":"registered_on","direction":"desc"}

search_param   string  optional  

For searching items based on location, instructor. Example: {"location":"","instructor":"","dates":[]}

Enroll

urlParam id The ID of the class. Example: 2

Example request:
curl --request POST \
    "https://demo.aomlms.com/api/class/enroll/{id}?groupId=1&studentIds[]=3" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/class/enroll/{id}"
);

const params = {
    "groupId": "1",
    "studentIds[0]": "3",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):


{
    "message": "1 student(s) enrolled successfully",
    "enrolledUsersCount": 1,
    "notEnrolledUsers": []
}
 

Request   

POST api/class/enroll/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

groupId   integer  optional  

The ID of the group. Example: 1

studentIds   string[]  optional  

The ID(s) of the students.

Retrieve details of course and class associated with it

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/class/enrolled-students?class_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%22%22%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/class/enrolled-students"
);

const params = {
    "class_id": "1",
    "group_id": "1",
    "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]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "courseId": 34,
    "locationId": 2,
    "courseName": "Professional Development",
    "featuredImage": null,
    "recordsTotal": 0,
    "startDate": "01-Jan-2024",
    "endDate": "31-Jan-2024",
    "startTime": "09:00 AM",
    "endTime": "21:00 PM",
    "totalAttended": 0,
    "totalNoShow": 0,
    "totalCancelled": 0,
    "recordsFiltered": 0,
    "records": []
}
 

Request   

GET api/class/enrolled-students

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

class_id   string  optional  

The ID of the Class. Example: 1

group_id   string  optional  

The ID of the group. Example: 1

page_size   integer  optional  

The number of the items you want for a page. Example: 50

page_number   integer  optional  

Current page number in pagination. Example: 1

order_by   string  optional  

For ordering items based on columns provided in JSON format. Example: {"colName":"registered_on","direction":"desc"}

search_param   string  optional  

For searching items based on name, email, status. Example: {"nameOrEmail":"","status":""}

Update class status of the student

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/class/update-class-status?id=3&status=Attended&classId=1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/class/update-class-status"
);

const params = {
    "id": "3",
    "status": "Attended",
    "classId": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "message": "Status Updated Successfully"
}
 

Request   

GET api/class/update-class-status

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

id   string  optional  

enrollment ID of the student. Example: 3

status   string  optional  

The status of the class. It can be Registered, Attended, No Show, Cancelled. Example: Attended

classId   string  optional  

ID of the class. Example: 1

Remove Student from Class

Example request:
curl --request POST \
    "https://demo.aomlms.com/api/class/remove/2?enrollmentIds[]=2&groupID=2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/class/remove/2"
);

const params = {
    "enrollmentIds[0]": "2",
    "groupID": "2",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):


{
    "message": "1 student(s) removed successfully"
}
 

Request   

POST api/class/remove/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string  optional  

ID of the class. Example: 2

Query Parameters

enrollmentIds   string[]  optional  

enrollment ID of the user.

groupID   integer  optional  

ID of the group user belongs to. Example: 2

Assign Certificate

Example request:
curl --request POST \
    "https://demo.aomlms.com/api/class/assignCertificate/2?enrollmentIds[]=2" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/class/assignCertificate/2"
);

const params = {
    "enrollmentIds[0]": "2",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):


{
    "isSucess": true,
    "message": "Certificate assigned successfully to 1 student(s)"
}
 

Request   

POST api/class/assignCertificate/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string  optional  

ID of the class. Example: 2

Query Parameters

enrollmentIds   string[]  optional  

enrollment ID of the user.

Retrive Study material

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/class/study-material?registrationId=3" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/class/study-material"
);

const params = {
    "registrationId": "3",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "name": "Professional Development",
    "instructions": null,
    "featuredImageUrl": null,
    "status": "Registered",
    "display_status": "Registered",
    "startDate": "09-Jan-2024",
    "endDate": "31-Jan-2024",
    "startTime": "02:00 AM",
    "endTime": "23:09 PM",
    "location": "New Jersey",
    "start": "2024-01-09T02:00:00.000000Z",
    "end": "2024-01-31T23:09:00.000000Z",
    "instructor": "test ",
    "classMaterial": [
        {
            "id": 2,
            "file_name": "elephantsdream-2-a0c4eea6d83f7d0141e36e30cc7b0369.mp4",
            "file_type": "Videos",
            "status": "Completed",
            "s3_url": "https://4bf2-103-163-65-26.ngrok-free.app/storage/videos/elephantsdream-2-a0c4eea6d83f7d0141e36e30cc7b0369.mp4",
            "mux_url": "https://stream.mux.com/gwxGG01jAt024241hlvnE3Sh1oyclp6VXo.m3u8",
            "mux_id": "243RSjx5V8tv4pr0201iAZwiCUAd019dKd5",
            "mime_type": "video/mp4",
            "created_at": "Dec 26, 2023 12:38 PM"
        }
    ]
}
 

Request   

GET api/class/study-material

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

registrationId   string  optional  

registration ID of the student. Example: 3

Delete Class

Returns success message on deleting class for specified ID

Example request:
curl --request POST \
    "https://demo.aomlms.com/api/class/delete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"classId\": 57
}"
const url = new URL(
    "https://demo.aomlms.com/api/class/delete"
);

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

let body = {
    "classId": 57
};

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

Example response (200):


{
    "message": "Permissions updated successfully"
}
 

Request   

POST api/class/delete

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

classId   integer  optional  

The ID of class to be deleted. Example: 57

Delete Class

Returns success message on deleting class

Example request:
curl --request POST \
    "https://demo.aomlms.com/api/class/delete-course-classes" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"courseId\": 3
}"
const url = new URL(
    "https://demo.aomlms.com/api/class/delete-course-classes"
);

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

let body = {
    "courseId": 3
};

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

Example response (200):


{
    "message": "2 Class(s) is successfully deleted and 4 Enrollment(s) is successfully removed"
}
 

Request   

POST api/class/delete-course-classes

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

courseId   integer  optional  

The ID of course. Example: 3

Retrieve Webinar Details

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/class/webinar/details?registrationId=11" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/class/webinar/details"
);

const params = {
    "registrationId": "11",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "recordings": [],
    "name": "Professional Development",
    "instructions": null,
    "status": "Registered",
    "display_status": "Registered",
    "startTime": "Jan 06, 2024 02:00 AM",
    "endTime": "Jan 06, 2024 07:00 AM",
    "location": "Virtual",
    "instructor": "test k ",
    "serviceProvider": "zoom",
    "meetingUrl": null,
    "webinarTimezone": "MST",
    "duration": "0 Day(s)",
    "webinarStatus": "Upcoming",
    "webinarDetails": {
        "is_success": true,
        "message": "Zoom meeting initialized",
        "url": "https://staging.aomlms.com/dashboard/zoom-frame?meetingNumber=72624398242&password=7kTYJ5&signature=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzZGtLZXkiOiJkV0wyQ08zNVJwSzBhUHZlUFJmM2lBIiwibW4iOjcyNjI0Mzk4MjQyLCJyb2xlIjowLCJpYXQiOjE3MDQ0NTYxMDYsImV4cCI6MTcwNDQ2MzMwNiwiYXBwS2V5IjoiZFdMMkNPMzVScEswYVB2ZVBSZjNpQSIsInRva2VuRXhwIjoxNzA0NDYzMzA2fQ.7NdLjPxSLqTyovXTYBkbw7I7SktHZSfsbAjbTDLqW0A&apiKey=dWL2CO35RpK0aPvePRf3iA&user_name=testk test&[email protected]"
    }
}
 

Request   

GET api/class/webinar/details

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

registrationId   string  optional  

registration ID of the general user. Example: 11

Update class status of the student

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/class/reports/class-detailed?class_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%5D%2C%22userIdActual%22%3A%22%22%2C%22started_on%22%3A%5B%5D%2C%22completed_on%22%3A%5B%5D%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/class/reports/class-detailed"
);

const params = {
    "class_id": "1",
    "group_id": "1",
    "page_size": "50",
    "page_number": "1",
    "order_by": "{"colName":"registered_on","direction":"desc"}",
    "search_param": "{"nameOrEmail":"","status":[],"userIdActual":"","started_on":[],"completed_on":[]}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "courseName": "Test ILT course",
    "recordsTotal": 0,
    "totalAttended": 0,
    "totalNoShow": 0,
    "totalCancelled": 0,
    "totalRegistered": 0,
    "recordsFiltered": 0,
    "records": []
}
 

Request   

GET api/class/reports/class-detailed

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

class_id   string  optional  

The ID of the Class. Example: 1

group_id   string  optional  

The ID of the group. Example: 1

page_size   integer  optional  

The number of the items you want for a page. Example: 50

page_number   integer  optional  

Current page number in pagination. Example: 1

order_by   string  optional  

For ordering items based on columns provided in JSON format. Example: {"colName":"registered_on","direction":"desc"}

search_param   string  optional  

For searching items based on name, email, status, user actual id, course started on, course ended on. Example: {"nameOrEmail":"","status":[],"userIdActual":"","started_on":[],"completed_on":[]}

Retrieve LMS Overview Report

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/class/reports/overview?group_id=3&selectedMonth=1-2024" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/class/reports/overview"
);

const params = {
    "group_id": "3",
    "selectedMonth": "1-2024",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{"labels": ["Test ILT course (03-Jan-2024)", "Test ILT course (10-Jan-2024)" ], "totalRegistered": [0, 0], "totalAttended": [0, 0],"totalNoShow": [0,0], "totalCancelled": [0,0],"startDate": ["03-Jan-2024","10-Jan-2024"],"endDate": ["03-Jan-2024","10-Jan-2024","sumRegistered": 2,"sumAttended": 0,"sumNoShow": 0,"sumCancelled": 0}
 

Request   

GET api/class/reports/overview

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

group_id   string  optional  

enrollment ID of the student. Example: 3

selectedMonth   string  optional  

Specify the month for which the report is required. Example: 1-2024

Retrieve Webinar Launch Details

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/class/webinar/launch?registrationId=11" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/class/webinar/launch"
);

const params = {
    "registrationId": "11",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "provider": "zoom",
    "webinarDetails": {
        "is_success": true,
        "message": "Zoom meeting initialized",
        "url": "https://staging.aomlms.com/dashboard/zoom-frame?meetingNumber=72624398242&password=7kTYJ5&signature=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzZGtLZXkiOiJkV0wyQ08zNVJwSzBhUHZlUFJmM2lBIiwibW4iOjcyNjI0Mzk4MjQyLCJyb2xlIjoxLCJpYXQiOjE3MDQ0NTY3NTQsImV4cCI6MTcwNDQ2Mzk1NCwiYXBwS2V5IjoiZFdMMkNPMzVScEswYVB2ZVBSZjNpQSIsInRva2VuRXhwIjoxNzA0NDYzOTU0fQ.S8ttl5m7lLnJEL3GDdIzauyvNuVz1p8g9MXhCxsrzak&apiKey=dWL2CO35RpK0aPvePRf3iA&user_name=test k &[email protected]"
    }
}
 

Request   

GET api/class/webinar/launch

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

registrationId   string  optional  

registration ID of the general user. Example: 11

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 --request GET \
    --get "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" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/courses/tabularlist"
);

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

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "records": [
        {
            "id": 1,
            "name": "course 1",
            "slug": "course-1",
            "status": "publish",
            "categories": "",
            "author": "Aom Staff",
            "created_at": "03 Aug 2020 09:08 AM"
        }
    ]
}
 

Request   

GET api/courses/tabularlist

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

page_size   string   

The number of the item you want for a page. Example: 9

page_number   string   

Current page number in pagination. Example: 1

order_by   string  optional  

For ordering items based on columns provided in JSON format. Example: {"colName":"created_at", "direction": "desc"}}

search_param   string  optional  

For searching items based on Course category ids, course name. Example: {"courseCategoryIds":[],"courseName":"course 1","status":"In Progress"}

Dropdown List

Returns course seat details while adding this to a group.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/courses/dropdownlist?group_id=1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/courses/dropdownlist"
);

const params = {
    "group_id": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 1,
        "name": "course 1",
        "used_seats": null,
        "total_seats": null
    }
]
 

Request   

GET api/courses/dropdownlist

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

group_id   string   

ID of the group. Example: 1

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 --request GET \
    --get "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" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/course/enrolled-students"
);

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

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "courseName": "course 1",
    "featuredImage": null,
    "recordsTotal": 2,
    "totalNotStarted": 1,
    "totalInProgress": 0,
    "totalCompleted": 1,
    "recordsFiltered": 2,
    "records": [
        {
            "id": 6,
            "user_id": 4,
            "first_name": "John",
            "last_name": "Doe",
            "email": "[email protected]",
            "avatar": "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"40\" height=\"40\" viewBox=\"0 0 40 40\"><circle cx=\"20\" cy=\"20\" r=\"20\" stroke=\"background\" stroke-width=\"0\" fill=\"#03A9F4\" /><text x=\"20\" y=\"20\" font-size=\"14\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">JD</text></svg>",
            "status": "Not Started",
            "percentComplete": 0,
            "access_status": "Allowed",
            "registered_on": "09-Aug-2020",
            "started_on": "",
            "completed_on": "",
            "expire_on": "Never",
            "last_accessed_on": "Never"
        },
        {
            "id": 1,
            "user_id": 3,
            "first_name": "Demo",
            "last_name": "Student",
            "email": "[email protected]",
            "avatar": "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"40\" height=\"40\" viewBox=\"0 0 40 40\"><circle cx=\"20\" cy=\"20\" r=\"20\" stroke=\"background\" stroke-width=\"0\" fill=\"#4CAF50\" /><text x=\"20\" y=\"20\" font-size=\"14\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">DS</text></svg>",
            "status": "Completed",
            "percentComplete": 100,
            "access_status": "Allowed",
            "registered_on": "03-Aug-2020",
            "started_on": "03-Aug-2020",
            "completed_on": "03-Aug-2020",
            "expire_on": "Never",
            "last_accessed_on": "6 days ago"
        }
    ]
}
 

Request   

GET api/course/enrolled-students

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

course_id   string   

ID of the course. Example: 1

group_id   string   

ID of the group. Example: 1

page_size   string   

Number of the results you want in each page. Example: 50

page_number   string   

Current Page number. Example: 1

order_by   string  optional  

Returns details in some order. Example: {"colName":"registered_on","direction":"desc"}

search_param   string  optional  

Search parameters related to course. Example: {"nameOrEmail":"","status":["In Progress"]}

Retrieve Location

Retrieves the location of a specified course. Helps in fetching a dates using its course ID and group ID. (See Parameters)

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/courses/locations/lookup?course_id=1&group_id=1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/courses/locations/lookup"
);

const params = {
    "course_id": "1",
    "group_id": "1",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "0": {
        "id": 2,
        "name": "Cherry Hill",
        "courseId": "34",
        "classId": 57
    },
    "2": {
        "id": 1,
        "name": "Virtual",
        "courseId": "34",
        "classId": 59
    }
}
 

Request   

GET api/courses/locations/lookup

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

course_id   string  optional  

The ID of the course. Example: 1

group_id   string  optional  

The ID of the group. Example: 1

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 --request GET \
    --get "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" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/course/submissions"
);

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

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "courseName": "course 1",
    "featuredImage": null,
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "records": [
        {
            "status_row_id": 2,
            "module_id": 4,
            "module_name": "assign",
            "module_type": "assignment",
            "first_name": "Aom",
            "last_name": "Staff",
            "email": "[email protected]",
            "avatar": "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"40\" height=\"40\" viewBox=\"0 0 40 40\"><circle cx=\"20\" cy=\"20\" r=\"20\" stroke=\"background\" stroke-width=\"0\" fill=\"#00BCD4\" /><text x=\"20\" y=\"20\" font-size=\"14\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">AS</text></svg>",
            "submission_id": 1,
            "submitted_on": "10-Aug-2020"
        }
    ]
}
 

Request   

GET api/course/submissions

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

course_id   string   

ID of the course. Example: 1

page_size   string   

The number of the submissions you want for a page. Example: 50

page_number   string   

Current page number in pagination. Example: 1

order_by   string  optional  

For ordering items based on columns provided in JSON format. Example: {"colName":"updated_at","direction":"desc"}

search_param   string  optional  

For searching items based on Course category ids, course name. Example: {"nameOrEmail":"","type":""}

All Courses Submissions

Retrieves all the submissions for all the courses in pagination mode. You can apply filter on data returned using search_param via nameOrEmail(student name or email) and type(submission type - assignment or discussion)

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/course/all-submissions?page_size=50&page_number=1&order_by=%7B%22colName%22%3A%22updated_at%22%2C%22direction%22%3A%22desc%22%7D&search_param=%7B%22nameOrEmail%22%3A%22%22%2C%22type%22%3A%22%22%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/course/all-submissions"
);

const params = {
    "page_size": "50",
    "page_number": "1",
    "order_by": "{"colName":"updated_at","direction":"desc"}",
    "search_param": "{"nameOrEmail":"","type":""}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "records": [
        {
            "course_name": "Professional Development and Training",
            "status_row_id": 2,
            "module_id": 4,
            "module_name": "assign",
            "module_type": "assignment",
            "first_name": "Aom",
            "last_name": "Staff",
            "email": "[email protected]",
            "avatar": "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"40\" height=\"40\" viewBox=\"0 0 40 40\"><circle cx=\"20\" cy=\"20\" r=\"20\" stroke=\"background\" stroke-width=\"0\" fill=\"#00BCD4\" /><text x=\"20\" y=\"20\" font-size=\"14\" fill=\"#FFFFFF\" alignment-baseline=\"middle\" text-anchor=\"middle\" dominant-baseline=\"central\">AS</text></svg>",
            "submission_id": 1,
            "submitted_on": "10-Aug-2020"
        }
    ]
}
 

Request   

GET api/course/all-submissions

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

page_size   string   

The number of the submissions you want for a page. Example: 50

page_number   string   

Current page number in pagination. Example: 1

order_by   string  optional  

For ordering items based on columns provided in JSON format. Example: {"colName":"updated_at","direction":"desc"}

search_param   string  optional  

For searching items based on course name, user names and submission type. Example: {"nameOrEmail":"","type":""}

LMS Overview Report

Retrieves the overview report for all courses. Returned data contains information like total number of modules and number of courses in different status(In Progress, Not Started and Completed). Example - [1,0]. You can use these data for graphs representation as well. You can use the group_id filter to get details specific to a group.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/course/reports/overview?group_id=3" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/course/reports/overview"
);

const params = {
    "group_id": "3",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "labels": [
        "course 1",
        "Awesome Course"
    ],
    "totalNotStarted": [
        1,
        0
    ],
    "totalInProgress": [
        1,
        0
    ],
    "totalCompleted": [
        1,
        0
    ],
    "sumNotStarted": 1,
    "sumInProgress": 1,
    "sumCompleted": 1
}
 

Request   

GET api/course/reports/overview

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

group_id   string  optional  

ID of the group. Example: 3

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 --request GET \
    --get "https://demo.aomlms.com/api/course/reports/course-detailed?course_id=3&group_id=facere&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&userCategoryId=%7B%22nameOrEmail%22%3A%22%22%2C%22status%22%3A%5B%5D%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/course/reports/course-detailed"
);

const params = {
    "course_id": "3",
    "group_id": "facere",
    "page_size": "50",
    "page_number": "1",
    "order_by": "{"colName":"registered_on","direction":"desc"}",
    "search_param": "{"nameOrEmail":"","status":[]}",
    "userCategoryId": "{"nameOrEmail":"","status":[]}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "courseName": "course 1",
    "featuredImage": null,
    "recordsTotal": 3,
    "totalNotStarted": 1,
    "totalInProgress": 1,
    "totalCompleted": 1,
    "recordsFiltered": 3,
    "records": [
        {
            "first_name": "Aom",
            "last_name": "Staff",
            "email": "[email protected]",
            "status": "In Progress",
            "percent_complete": 45,
            "access_status": "Allowed",
            "registered_on": "10-Aug-2020",
            "started_on": "10-Aug-2020",
            "completed_on": "",
            "expire_on": "Never",
            "last_accessed_on": "1 hour ago",
            "percent_achieved": null,
            "total_time_spent": "0h 20m",
            "certifcate_issued": "No"
        },
        {
            "first_name": "Client",
            "last_name": "Admin",
            "email": "[email protected]",
            "status": "Not Started",
            "percent_complete": 0,
            "access_status": "Allowed",
            "registered_on": "09-Aug-2020",
            "started_on": "",
            "completed_on": "",
            "expire_on": "12-Aug-2023",
            "last_accessed_on": "Never",
            "percent_achieved": null,
            "total_time_spent": "0h 0m",
            "certifcate_issued": "Yes"
        },
        {
            "first_name": "Demo",
            "last_name": "Student",
            "email": "[email protected]",
            "status": "Completed",
            "percent_complete": 50,
            "access_status": "Allowed",
            "registered_on": "03-Aug-2020",
            "started_on": "03-Aug-2020",
            "completed_on": "03-Aug-2020",
            "expire_on": "Never",
            "last_accessed_on": "6 days ago",
            "percent_achieved": 0,
            "total_time_spent": "0h 0m",
            "certifcate_issued": "Yes"
        }
    ]
}
 

Request   

GET api/course/reports/course-detailed

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

course_id   string   

ID of the course. Example: 3

group_id   string  optional  

ID of the group. Example: Example: facere

page_size   string   

The number of the submissions you want for a page. Example: 50

page_number   string   

Current page number in pagination. Example: 1

order_by   string  optional  

For ordering items based on columns provided in JSON format. Example: {"colName":"registered_on","direction":"desc"}

search_param   string  optional  

For searching items based on students name or emaila and status of the course. Example: {"nameOrEmail":"","status":[]}

userCategoryId   string  optional  

For listing students according to the user category in which they belong. Example: {"nameOrEmail":"","status":[]}

Get custom Headers for Export of Course Insight report

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/course/reports/course-detailed-custom-headers?course_id=1&group_id=1&page_size=1&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%2C%22status%22%3A%5B%5D%2C%22userIdActual%22%3A%22%22%2C%22started_on%22%3A%5B%5D%2C%22completed_on%22%3A%5B%5D%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/course/reports/course-detailed-custom-headers"
);

const params = {
    "course_id": "1",
    "group_id": "1",
    "page_size": "1",
    "page_number": "1",
    "order_by": "{"colName":"created_at", "direction": "desc"}}",
    "search_param": "{"nameOrEmail":"","status":[],"userIdActual":"","started_on":[],"completed_on":[]}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{[{"id":1,"name":"Virtual","courseId":"1","classId":1}]}
 

Request   

GET api/course/reports/course-detailed-custom-headers

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

course_id   string  optional  

The ID of the course. Example: 1

group_id   string  optional  

The ID of the group. Example: 1

page_size   string  optional  

The ID of the group. Example: 1

page_number   string  optional  

The ID of the group. Example: 1

order_by   string  optional  

For ordering items based on columns provided in JSON format. Example: {"colName":"created_at", "direction": "desc"}}

search_param   string  optional  

For searching items based on name, email, status, userId, courses started on, course completed on. Example: {"nameOrEmail":"","status":[],"userIdActual":"","started_on":[],"completed_on":[]}

Get Course

Retrieves the course details based on the course ID specified.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/course/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/course/1"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "name": "course 1",
    "slug": "course-1",
    "featuredImageUrl": null,
    "instructions": null,
    "credits": null,
    "minPassingPercentage": null,
    "gradingRule": "no_grading",
    "durationRule": "unlimited",
    "durationSpecificDate": null,
    "durationDays": null,
    "status": "publish",
    "certificateTemplates": [
        1
    ],
    "associatedProduct": [],
    "hasAssociatedProduct": false,
    "modules": [
        {
            "module_id": 1,
            "name": "test",
            "type": "text",
            "icon": "<i class=\"el-icon-tickets\"></i>",
            "is_locked": false,
            "drip_rules": "immediately",
            "drip_fixed_date": null,
            "drip_interval": null,
            "drip_interval_unit": "day",
            "drip_calculation_reference": "registration_date",
            "minSpentHour": 0,
            "minSpentMinutes": 0
        }
    ],
    "categories": [],
    "gradeModules": []
}
 

Request   

GET api/course/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

The ID of the course. Example: 1

Create Course

To create a course, you need to use this request with provided parameters.

Example request:
curl --request POST \
    "https://demo.aomlms.com/api/course" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"name\": \"Course 1\",
    \"instructions\": \"Some Instruction\",
    \"slug\": \"course-1\",
    \"featuredImageUrl\": \"img_path\",
    \"completionRedirectionUrl\": \"redirection_path\",
    \"credits\": 70,
    \"minPassingPercentage\": 75,
    \"gradingRule\": \"no_grading\",
    \"durationRule\": \"unlimited\",
    \"status\": \"publish\",
    \"certificateTemplates\": [
        1
    ],
    \"modules\": [
        {
            \"module_id\": 1,
            \"name\": \"test\",
            \"type\": \"text\",
            \"icon\": \"<i class=\\\"el-icon-tickets\\\"><\\/i>\",
            \"is_locked\": false,
            \"drip_rules\": \"immediately\",
            \"drip_fixed_date\": null,
            \"drip_interval\": null,
            \"drip_interval_unit\": \"day\",
            \"drip_calculation_reference\": \"registration_date\",
            \"minSpentHour\": 0,
            \"minSpentMinutes\": 0
        }
    ],
    \"certificateExpiresAfter\": 3,
    \"certificateExpiresAfterGracePeriod\": 30,
    \"categories\": [
        1,
        2
    ],
    \"gradeModules\": []
}"
const url = new URL(
    "https://demo.aomlms.com/api/course"
);

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

let body = {
    "name": "Course 1",
    "instructions": "Some Instruction",
    "slug": "course-1",
    "featuredImageUrl": "img_path",
    "completionRedirectionUrl": "redirection_path",
    "credits": 70,
    "minPassingPercentage": 75,
    "gradingRule": "no_grading",
    "durationRule": "unlimited",
    "status": "publish",
    "certificateTemplates": [
        1
    ],
    "modules": [
        {
            "module_id": 1,
            "name": "test",
            "type": "text",
            "icon": "<i class=\"el-icon-tickets\"><\/i>",
            "is_locked": false,
            "drip_rules": "immediately",
            "drip_fixed_date": null,
            "drip_interval": null,
            "drip_interval_unit": "day",
            "drip_calculation_reference": "registration_date",
            "minSpentHour": 0,
            "minSpentMinutes": 0
        }
    ],
    "certificateExpiresAfter": 3,
    "certificateExpiresAfterGracePeriod": 30,
    "categories": [
        1,
        2
    ],
    "gradeModules": []
};

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

Example response (200):


{
    "id": 1,
    "message": "Course saved successfully"
}
 

Request   

POST api/course

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the course. Example: 1

Body Parameters

name   string   

Name of the course. Example: Course 1

instructions   string  optional  

Instruction for the course. Example: Some Instruction

slug   string   

Slug for the course. Example: course-1

featuredImageUrl   string  optional  

Image for the course. Example: img_path

completionRedirectionUrl   string  optional  

After course completion redirection url(If blank, it will redirect to dashboard). Example: redirection_path

credits   integer  optional  

Credit after course completion, used in certificates. Example: 70

minPassingPercentage   number  optional  

Minimum passing percenatage for students. Example: 75

gradingRule   string   

Grading criteria for the course. Grading rule options: no_grading, avg_all_modules or avg_specific_modules. Example: no_grading

durationRule   string   

Access duration for the course. Duration rule options: unlimited, on_specific_date, x_days_after_start or x_days_after_enrollment. Example: unlimited

status   string   

Course is in Draft or Publish mode. Status options: draft or publish. Example: publish

certificateTemplates   string[]  optional  

Certificates attached to this course.

modules   string[]  optional  

All modules related to this course.

certificateExpiresAfter   integer  optional  

The number of months a certificate is valid for before it expires. Leave blank or zero for a permanent certificate. Example: 3

certificateExpiresAfterGracePeriod   integer  optional  

The number of days before certificate expiration that a student can recertify.. Example: 30

categories   string[]  optional  

Categories for this course.

gradeModules   string[]  optional  

Modules that will be used for grading users.

Update Course

Updates course details using provided parameters.

Example request:
curl --request PUT \
    "https://demo.aomlms.com/api/course/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"name\": \"Course 1\",
    \"slug\": \"course-1\",
    \"featuredImageUrl\": \"img_path\",
    \"completionRedirectionUrl\": \"redirection_path\",
    \"credits\": 70,
    \"minPassingPercentage\": 75,
    \"gradingRule\": \"no_grading\",
    \"durationRule\": \"unlimited\",
    \"status\": \"publish\",
    \"certificateTemplates\": [
        1
    ],
    \"modules\": [
        {
            \"module_id\": 1,
            \"name\": \"test\",
            \"type\": \"text\",
            \"icon\": \"<i class=\\\"el-icon-tickets\\\"><\\/i>\",
            \"is_locked\": false,
            \"drip_rules\": \"immediately\",
            \"drip_fixed_date\": null,
            \"drip_interval\": null,
            \"drip_interval_unit\": \"day\",
            \"drip_calculation_reference\": \"registration_date\",
            \"minSpentHour\": 0,
            \"minSpentMinutes\": 0
        }
    ],
    \"certificateExpiresAfter\": 3,
    \"certificateExpiresAfterGracePeriod\": 30,
    \"categories\": [
        1,
        2
    ],
    \"gradeModules\": []
}"
const url = new URL(
    "https://demo.aomlms.com/api/course/1"
);

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

let body = {
    "name": "Course 1",
    "slug": "course-1",
    "featuredImageUrl": "img_path",
    "completionRedirectionUrl": "redirection_path",
    "credits": 70,
    "minPassingPercentage": 75,
    "gradingRule": "no_grading",
    "durationRule": "unlimited",
    "status": "publish",
    "certificateTemplates": [
        1
    ],
    "modules": [
        {
            "module_id": 1,
            "name": "test",
            "type": "text",
            "icon": "<i class=\"el-icon-tickets\"><\/i>",
            "is_locked": false,
            "drip_rules": "immediately",
            "drip_fixed_date": null,
            "drip_interval": null,
            "drip_interval_unit": "day",
            "drip_calculation_reference": "registration_date",
            "minSpentHour": 0,
            "minSpentMinutes": 0
        }
    ],
    "certificateExpiresAfter": 3,
    "certificateExpiresAfterGracePeriod": 30,
    "categories": [
        1,
        2
    ],
    "gradeModules": []
};

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

Example response (200):


{
    "id": 1,
    "message": "Course updated successfully"
}
 

Request   

PUT api/course/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the course. Example: 1

Body Parameters

name   string   

Name of the course. Example: Course 1

slug   string   

Slug for the course. Example: course-1

featuredImageUrl   string  optional  

Image for the course. Example: img_path

completionRedirectionUrl   string  optional  

After course completion redirection url(If blank, it will redirect to dashboard). Example: redirection_path

credits   integer  optional  

Credit after course completion, used in certificates. Example: 70

minPassingPercentage   number  optional  

Minimum passing percenatage for students. Example: 75

gradingRule   string   

Grading criteria for the course. Grading rule options: no_grading, avg_all_modules or avg_specific_modules. Example: no_grading

durationRule   string   

Access duration for the course. Duration rule options: unlimited, on_specific_date, x_days_after_start or x_days_after_enrollment. Example: unlimited

status   string   

Course is in Draft or Publish mode. Status options: draft or publish. Example: publish

certificateTemplates   string[]  optional  

Certificates attached to this course.

modules   string[]  optional  

All modules related to this course.

certificateExpiresAfter   integer  optional  

The number of months a certificate is valid for before it expires. Leave blank or zero for a permanent certificate. Example: 3

certificateExpiresAfterGracePeriod   integer  optional  

The number of days before certificate expiration that a student can recertify.. Example: 30

categories   string[]  optional  

Categories for this course.

gradeModules   string[]  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 --request PUT \
    "https://demo.aomlms.com/api/course/update-slug/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"slug\": \"Awesome-course\"
}"
const url = new URL(
    "https://demo.aomlms.com/api/course/update-slug/1"
);

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

let body = {
    "slug": "Awesome-course"
};

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

Example response (200):


"Awesome-course"
 

Request   

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

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

The ID of the course. Example: 1

Body Parameters

slug   required  optional  

New slug for the course. Example: Awesome-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 --request POST \
    "https://demo.aomlms.com/api/course/lookup?group_id=1&search_term=quia" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/course/lookup"
);

const params = {
    "group_id": "1",
    "search_term": "quia",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

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

Example response (200):


[
    {
        "value": 1,
        "label": "course 1"
    }
]
 

Request   

POST api/course/lookup

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the course. Example: 1

Query Parameters

group_id   string  optional  

ID of the group. Example: 1

search_term   string  optional  

returns filtered data. Example: quia

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 --request POST \
    "https://demo.aomlms.com/api/course/delete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"delete_ids\": [
        1
    ]
}"
const url = new URL(
    "https://demo.aomlms.com/api/course/delete"
);

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

let body = {
    "delete_ids": [
        1
    ]
};

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

Example response (200):


{
    "message": "2  course(s) deleted 1 course(s) not deleted as it has enrollments. Please remove the students from the course and try again."
}
 

Request   

POST api/course/delete

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

delete_ids   string[]   

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 --request POST \
    "https://demo.aomlms.com/api/course/quickEdit" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"course_ids\": [
        1,
        2
    ],
    \"author_id\": 1,
    \"categories_id\": [
        1,
        2
    ]
}"
const url = new URL(
    "https://demo.aomlms.com/api/course/quickEdit"
);

const 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,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Courses updated Successfully"
}
 

Request   

POST api/course/quickEdit

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

course_ids   string[]   

All course IDs which needs to be updated.

author_id   integer  optional  

Set the instructor/Author for the course. Example: 1

categories_id   string[]  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 --request GET \
    --get "https://demo.aomlms.com/api/courses/drip/lookup" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/courses/drip/lookup"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "options": [
            {
                "db_value": "immediately",
                "display_value": "Immediately"
            },
            {
                "db_value": "fixed_date",
                "display_value": "On a Fixed Date"
            },
            {
                "db_value": "specific_interval",
                "display_value": "At Fixed Intervals"
            }
        ],
        "intervals": [
            {
                "db_value": "day",
                "display_value": "Day(s)"
            },
            {
                "db_value": "week",
                "display_value": "Week(s)"
            },
            {
                "db_value": "month",
                "display_value": "Month(s)"
            }
        ],
        "calculation_ref": [
            {
                "db_value": "registration_date",
                "display_value": "Enrollment Date"
            },
            {
                "db_value": "started_date",
                "display_value": "Course Start Date"
            }
        ]
    }
]
 

Request   

GET api/courses/drip/lookup

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Course Status Lookup

Retrieves all the status options for the courses. Helps showing options in dropdowns elements

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/courses/status/lookup" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/courses/status/lookup"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "db_value": "Not Started",
        "display_value": "Not Started"
    },
    {
        "db_value": "In Progress",
        "display_value": "In Progress"
    },
    {
        "db_value": "Completed",
        "display_value": "Completed"
    }
]
 

Request   

GET api/courses/status/lookup

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Grading Rules Lookup

Retrieves all the grading rules for the courses. Helps showing options in dropdowns elements

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/courses/grading-rules/lookup" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/courses/grading-rules/lookup"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "db_value": "no_grading",
        "display_value": "No Grading"
    },
    {
        "db_value": "avg_all_modules",
        "display_value": "Average of all Quiz/Assignment/Discussions/Scorm"
    },
    {
        "db_value": "avg_specific_modules",
        "display_value": "Average of specific Quiz/Assignment/Discussions/Scorm"
    }
]
 

Request   

GET api/courses/grading-rules/lookup

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Duration Rules Lookup

Retrieves all the duration rules for the courses. Helps showing options in dropdowns elements

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/courses/duration-rules/lookup" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/courses/duration-rules/lookup"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "db_value": "unlimited",
        "display_value": "Unlimited"
    },
    {
        "db_value": "on_specific_date",
        "display_value": "Till Specific Date"
    },
    {
        "db_value": "x_days_after_start",
        "display_value": "Till X day(s) after a student start the course"
    },
    {
        "db_value": "x_days_after_enrollment",
        "display_value": "Till X day(s) after a student is registered to the course"
    }
]
 

Request   

GET api/courses/duration-rules/lookup

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

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 --request GET \
    --get "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" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/course-activities"
);

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

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "courseName": "course 1",
    "featuredImage": null,
    "recordsTotal": 40,
    "recordsFiltered": 10,
    "records": [
        {
            "id": 10,
            "verb": "ACCESSED",
            "created_at": "Aug 03, 2020 10:07 AM",
            "message": "Demo Student has accessed course 1",
            "student": "Demo Student"
        },
        {
            "id": 9,
            "verb": "ACHIEVED CERTIFICATE",
            "created_at": "Aug 03, 2020 10:02 AM",
            "message": "Demo Student has achieved certificate for course 1",
            "student": "Demo Student"
        },
        {
            "id": 8,
            "verb": "COMPLETED",
            "created_at": "Aug 03, 2020 10:02 AM",
            "message": "course 1 was completed",
            "student": "Demo Student"
        },
        {
            "id": 7,
            "verb": "COMPLETED",
            "created_at": "Aug 03, 2020 10:02 AM",
            "message": "course 1 was completed",
            "student": "Demo Student"
        },
        {
            "id": 6,
            "verb": "ACHIEVED CERTIFICATE",
            "created_at": "Aug 03, 2020 10:02 AM",
            "message": "Demo Student has achieved certificate for course 1",
            "student": "Demo Student"
        },
        {
            "id": 5,
            "verb": "COMPLETED",
            "created_at": "Aug 03, 2020 10:02 AM",
            "message": "course 1 was completed",
            "student": "Demo Student"
        },
        {
            "id": 4,
            "verb": "COMPLETED",
            "created_at": "Aug 03, 2020 10:02 AM",
            "message": "course 1 was completed",
            "student": "Demo Student"
        },
        {
            "id": 3,
            "verb": "STARTED",
            "created_at": "Aug 03, 2020 10:02 AM",
            "message": "Demo Student has started test",
            "student": "Demo Student"
        },
        {
            "id": 2,
            "verb": "STARTED",
            "created_at": "Aug 03, 2020 10:01 AM",
            "message": "Demo Student has started course 1",
            "student": "Demo Student"
        },
        {
            "id": 1,
            "verb": "ENROLLED",
            "created_at": "Aug 03, 2020 10:00 AM",
            "message": "Demo Student is enrolled to course 1",
            "student": "Demo Student"
        }
    ]
}
 

Request   

GET api/course-activities

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

course_id   string   

ID of the course. Example: 1

page_size   string   

The number of the submissions you want for a page. Example: 50

page_number   string   

Current page number in pagination. Example: 1

order_by   string  optional  

For ordering items based on columns provided in JSON format. Example: {"colName":"created_at","direction":"desc"}

search_param   string  optional  

for searching items based on Course category ids, course name. Example: {"user_id":3,"activityName":"","dates":[]}

context   string   

Context for the request. Example: admin

Retrieve Students Progress

Retrieves the progress of the course. (See Parameters)

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/course-progress/edit/6?userId=3" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/course-progress/edit/6"
);

const params = {
    "userId": "3",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "name": "test",
    "modules": [
        {
            "module_id": 16,
            "name": "test",
            "slug": "test",
            "type": "pdf",
            "icon": "<i class=\"el-icon-document\"></i>",
            "status_row_id": -1,
            "status": "Not Started",
            "display_status": "Not Started",
            "started_on": "",
            "completed_on": "",
            "last_accessed_on": "",
            "total_time_spent": {
                "hours": 0,
                "minutes": 0,
                "seconds": 0,
                "totalSeconds": 0
            },
            "points_awarded": "",
            "completion_percentage": 0,
            "no_of_times_accessed": 0,
            "is_collapsed": true
        }
    ],
    "id": 105,
    "course_id": 35,
    "userId": 7,
    "userName": "Test Staff",
    "email": "[email protected]",
    "featuredImageUrl": null,
    "status": "Not Started",
    "completionPercentage": 0,
    "enrollmentDate": "2024-01-07 07:49:38",
    "expiryDate": "",
    "completionDate": "",
    "startDate": "",
    "lastAccessed": ""
}
 

Request   

GET api/course-progress/edit/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string  optional  

The The ID of the course. Example: 6

Query Parameters

userId   string  optional  

The ID of the user. Example: 3

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

Example request:
curl --request PUT \
    "https://demo.aomlms.com/api/course-progress/update/{id}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/course-progress/update/{id}"
);

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

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

Request   

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

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Course Name

Retrieves the course name.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/course/name/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/course/name/1"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "course_name": "course 1"
}
 

Request   

GET api/course/name/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the course. Example: 1

Enroll Students

To enroll students in a course, you need to use this request.

Example request:
curl --request POST \
    "https://demo.aomlms.com/api/course/enroll/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"studentIds\": [
        1,
        2
    ],
    \"groupId\": 4
}"
const url = new URL(
    "https://demo.aomlms.com/api/course/enroll/1"
);

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

let body = {
    "studentIds": [
        1,
        2
    ],
    "groupId": 4
};

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

Example response (200):


{
    "message": "2 student(s) enrolled successfully"
}
 

Request   

POST api/course/enroll/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the course. Example: 1

Body Parameters

studentIds   string[]   

All Students IDs needs to be enrolled in this course.

groupId   integer  optional  

Students needs to be added in this course group. Example: 4

Remove Students

To removes users from a course, you need to use this request.

Example request:
curl --request POST \
    "https://demo.aomlms.com/api/course/remove/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"enrollmentIds\": [
        8,
        7
    ],
    \"groupId\": 4
}"
const url = new URL(
    "https://demo.aomlms.com/api/course/remove/1"
);

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

let body = {
    "enrollmentIds": [
        8,
        7
    ],
    "groupId": 4
};

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

Example response (200):


{
    "message": "2 student(s) removed successfully"
}
 

Request   

POST api/course/remove/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the course. Example: 1

Body Parameters

enrollmentIds   string[]   

Course Registration/Enrollment IDs needs to be removed from this course.

groupId   integer  optional  

Students needs to be removed from this course group. Example: 4

Reset Progress

To reset the progress of students for course, you need to use this request

Example request:
curl --request POST \
    "https://demo.aomlms.com/api/course/reset/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"enrollmentIds\": [
        9,
        6
    ]
}"
const url = new URL(
    "https://demo.aomlms.com/api/course/reset/1"
);

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

let body = {
    "enrollmentIds": [
        9,
        6
    ]
};

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

Example response (200):


{
    "message": "2 student(s) progress is reset successfully"
}
 

Request   

POST api/course/reset/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the course. Example: 1

Body Parameters

enrollmentIds   string[]   

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 --request PUT \
    "https://demo.aomlms.com/api/course/revoke/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"enrollmentIds\": [
        9,
        6
    ]
}"
const url = new URL(
    "https://demo.aomlms.com/api/course/revoke/1"
);

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

let body = {
    "enrollmentIds": [
        9,
        6
    ]
};

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

Example response (200):


{
    "message": "2 student(s) access has been revoked successfully"
}
 

Request   

PUT api/course/revoke/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the course. Example: 1

Body Parameters

enrollmentIds   string[]   

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 --request PUT \
    "https://demo.aomlms.com/api/course/grant/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"enrollmentIds\": [
        9,
        6
    ]
}"
const url = new URL(
    "https://demo.aomlms.com/api/course/grant/1"
);

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

let body = {
    "enrollmentIds": [
        9,
        6
    ]
};

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

Example response (200):


{
    "message": "2 student(s) access has been granted successfully"
}
 

Request   

PUT api/course/grant/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the course. Example: 1

Body Parameters

enrollmentIds   string[]   

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 --request PUT \
    "https://demo.aomlms.com/api/course/setExpiry/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"enrollmentIds\": [
        9,
        6
    ],
    \"expiryDate\": \"[9, 6]\"
}"
const url = new URL(
    "https://demo.aomlms.com/api/course/setExpiry/1"
);

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

let body = {
    "enrollmentIds": [
        9,
        6
    ],
    "expiryDate": "[9, 6]"
};

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

Example response (200):


{
    "message": "Expiration date is sucessfully updated for 2 student(s) "
}
 

Request   

PUT api/course/setExpiry/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the course. Example: 1

Body Parameters

enrollmentIds   string[]   

Course Registration/Enrollment IDs needs setting expiry date for course.

expiryDate   date  optional  

Date on which the course is going to be expired. Example: [9, 6]

Assign Certificate

To assign certificate to the user for the course, you need to use this request.

Example request:
curl --request POST \
    "https://demo.aomlms.com/api/course/assignCertificate/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"enrollmentIds\": [
        9,
        6
    ]
}"
const url = new URL(
    "https://demo.aomlms.com/api/course/assignCertificate/1"
);

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

let body = {
    "enrollmentIds": [
        9,
        6
    ]
};

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

Example response (200):


{
    "isSucess": true,
    "message": "Certificate assigned sucessfully to 2 student(s)"
}
 

Request   

POST api/course/assignCertificate/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the course. Example: 1

Body Parameters

enrollmentIds   string[]   

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 --request GET \
    --get "https://demo.aomlms.com/api/activities/verb/lookup" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/activities/verb/lookup"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "db_value": "ENROLLED",
        "display_value": "ENROLLED"
    },
    {
        "db_value": "STARTED",
        "display_value": "STARTED"
    },
    {
        "db_value": "ACCESSED",
        "display_value": "ACCESSED"
    },
    {
        "db_value": "COMPLETED",
        "display_value": "COMPLETED"
    },
    {
        "db_value": "SUBMITTED",
        "display_value": "SUBMITTED"
    },
    {
        "db_value": "EVALUATED",
        "display_value": "EVALUATED"
    },
    {
        "db_value": "REJECTED",
        "display_value": "REJECTED"
    },
    {
        "db_value": "RETAKE",
        "display_value": "RETAKE"
    },
    {
        "db_value": "ACHIEVED CERTIFICATE",
        "display_value": "ACHIEVED CERTIFICATE"
    },
    {
        "db_value": "RESET",
        "display_value": "RESET"
    },
    {
        "db_value": "REMOVED",
        "display_value": "REMOVED"
    },
    {
        "db_value": "REVOKED",
        "display_value": "REVOKED"
    },
    {
        "db_value": "GRANTED",
        "display_value": "GRANTED"
    },
    {
        "db_value": "UPDATED EXPIRY DATE",
        "display_value": "UPDATED EXPIRY DATE"
    }
]
 

Request   

GET api/activities/verb/lookup

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

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 --request GET \
    --get "https://demo.aomlms.com/api/progress/course/1?userId=3" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/progress/course/1"
);

const params = {
    "userId": "3",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "name": "course 1",
    "modules": [
        {
            "module_id": 1,
            "name": "test",
            "slug": "test",
            "type": "text",
            "icon": "<i class=\"el-icon-tickets\"></i>",
            "status_row_id": 1,
            "status": "Completed",
            "started_on": "2020-08-03T10:02:33.000000Z",
            "completed_on": "2020-08-03T10:02:41.000000Z",
            "last_accessed_on": "6 days ago",
            "total_time_spent": {
                "hours": 0,
                "minutes": 0,
                "seconds": 6,
                "totalSeconds": 6
            },
            "completion_percentage": 100,
            "no_of_times_accessed": 1,
            "totalMarks": null,
            "obtainedMarks": null
        },
        {
            "module_id": 4,
            "name": "assign",
            "slug": "assign",
            "type": "assignment",
            "icon": "<i class=\"el-icon-edit-outline\"></i>",
            "status_row_id": -1,
            "status": "Not Started",
            "started_on": "",
            "completed_on": "",
            "last_accessed_on": "Never",
            "total_time_spent": "",
            "points_awarded": "",
            "completion_percentage": 0,
            "no_of_times_accessed": 0,
            "totalMarks": 50,
            "obtainedMarks": null
        }
    ],
    "id": 1,
    "userId": 3,
    "permalink": "http://localhost:8000/course/course-1",
    "featuredImageUrl": null,
    "instructions": null,
    "accessStatus": "Allowed",
    "status": "Completed",
    "completionPercentage": 50,
    "timeSpent": {
        "hours": 0,
        "minutes": 0,
        "seconds": 6,
        "totalSeconds": 6
    },
    "enrollmentDate": "03 Aug 2020",
    "isExpired": false,
    "daysToExpire": "Unlimited days",
    "lastAccessed": "6 days ago",
    "isCertificateAvailable": true,
    "totalMarks": 50,
    "obtainedMarks": 0,
    "percentage": 0
}
 

Request   

GET api/progress/course/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

Course registration ID for the student of the course you want to see progress. Example: 1

Query Parameters

userId   string   

ID of the user. Example: 3

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 --request GET \
    --get "https://demo.aomlms.com/api/enrolled/course/1?group_id=1&search_term=vero" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/enrolled/course/1"
);

const params = {
    "group_id": "1",
    "search_term": "vero",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


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

Request   

GET api/enrolled/course/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the course. Example: 1

Query Parameters

group_id   string  optional  

ID of the group. Example: 1

search_term   string  optional  

returns filtered data. Example: vero

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 --request POST \
    "https://demo.aomlms.com/api/course/clone" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"course_id\": 1,
    \"course_name\": \"course 1\",
    \"isDeepCopy\": false
}"
const url = new URL(
    "https://demo.aomlms.com/api/course/clone"
);

const 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,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Course Cloned Successfully"
}
 

Request   

POST api/course/clone

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

course_id   integer   

ID of the course to be cloned. Example: 1

course_name   string   

Name of the course about to be cloned. Example: course 1

isDeepCopy   boolean   

If true, content will be affected in real course if changes made in cloned course. Example: false

Course Type Lookup

Retrieves Course types.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/courses/type/lookup" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/courses/type/lookup"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "db_value": "self_paced",
        "display_value": "Self Paced"
    },
    {
        "db_value": "instructor_led",
        "display_value": "Instructor Led"
    }
]
 

Request   

GET api/courses/type/lookup

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Update Auto Enroll Courses

Updates the details of auto enroll courses. (See parameters)

Example request:
curl --request POST \
    "https://demo.aomlms.com/api/courses/auto-enroll-courses/update" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"id\": [
        1
    ]
}"
const url = new URL(
    "https://demo.aomlms.com/api/courses/auto-enroll-courses/update"
);

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

let body = {
    "id": [
        1
    ]
};

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

Example response (200):


{
    "message": "Course Updated Successfully",
    "type": "success",
    "title": "Success"
}
 

Request   

POST api/courses/auto-enroll-courses/update

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

id   string[]   

ID(s) of the courses.

Retrieve Auto Enrolled Courses

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/courses/auto-enroll-courses?order_by=%7B%22colName%22%3A%22created_at%22%2C%22direction%22%3A%22desc%22%7D" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/courses/auto-enroll-courses"
);

const params = {
    "order_by": "{"colName":"created_at","direction":"desc"}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "value": "1",
        "label": "Professional Development and Training"
    },
    {
        "value": "2",
        "label": "Training your Employees for the modern world"
    }
]
 

Request   

GET api/courses/auto-enroll-courses

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

order_by   string  optional  

For ordering items based on columns provided in JSON format. Example: {"colName":"created_at","direction":"desc"}

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 --request GET \
    --get "https://demo.aomlms.com/api/courses/launch?registrationId=12" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/courses/launch"
);

const params = {
    "registrationId": "12",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "name": "course 1",
    "modules": [
        {
            "module_id": 1,
            "name": "test",
            "slug": "test",
            "type": "text",
            "icon": "<i class=\"el-icon-tickets\"></i>",
            "is_locked": false,
            "lock_reason": "",
            "is_dripped": false,
            "drip_message": "",
            "is_current": true,
            "status_row_id": -1,
            "status": "Not Started",
            "started_on": "",
            "completed_on": "",
            "last_accessed_on": "Never",
            "total_time_spent": "",
            "points_awarded": "",
            "completion_percentage": 0,
            "no_of_times_accessed": 0
        }
    ],
    "permalink": "http://localhost:8000/course/course-1",
    "featuredImageUrl": null,
    "instructions": null,
    "accessStatus": "Allowed",
    "status": "In Progress",
    "completionPercentage": 0,
    "timeSpent": {
        "hours": 0,
        "minutes": 0,
        "seconds": 0,
        "totalSeconds": 0
    },
    "enrollmentDate": "10 Aug 2020",
    "isExpired": false,
    "daysToExpire": "Unlimited days",
    "lastAccessed": "1 minute ago"
}
 

Request   

GET api/courses/launch

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

registrationId   string   

Course registration ID of the student. Example: 12

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 --request GET \
    --get "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" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/coupons/tabularlist"
);

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

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "records": [
        {
            "id": 1,
            "code": "code75",
            "type": "percent_amount",
            "value": 1500,
            "total_limit": 12,
            "expired_at": "Aug 26, 2020"
        }
    ]
}
 

Request   

GET api/coupons/tabularlist

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

page_size   string   

The number of the items you want for a page. Example: 50

page_number   string   

Current page number in pagination. Example: 1

order_by   string  optional  

For ordering items based on columns provided in JSON format. Example: {"colName":"created_at", "direction": "desc"}}

search_param   string  optional  

For searching items based on field names. Example: {"code":""}

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 --request GET \
    --get "https://demo.aomlms.com/api/coupons/lookup?search_term=ut" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/coupons/lookup"
);

const params = {
    "search_term": "ut",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "id": 1,
        "code": "code75"
    }
]
 

Request   

GET api/coupons/lookup

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

search_term   string   

You need to provide coupons or substring of the coupons to search. Example: ut

Coupon Types Lookup

Retrieves all types of the coupons. Helps showing options in form elements like dropdowns.

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/coupons/type/lookup" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/coupons/type/lookup"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


[
    {
        "db_value": "fixed_amount",
        "display_value": "Fixed cart discount"
    },
    {
        "db_value": "percent_amount",
        "display_value": "Percentage Discount"
    }
]
 

Request   

GET api/coupons/type/lookup

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

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 --request POST \
    "https://demo.aomlms.com/api/coupon/create" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"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"
);

const 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,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "id": 1,
    "message": "Coupon created successfully"
}
 

Request   

POST api/coupon/create

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

code   string   

Code for the coupon. Example: code75

notes   string  optional  

Notes for the coupon. Example: Discount upto 75%

value   numeric   

Value of the coupon(discount price or percentage). Example: 1500

type   string   

Types of the coupon. Type options: fixed_amount or percent_amount. Example: percent_amount

usage_limit   integer  optional  

How many times this coupon can be used?. Example: 1200

expiry   date  optional  

On this date, this coupon will get expired. Example: 2020-08-26

allowed_emails   string  optional  

All allowed email comma seprated. Example: null

Retrieve Coupon

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

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/coupon/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/coupon/1"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "code": "code75",
    "type": "percent_amount",
    "value": 1500,
    "usage_limit": 12,
    "expiry": "2020-08-26",
    "allowed_emails": null,
    "note_privacy": null,
    "notes": "Discount upto 75%",
    "allowed_products": [],
    "excluded_products": [],
    "allowed_product_categories": []
}
 

Request   

GET api/coupon/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the coupon you want to fetch the details of. Example: 1

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 --request PUT \
    "https://demo.aomlms.com/api/coupon/1" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"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"
);

const 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,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Coupon updated successfully"
}
 

Request   

PUT api/coupon/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

URL Parameters

id   string   

ID of the coupon. Example: 1

Body Parameters

code   string   

code for the coupon. Example: code75

notes   string  optional  

Notes for the coupon. Example: Discount upto 75%

value   numeric   

Value of the coupon(discount price or percentage). Example: 1500

type   string   

Types of the coupon. Type options: fixed_amount or percent_amount. Example: percent_amount

usage_limit   integer  optional  

How many times this coupon can be used?. Example: 2000

expiry   date  optional  

On this date, this coupon will get expired. Example: 2020-08-26

allowed_emails   string  optional  

All allowed email comma seprated. Example: null

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 --request POST \
    "https://demo.aomlms.com/api/coupon/delete" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"delete_ids\": [
        1,
        12,
        15
    ]
}"
const url = new URL(
    "https://demo.aomlms.com/api/coupon/delete"
);

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

let body = {
    "delete_ids": [
        1,
        12,
        15
    ]
};

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

Example response (200):


{
    "message": "2 coupon(s) deleted 1 coupon(s) not deleted as they are associated with orders"
}
 

Request   

POST api/coupon/delete

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

delete_ids   string[]   

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 --request GET \
    --get "https://demo.aomlms.com/api/modules/discussion?page_size=50&page_number=aliquid&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" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/modules/discussion"
);

const params = {
    "page_size": "50",
    "page_number": "aliquid",
    "order_by": "{"colName":"created_at", "direction": "desc"}}",
    "search_param": "{"associatedCourse":"","moduleName":""}",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "recordsTotal": 1,
    "recordsFiltered": 1,
    "records": [
        {
            "id": 13,
            "name": "First-discussion",
            "slug": "first-discussion",
            "type": "discussion",
            "totalPoints": 20,
            "icon": "<i class=\"el-icon-chat-line-round\"></i>",
            "author": "Aom Staff",
            "created_at": "Aug 11, 2020 05:25 AM"
        }
    ]
}
 

Request   

GET api/modules/discussion

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Query Parameters

page_size   string   

The number of the items you want for a page. Example: 50

page_number   string   

Current page number in pagination. Example: aliquid

order_by   string  optional  

For ordering items based on columns provided in JSON format. Example: {"colName":"created_at", "direction": "desc"}}

search_param   string  optional  

For searching items based on field names. Example: {"associatedCourse":"","moduleName":""}

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 --request POST \
    "https://demo.aomlms.com/api/modules/discussion" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"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"
);

const 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,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "id": 13,
    "message": "Module saved successfully"
}
 

Request   

POST api/modules/discussion

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

name   string   

Name of the discussion module. Example: First-discussion

content   string   

Content for the discussion modules that students will see. Example: A brief description

should_be_evaluated   boolean   

If true, the discussion will be graded on course evaluation. Example: true

totalPoints   integer  optional  

Total points a student can get by completing this discussion. Example: 20

minComments   integer  optional  

At least these many comments should be provided by the student to pass the discussion(required if should_be_evaluated is true). Example: 3

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 --request PUT \
    "https://demo.aomlms.com/api/modules/discussion/{id}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}" \
    --data "{
    \"name\": \"First-discussion\",
    \"content\": \"An updatedbrief description\",
    \"should_be_evaluated\": true,
    \"totalPoints\": 20,
    \"minComments\": 5
}"
const url = new URL(
    "https://demo.aomlms.com/api/modules/discussion/{id}"
);

const 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,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response (200):


{
    "message": "Module updated successfully"
}
 

Request   

PUT api/modules/discussion/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}

Body Parameters

name   string   

Name of the discussion module. Example: First-discussion

content   string   

Content for the discussion modules that students will see. Example: An updatedbrief description

should_be_evaluated   boolean   

If true, the discussion will be graded on course evaluation. Example: true

totalPoints   integer  optional  

Total points a student can get by completing this discussion. Example: 20

minComments   integer  optional  

At least these many comments should be provided by the student to pass the discussion(required if should_be_evaluated is true). Example: 5

Retrieve Discussion modules

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

Example request:
curl --request GET \
    --get "https://demo.aomlms.com/api/modules/discussion/13" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"
const url = new URL(
    "https://demo.aomlms.com/api/modules/discussion/13"
);

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

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

Example response (200):


{
    "name": "First-discussion",
    "slug": "first-discussion",
    "content": "A Brief Description",
    "totalPoints": 20,
    "should_be_evaluated": true,
    "minComments": 3
}
 

Request   

GET api/modules/discussion/{id}

Headers

Content-Type      

Example: application/json

Accept      

Example: application/json

Authorization      

Example: Bearer {token}