FAQs

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

Get All FAQs

Endpoint

• Method: GET
• URL: /v1/admin/faqs

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's question	No	null

Success Response

{
    "success": true,
    "message": "تم جلب بيانات المدرب بنجاح",
    "data": {
         "faqs": [
            {
                "id": "uuis",
                "question": "text",
                "answer": "<p>gygyu</p>",
                "type": "المرشد",
                "isAvailable": true,
                "priority": 2,
                "faqCategoryId": "uuid",
                "faqCategoryName": "الاشتراك في المواد"
            },
        ]
    },
    "statusCode": 200
}

Error Response

Unauthorized (401)

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

Show FAQ

Endpoint

• Method: GET
• URL: /v1/admin/faqs/{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

Endpoint

• Method: PATCH
• URL: /v1/admin/faqs

Request Headers

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

Request Body

Parameter	Type	Description	Required
question	string	FAQ's question	Yes
answer	string	FAQ's answer	Yes
faq_category_id	string	FAQ's category id	Yes
is_available	string	FAQ's is available	Yes
type	string	FAQ's type	Yes
priority	string	FAQ's phone	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
}

Update FAQ

Endpoint

• Method: PATCH
• URL: /v1/admin/faqs/{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
question	string	FAQ's question	No
answer	string	FAQ's answer	No
faq_category_id	string	FAQ's category id	No
is_available	string	FAQ's is available	No
type	string	FAQ's type	No
priority	string	FAQ's phone	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

Endpoint

• Method: DELETE
• URL: /v1/admin/faqs

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's id	No

Success Response

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

Recored Not Found (404)

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