Pages

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

Get All Pages

Endpoint

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

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	Page's title, key...	No	null

Success Response

{
    "success": true,
    "message": "تم جلب بيانات المدرب بنجاح",
    "data": {
        "pages": [
            {
                "id": "uuid",
                "title": "الشروط والاحكام",
                "key": "customer-terms-and-conditions-with-privacy-policy",
                "link": "https://testing-customer.calwe.com/pages/customer-terms-and-conditions-with-privacy-policy",
                "canModified": true
            },
        ]
    },
    "statusCode": 200
}

Error Response

Unauthorized (401)

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

Show Page

Endpoint

• Method: GET
• URL: /v1/admin/pages/{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": "uuid",
        "title": "الشروط والاحكام",
        "description": "<p>أولاً الوقوف على الحقيقة من معنين: أحدهما يقوم منه مقام الطين للكرة في هذا النوع من النظر. ثم كان يرجع إلى أنواع للعميل</p><h2>شروط واحكام خاصه بالعميل</h2>",
        "type": null,
        "key": "customer-terms-and-conditions-with-privacy-policy",
        "link": "https://testing-customer.calwe.com/pages/customer-terms-and-conditions-with-privacy-policy",
        "priority": 100,
        "canModified": true,
        "loggedInOnly": true,
        "isActive": true
    },
    "statusCode": 200
}

Error Response

Unauthorized (401)

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

Recored Not Found (404)

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

Create Page

Endpoint

• Method: POST
• URL: /v1/admin/pages

Request Headers

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

Request Body

Parameter	Type	Description	Required
title	string	Page's title	Yes
type	string	Page's type	Yes
description	string	Page's description	Yes
key	string	Page's key	Yes
can_modified	bool	Page's can modified	Yes
logged_in_only	bool	For logged in user's only	Yes
is_active	bool	Page's active	Yes
priority	integer	Page's priority	No
meta	array	Page's meta	No

Success Response

{
    "success": true,
    "message": "تم حفظ البيانات بنجاح.",
    "data": {
        "id": "uuid",
        "title": "الشروط والاحكام",
        "description": "<p>أولاً الوقوف على الحقيقة من معنين: أحدهما يقوم منه مقام الطين للكرة في هذا النوع من النظر. ثم كان يرجع إلى أنواع للعميل</p><h2>شروط واحكام خاصه بالعميل</h2>",
        "type": null,
        "key": "customer-terms-and-conditions-with-privacy-policy",
        "link": "https://testing-customer.calwe.com/pages/customer-terms-and-conditions-with-privacy-policy",
        "priority": 100,
        "canModified": true,
        "loggedInOnly": true,
        "isActive": true
    },
    "statusCode": 200
}

Error Response

Unauthorized (401)

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

Update Page

Endpoint

• Method: PATCH
• URL: /v1/admin/pages/{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
title	string	Page's title	No
type	string	Page's type	No
description	string	Page's description	No
key	string	Page's key	No
can_modified	bool	Page's can modified	No
logged_in_only	bool	For logged in user's only	No
is_active	bool	Page's active	No
priority	integer	Page's priority	No
meta	array	Page's meta	No

Success Response

{
    "success": true,
    "message": "تم تحديث البيانات بنجاح.",
    "data": {
        "id": "uuid",
        "title": "الشروط والاحكام",
        "description": "<p>أولاً الوقوف على الحقيقة من معنين: أحدهما يقوم منه مقام الطين للكرة في هذا النوع من النظر. ثم كان يرجع إلى أنواع للعميل</p><h2>شروط واحكام خاصه بالعميل</h2>",
        "type": null,
        "key": "customer-terms-and-conditions-with-privacy-policy",
        "link": "https://testing-customer.calwe.com/pages/customer-terms-and-conditions-with-privacy-policy",
        "priority": 100,
        "canModified": true,
        "loggedInOnly": true,
        "isActive": true
    },
    "statusCode": 200
}

Error Response

Unauthorized (401)

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

Recored Not Found (404)

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

Delete Page

Endpoint

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

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

Success Response

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

Error Response

Recored Not Found (404)

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

Validation (422)

{
    "success": false,
    "message": "لا يمكنك الحذف! يرجاء التاكد من الحقل can_modified",
    "errors": [
        "لا يمكنك الحذف! يرجاء التاكد من الحقل can_modified"
    ],
    "data": [],
    "statusCode": 422
}