Noor Alhai APIs

NOOR PROJECT API'S
============================================================================================================
URL_PREFIX: http://80.211.224.32:8060 # THIS PREFIX SHOULD BE USE BEFORE EVERY CONTROLLER URL
DB_NAME: NOOR
USERNAME: admin
PASSWORD: admin
METHOD: POST
============================================================================================================

LOGIN API:

/web/session/authenticate

params:
db : DB_NAME
login : USERNAME
password : PASSWORD

OUTPUT:
{"jsonrpc": "2.0", "id": null, "result": {"username": "admin", "user_context": {"lang": "en_US", "tz": "Europe/Brussels", "uid": 1}, "uid": 1, "db": "NOOR", "company_id": 1, "session_id": "dd71c88b6827456ee1bac1bd4e9649c12f8ca607", "partner_id": 3}}

============================================================================================================
SIGNUP API:

/web/user/signup

params:
full_name
login
password
image
age
address
phone_number
work
grade
user_type

OUTPUT:
{"jsonrpc": "2.0", "id": null, "result": [{"status": "draft", "phone_number": "", "grade": "", "age": 0, "work": "", "user_type": false, "mosque_id": false, "image": false, "address": "", "login": "tttt", "id": 108}]}

============================================================================================================
GET USER INFO
/noor/user/info
PARAMS:
uid
REUSLTS:
{"jsonrpc": "2.0", "id": null, "result": [{"phone_number": false, "status": "draft", "grade": false, "age": 0, "work": false, "user_type": "student", "mosque_id": false, "image": "base64 encoded string", "address": false, "login": "admin", "id": 1}]}
============================================================================================================
SET PRIVACY:

/noor/privacy/setup

params:
uid
show_age
show_work
show_memorization
show_identity

OUTPUT:
{"jsonrpc": "2.0", "id": null, "result": true}

============================================================================================================
REVIEW PRIVACY:

/noor/privacy/review

params:
uid

OUTPUT:
{"jsonrpc": "2.0", "id": null, "result": [{"show_memorization": false, "show_work": false, "id": 1, "show_identity": false, "show_age": false}]}
============================================================================================================
get_all_workshops:

/noor/workshop/all

params:

OUTPUT:
{"jsonrpc": "2.0", "id": null, "result": [{"teacher_id": [2, "Antoine Langlais"], "name": "\u062d\u0644\u0642\u0629 1", "students": [2, 12, 6, 11, 7, 13], "mosque_id": [1, "\u0645\u0633\u062c\u062f \u0627\u0644\u0627\u0646\u0635\u0627\u0631"], "id": 1, "desc": "demo description about the workshop"}, {"teacher_id": [2, "Antoine Langlais"], "name": "\u062d\u0644\u0642\u0629 2", "students": [8, 20, 22], "mosque_id": [2, "\u0645\u0633\u062c\u062f \u0627\u0644\u0647\u062f\u0649"], "id": 2, "desc": "demo description about the workshop"}]}

============================================================================================================
get_all_sur:

/noor/sur/all

params

OUTPUT:
{"jsonrpc": "2.0", "id": null, "result": [{"desc": false, "no_verses": 7, "id": 1, "name": "\u0627\u0644\u0641\u0627\u062a\u062d\u0629"}, {"desc": "\u0645\u0643\u064a\u0629 ", "no_verses": 286, "id": 2, "name": "\u0633\u0648\u0631\u0629 \u0627\u0644\u0628\u0642\u0631\u0629"}, {"desc": "\u0645\u062f\u0646\u064a\u0629", "no_verses": 200, "id": 3, "name": "\u0633\u0648\u0631\u0629 \u0622\u0644 \u0639\u0645\u0631\u0627\u0646"}]}
============================================================================================================
GET TEACHER WORKSHOPS
/noor/workshop/teacher
PARAMS:
teahcer_id
REUSLTS:
{"jsonrpc": "2.0", "id": null, "result": [{"teacher_id": [1, "Administrator"], "name": "\u062d\u0644\u0642\u0629 \u0627\u0628\u0648\u0645\u062d\u0645\u062f", "students": [1, 6], "mosque_id": [3, "\u0627\u0644\u0645\u0633\u062c\u062f \u0627\u0644\u0642\u062f\u064a\u0645"], "id": 5, "desc": "\u062d\u0644\u0642\u0629 \u0644\u0637\u0644\u0627\u0628 \u0627\u0644\u0641\u062a\u0631\u0629 \u0627\u0644\u0645\u0633\u0627\u0626\u064a\u0629"}]}
============================================================================================================
get_workshop_students:

/noor/workshop/students

params:
workshop_id

OUTPUT params:

{
"result" : [{"id": 1,
"login": "mohamed",
"image": "Base64Image"},
{"id": 2,
"login": "ali",
"image": "Base64Image"}]
}

============================================================================================================
get_student_memorization:

/noor/student/memorization

params:
student_id

============================================================================================================
get_student_revision:

/noor/student/revision

params:
student_id

============================================================================================================
get_student_attendance:

/noor/student/attendance

params:
student_id

============================================================================================================
get_student_attitude:

/noor/student/attitude

params:
student_id

============================================================================================================
create_memorization:

/noor/memorization/create

params:
student_id
date
sura_id
start_verse
end_verse
evaluation
notes

OUTPUT params:
Success or failure

============================================================================================================
create_revision:

/noor/revision/create

params:
student_id
date
sura_id
start_verse
end_verse
evaluation
notes

