Month Note
This section covers the API endpoints for managing month notes in the admin panel.
List Month Notes
GET /v1/admin/month-notes
Returns a paginated list of all month notes.
Query Parameters
| Parameter | Type | Description |
|---|---|---|
search_text | string | Search notes by name |
filter[displayed] | boolean | Filter by display status |
filter[selected] | boolean | Filter by selected status |
filter[trashed] | boolean | Include trashed notes |
sort | string | Sort by field (prefix with - for descending) |
per_page | integer | Number of items per page. Defaults to 10 |
Response
{
"success": true,
"message": "تم جلب البيانات بنجاح.",
"data": {
"current_page": 1,
"first_page_url": "http://192.168.0.139:8080/v1/admin/month-notes?page=1",
"from": 1,
"last_page": 3,
"last_page_url": "http://192.168.0.139:8080/v1/admin/month-notes?page=3",
"links": [
{
"url": null,
"label": "« السابق",
"active": false
},
{
"url": "http://192.168.0.139:8080/v1/admin/month-notes?page=1",
"label": "1",
"active": true
},
{
"url": "http://192.168.0.139:8080/v1/admin/month-notes?page=2",
"label": "2",
"active": false
},
{
"url": "http://192.168.0.139:8080/v1/admin/month-notes?page=3",
"label": "3",
"active": false
},
{
"url": "http://192.168.0.139:8080/v1/admin/month-notes?page=2",
"label": "التالي »",
"active": false
}
],
"next_page_url": "http://192.168.0.139:8080/v1/admin/month-notes?page=2",
"path": "http://192.168.0.139:8080/v1/admin/month-notes",
"per_page": 10,
"prev_page_url": null,
"to": 10,
"total": 25,
"month_notes": [
{
"id": "08780df0-c9df-11ef-964d-b7659da5aee0",
"name": "مفكرة الثراء",
"date": "2025-01-03",
"custom_date": "2025 Jan",
"note_file": "http://192.168.0.139:8080/storage/28627/مفكرة-الثراء.pdf",
"displayed": true,
"selected": true,
"created_at": "2025-01-01 00:00:00"
},
{
"id": "08b0b0a0-b09f-11ef-9c24-d56db39f83b7",
"name": "مفكرة نية الاستعداد للعام القادم",
"date": "2024-12-02",
"custom_date": "2024 Dec",
"note_file": "http://192.168.0.139:8080/storage/27496/مفكرة-الاستعداد-للعام-القادم.pdf",
"displayed": true,
"selected": false,
"created_at": "2025-01-01 00:00:00"
},
{
"id": "4662efc0-9940-11ef-848d-0dfa37544b82",
"name": "التحرر من الصدمات",
"date": "2024-11-02",
"custom_date": "2024 Nov",
"note_file": "http://192.168.0.139:8080/storage/26377/مفكرة-التحرر-من-الصدمات.pdf",
"displayed": true,
"selected": false,
"created_at": "2025-01-01 00:00:00"
},
{
"id": "50478b80-8096-11ef-8f22-4da7df944946",
"name": "التنظيف 2024",
"date": "2024-10-01",
"custom_date": "2024 Oct",
"note_file": "http://192.168.0.139:8080/storage/25456/مفكرة-التنظيف.pdf",
"displayed": true,
"selected": false,
"created_at": "2025-01-01 00:00:00"
},
{
"id": "10424950-67ea-11ef-a63c-8baa97938799",
"name": "العظمة",
"date": "2024-09-01",
"custom_date": "2024 Sep",
"note_file": "http://192.168.0.139:8080/storage/24915/مفكرة-العظمة.pdf",
"displayed": true,
"selected": false,
"created_at": "2025-01-01 00:00:00"
},
{
"id": "bd6c0920-52f7-11ef-8427-4579ea6974e0",
"name": "نية المتعة 2024",
"date": "2024-08-01",
"custom_date": "2024 Aug",
"note_file": "http://192.168.0.139:8080/storage/24450/مفكرة-المتعة-2024.pdf",
"displayed": true,
"selected": false,
"created_at": "2025-01-01 00:00:00"
},
{
"id": "1abca340-3782-11ef-b625-c9ceb23193d9",
"name": "توازن الأنوثة والذكورة",
"date": "2024-07-01",
"custom_date": "2024 Jul",
"note_file": "http://192.168.0.139:8080/storage/23757/مفكرة-توازن-الذكورة-والانوثة.pdf",
"displayed": true,
"selected": false,
"created_at": "2025-01-01 00:00:00"
},
{
"id": "deaaa0c0-20c5-11ef-8f64-999e1a7829fd",
"name": "تشافي العلاقات",
"date": "2024-06-01",
"custom_date": "2024 Jun",
"note_file": "http://192.168.0.139:8080/storage/23244/مفكرة-تشافي-العلاقات.pdf",
"displayed": true,
"selected": false,
"created_at": "2025-01-01 00:00:00"
},
{
"id": "8290fac0-0797-11ef-8bb0-6b1e469387bb",
"name": "تطوير الجسد المشاعري",
"date": "2024-05-01",
"custom_date": "2024 May",
"note_file": "http://192.168.0.139:8080/storage/22678/مفكرة-تطوير-الجسد-المشاعري.pdf",
"displayed": true,
"selected": false,
"created_at": "2025-01-01 00:00:00"
},
{
"id": "762b3320-f2c3-11ee-a07e-3358d74636f7",
"name": "الحظ",
"date": "2024-04-02",
"custom_date": "2024 Apr",
"note_file": "http://192.168.0.139:8080/storage/22256/مفكرة-الحظ-.pdf",
"displayed": true,
"selected": false,
"created_at": "2025-01-01 00:00:00"
}
]
},
"status_code": 200
}
Create Month Note
POST /v1/admin/month-notes
Create a new month note.
Request Body
| Parameter | Type | Description | Validation Rules |
|---|---|---|---|
name | string | Note name | Required, 3-255 characters |
date | string | Note date | Required, format: Y-m-d |
displayed | boolean | Display status | Optional |
selected | boolean | Selected status | Optional |
note_file | file | Note PDF file | Required, max: 1MB, type: pdf |
Response
{
"success": true,
"message": "تم حفظ البيانات بنجاح.",
"data": {
"id": "94569670-0590-11f0-a2b3-77dd82828c05",
"name": "student4",
"date": "1974-01-11",
"custom_date": "1974 Jan",
"note_file": "/storage/29009/Mobile_Service_Regions.pdf",
"displayed": true,
"selected": null,
"created_at": "2025-03-20 16:38:17"
},
"status_code": 200
}
Get Month Note
GET /v1/admin/month-notes/{id}
Retrieve details of a specific month note.
Response
{
"success": true,
"message": "تم جلب البيانات بنجاح.",
"data": {
"id": "08780df0-c9df-11ef-964d-b7659da5aee0",
"name": "مفكرة الثراء",
"date": "2025-01-03",
"custom_date": "2025 Jan",
"note_file": "http://192.168.0.139:8080/storage/28627/مفكرة-الثراء.pdf",
"displayed": true,
"selected": true,
"created_at": "2025-01-03 17:28:42"
},
"status_code": 200
}
Update Month Note
PATCH /v1/admin/month-notes/{id}
Update an existing month note.
Request Body
| Parameter | Type | Description | Validation Rules |
|---|---|---|---|
name | string | Note name | Optional, 3-255 characters |
date | string | Note date | Optional, format: Y-m-d |
displayed | boolean | Display status | Optional |
selected | boolean | Selected status | Optional |
note_file | file | Note PDF file | Optional, max: 1MB, type: pdf |
Response
{
"success": true,
"message": "تم تحديث البيانات بنجاح.",
"data": {
"id": "94569670-0590-11f0-a2b3-77dd82828c05",
"name": "sdsdasd",
"date": "1974-01-11",
"custom_date": "1974 Jan",
"note_file": "/storage/29009/Mobile_Service_Regions.pdf",
"displayed": true,
"selected": false,
"created_at": "2025-03-20 16:38:17"
},
"status_code": 200
}
Bulk Update Month Notes
PATCH /v1/admin/month-notes
Update or delete multiple month notes at once.
Request Body
| Parameter | Type | Description | Validation Rules |
|---|---|---|---|
ids | array | Array of note UUIDs to update | Required |
ids.* | string | UUID format | Required |
selected | boolean | Set selected status for all notes | Optional, true/false |
delete | boolean | Delete all specified notes | Optional, true/false |
Response
{
"success": true,
"message": "تم تحديث البيانات بنجاح.",
"data": null,
"status_code": 200
}
Delete Month Notes
DELETE /v1/admin/month-notes
Delete one or more month notes.
Request Body
| Parameter | Type | Description | Validation Rules |
|---|---|---|---|
ids | array | Array of note UUIDs to delete | Required |
ids.* | string | UUID format | Required |
confirm_deletion | boolean | Set to true for permanent deletion | Optional |
Response
{
"success": true,
"message": "تم حذف البيانات بنجاح.",
"data": null,
"status_code": 200
}
Download Note
GET /v1/admin/month-notes/download/{id}
Download the PDF file of a specific month note.
Response
Returns the PDF file as a downloadable stream.
Notes
- When a note is marked as selected, any previously selected note will be automatically unselected
- The note file must be in PDF format and less than 1MB in size
- Soft deletion is supported for notes, with the option for permanent deletion using confirm_deletion parameter