Skip to main content

FAQ Categories

This section covers the API endpoints for managing FAQ categories. These endpoints allow administrators to create, view, update, and delete FAQ categories.

List FAQ Categories

Retrieve a paginated list of FAQ categories.

GET /v1/admin/faq-categories

Query Parameters

ParameterTypeDescription
filter[is_available]booleanFilter by availability status
search_textstringSearch in category name
per_pageintegerNumber of items per page (default: 15)
sortstringSort by priority (prefix with - for descending)
listbooleanIf true, returns unpaginated list of all categories

Response

{
"success": true,
"message": "تم جلب البيانات بنجاح.",
"data": {
"current_page": 1,
"first_page_url": "http://192.168.0.139:8080/v1/admin/faq-categories?current_page=2&page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://192.168.0.139:8080/v1/admin/faq-categories?current_page=2&page=1",
"links": [
{
"url": null,
"label": "« السابق",
"active": false
},
{
"url": "http://192.168.0.139:8080/v1/admin/faq-categories?current_page=2&page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "التالي »",
"active": false
}
],
"next_page_url": null,
"path": "http://192.168.0.139:8080/v1/admin/faq-categories",
"per_page": 15,
"prev_page_url": null,
"to": 10,
"total": 10,
"faq_categories": [
{
"id": "7c745ee0-39bd-11ee-a2bc-bf1e549fbddb",
"name": "نوعية المواد",
"priority": 1,
"is_available": true
},
{
"id": "882267e0-d9c0-11ed-b82c-f36eb8a9be8a",
"name": "النقاط والمستويات",
"priority": 9,
"is_available": true
},
{
"id": "dd945720-cd2a-11ed-99a6-7dbf4566b8df",
"name": "فئة خصم الطلاب",
"priority": 8,
"is_available": true
},
{
"id": "0eda0f30-4251-11ed-a7d2-a9fccd0f5a10",
"name": "المواد – المحتوى و التطبيق",
"priority": 4,
"is_available": true
},
{
"id": "0edb5a80-4251-11ed-9b30-a7e8c5d64d8e",
"name": "نافـا",
"priority": 5,
"is_available": true
},
{
"id": "0edca390-4251-11ed-b5f1-c19b50f125aa",
"name": "الدفع",
"priority": 6,
"is_available": true
},
{
"id": "0ede0a70-4251-11ed-b908-9d31203cd1a8",
"name": "التقسيط",
"priority": 7,
"is_available": true
},
{
"id": "0ed8a590-4251-11ed-b463-1bb83c1d6743",
"name": "الاشتراك في المواد",
"priority": 3,
"is_available": true
},
{
"id": "0edf5660-4251-11ed-8b81-5f3c94d1aa09",
"name": "استفسارات عامة",
"priority": 10,
"is_available": true
},
{
"id": "0ed576c0-4251-11ed-83d3-7135e4c193d7",
"name": "التسجيل في الموقع",
"priority": 2,
"is_available": true
}
]
},
"status_code": 200
}

Create FAQ Category

Create a new FAQ category.

POST /v1/admin/faq-categories

Request Body

ParameterTypeDescriptionValidation Rules
namestringCategory nameRequired, 3-255 characters, unique
is_availablebooleanAvailability statusRequired
priorityintegerDisplay priorityOptional, greater than 0

Response

{
"success": true,
"message": "تم حفظ البيانات بنجاح.",
"data": {
"id": "61f85a00-058c-11f0-8428-4507c4da266f",
"name": "الكون",
"priority": "15",
"is_available": true,
"created_at": "2025-03-20 16:08:14",
"updated_at": "2025-03-20 16:08:14"
},
"status_code": 200
}

Update FAQ Category

Update an existing FAQ category.

PATCH /v1/admin/faq-categories/{id}

Request Body

ParameterTypeDescriptionValidation Rules
namestringCategory name3-255 characters, unique
is_availablebooleanAvailability statusOptional
priorityintegerDisplay priorityOptional, greater than 0

Response

{
"success": true,
"message": "تم تحديث البيانات بنجاح.",
"data": {
"id": "7c745ee0-39bd-11ee-a2bc-bf1e549fbddb",
"name": "الكون 2",
"priority": 1,
"is_available": true
},
"status_code": 200
}

Delete FAQ Categories

Delete one or more FAQ categories.

DELETE /v1/admin/faq-categories

Request Body

ParameterTypeDescriptionValidation Rules
idsarrayArray of category IDsRequired
ids.*stringCategory UUIDRequired

Response

{
"success": true,
"message": "تم حذف البيانات بنجاح.",
"data": null,
"status_code": 200
}

View FAQ Category

Retrieve details of a specific FAQ category.

GET /v1/admin/faq-categories/{id}

Response

{
"success": true,
"message": "تم جلب البيانات بنجاح.",
"data": {
"id": "7c745ee0-39bd-11ee-a2bc-bf1e549fbddb",
"name": "نوعية المواد",
"priority": 1,
"is_available": true
},
"status_code": 200
}