OUTPUT params:
Success or failure

============================================================================================================
get_student_attendance_status:

/noor/student/attendance/status

params:
student_id
date

OUTPUT params:

{
"result" : [{"student_id": 1,
"notes": "Excellent",
"action": "present"}] //action = "present" or "absent" or "exception"
}

============================================================================================================
get_student_attitude_status:

/noor/student/attitude/status

params:
student_id
date

OUTPUT params:

{
"result" : [{"student_id": 1,
"notes": "Excellent",
"evaluation": 4.5}] // evaluation: five star rating
}

============================================================================================================
create_student_attitude:

/noor/student/attitude/create

params:
student_id
date
notes
evaluation

OUTPUT params:
Success or failure

============================================================================================================
get_student_connection:

/noor/student/connections

params:
uid

OUTPUT params:

{
"result" : [{"id": 1,
"login": "mohamed",
"image": "Base64Image"},
{"id": 2,
"login": "ali",
"image": "Base64Image"}]
}

============================================================================================================
create_student_connection:

/noor/student/new_connection

params:
login
uid

OUTPUT params:
Success or failure

============================================================================================================
create_student_attitude:

/noor/student/attitude/create

params:
student_id
date
notes

============================================================================================================
get_template_types:

/noor/template/types

params:

OUTPUT params:
{
"result" : [{"id": 1,
"name": "News & Events",
"desc": "Latest news from Noor Alhai app"},
{"id": 2,
"name": "Competitions",
"desc": "Compete with students in Quran memorization"}]
}

============================================================================================================
get_templates_by_type:

/noor/template/by_type

params:
type_id

OUTPUT params:
{
"result" : [{"id": 1,
"name": "News & Events",
"image": "Base64Image",
"desc": "Latest news from Noor Alhai app"},
{"id": 2,
"name": "Competitions",
"image": "Base64Image"
"desc": "Compete with students in Quran memorization"}]
}

============================================================================================================
approve_connection_request:

/noor/connection/approve

params:
uid
connection_id

============================================================================================================
get_workshops_per_students_number:

/noor/reports/students_number

params:

OUTPUT params:

{
"result" : [{
"name": "Alhuda Workshop",
"students_number": 22},
{
"name": "New Workshop",
"students_number": 14}]
}

============================================================================================================
get_workshops_per_evaluation:

/noor/reports/workshop_evaluation

params:
frequency ["day", "week", "month", "year"]

OUTPUT params:

{
"result" : [{
"evaluation": 1,
"workshop_id": [1, "Alhuda Workshop"]},
{
"evaluation": 3,
"workshop_id": [1, "Alhuda Workshop"]}]
}

============================================================================================================
get_workshops_per_attendance:

/noor/reports/workshop_attendance

params:
frequency ["day", "week", "month", "year"]

{
"result" : [{
"attendance": 2,
"workshop_id": [1, "Alhuda Workshop"]},
{
"attendance": 4,
"workshop_id": [1, "Alhuda Workshop"]}]
}

============================================================================================================
get_students_per_evaluation:

/noor/reports/students_evaluation

params:
frequency
workshop_id

{
"result" : [{
"evaluation": 1,
"student_id": [1, "Mohamed Jaafar"]},
{
"evaluation": 3,
"student_id": [1, "Mohamed Jaafar"]}]
}
============================================================================================================
get_students_per_attendance:

/noor/reports/students_attendance

params:
frequency
workshop_id

{
"result" : [{
"attendance": 1,
"student_id": [1, "Mohamed Jaafar"]},
{
"attendance": 3,
"student_id": [1, "Mohamed Jaafar"]}]
}

============================================================================================================
get_available_reports_dates_students:

/noor/reports/available_students_dates

params:


============================================================================================================
get_available_reports_dates_workshops:

/noor/reports/available_workshops_dates

params:


============================================================================================================
get_latest_attitude:

/noor/attitude/latest

params:
student_id


============================================================================================================
get_latest_attendance:

/noor/attendance/latest

params:
student_id


============================================================================================================
get_latest_revision:

/noor/revision/latest

params:
student_id
============================================================================================================
get_latest_memorization:

/noor/memorization/latest

params:
student_id


============================================================================================================
get_latest_workshop:

/noor/workshop/latest

params:
student_id


============================================================================================================
Newly Added APIS
============================================================================================================
Memorization Dates :

/noor/memorization_dates

params:
none

OUTPUT params:

{
"result" : [{"date": "MM-dd-yyyy"},
{"date": "MM-dd-yyyy"}]
}

============================================================================================================
Get memorization by date :

/noor/student/memorization/date

params:
date
student_id

OUTPUT params:

{
"result" : [{"sura_id": [1, "Alfatihah"],
            "start_verse": 1,
            "end_verse": 9,
            "notes": "Good",
            "evaluation": 4.5},
            {"sura_id": [1, "Alfatihah"],
            "start_verse": 1,
            "end_verse": 9,
            "notes": "Good",
            "evaluation": 4.5}]
}

============================================================================================================
Get revision by date :

/noor/student/revision/date

params:
date
student_id

OUTPUT params:

{
"result" : [{"sura_id": [1, "Alfatihah"],
            "start_verse": 1,
            "end_verse": 9,
            "notes": "Good",
            "evaluation": 4.5},
            {"sura_id": [1, "Alfatihah"],
            "start_verse": 1,
            "end_verse": 9,
            "notes": "Good",
            "evaluation": 4.5}]
}