FAQ Categories

This guide explains how to interact with the admin manage the faq categories crud.

Get All FAQ Categories

Endpoint

• Method: GET
• URL: /v1/admin/faq-categories

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Query Parameters

Parameter	Type	Description	Required	Default
search_text	string	FAQ Category's name	No	null

Success Response

{
    "success": true,
    "message": "تم جلب بيانات المدرب بنجاح",
    "data": {
         "faqCategories": [
            {
                "id": "uuid",
                "name": "تجربة",
                "isAvailable": false,
                "priority": 12,
                "faqsCount": 0
            },
        ]
    },
    "statusCode": 200
}

Error Response

Unauthorized (401)

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Show FAQ Category

Endpoint

• Method: GET
• URL: /v1/admin/faq-categories/{id}

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Success Response

{
    "success": true,
    "message": "تم جلب البيانات بنجاح.",
    "data": {
        "id": "text",
        "question": "text",
        "answer": "<p>text</p>",
        "type": 1,
        "isAvailable": true,
        "priority": 2,
        "faqCategory": {
            "id": "uuid",
            "name": "الاشتراك في المواد"
        }
    },
    "statusCode": 200
}

Error Response

Unauthorized (401)

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Recored Not Found (404)

{
    "success": false,
    "message": "لم يتم العثور على السجل",
    "data": [],
    "statusCode": 404
}

Create FAQ Category

Endpoint

• Method: PATCH
• URL: /v1/admin/faq-categories

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Request Body

Parameter	Type	Description	Required
name	string	FAQ Category's name	Yes
is_available	string	FAQ Category's is available	Yes
priority	string	FAQ Category's priority	No

Success Response

{
    "success": true,
    "message": "تم جلب البيانات بنجاح.",
    "data": {
        "id": "text",
        "question": "text",
        "answer": "<p>text</p>",
        "type": 1,
        "isAvailable": true,
        "priority": 2,
        "faqCategory": {
            "id": "uuid",
            "name": "الاشتراك في المواد"
        }
    },
    "statusCode": 200
}

Error Response

Unauthorized (401)

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Update FAQ Category

Endpoint

• Method: PATCH
• URL: /v1/admin/faq-categories/{id}

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Request Body

Parameter	Type	Description	Required
name	string	FAQ Category's name	No
is_available	string	FAQ Category's is available	NO
priority	string	FAQ Category's priority	No

Success Response

{
    "success": true,
    "message": "تم جلب البيانات بنجاح.",
    "data": {
        "id": "text",
        "question": "text",
        "answer": "<p>text</p>",
        "type": 1,
        "isAvailable": true,
        "priority": 2,
        "faqCategory": {
            "id": "uuid",
            "name": "الاشتراك في المواد"
        }
    },
    "statusCode": 200
}

Error Response

Unauthorized (401)

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Recored Not Found (404)

{
    "success": false,
    "message": "لم يتم العثور على السجل",
    "data": [],
    "statusCode": 404
}

Delete FAQ Category

Endpoint

• Method: DELETE
• URL: /v1/admin/faq-categories

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Request Body

Parameter	Type	Description	Required
ids	array	FAQ Category's id	No

Success Response

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

Recored Not Found (404)

{
    "success": false,
    "message": "لم يتم العثور على السجل",
    "data": [],
    "statusCode": 404
}