Cancel Reasons

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

Get All Cancel Reasons

Endpoint

• Method: GET
• URL: /v1/admin/cancel-reasons

Request Headers

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

Success Response

{
    "success": true,
    "message": "تم جلب بيانات المدرب بنجاح",
    "data": {
        "cancelReasons": [
            {
                "id": "uuid",
                "reason": "مازن تست",
                "active": false
            },
        ]
    },
    "statusCode": 200
}

Error Response

Unauthorized (401)

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

Show Cancel Reason

Endpoint

• Method: GET
• URL: /v1/admin/cancel-reasons/{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",
        "reason": "مازن تست",
        "active": false,
        "partialDuesStatus": true
    },
    "statusCode": 200
}

Error Response

Unauthorized (401)

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

Recored Not Found (404)

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

Create Cancel Reason

Endpoint

• Method: POST
• URL: /v1/admin/cancel-reasons

Request Headers

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

Request Body

Parameter	Type	Description	Required
reason	string	Cancel Reason's reason	Yes
active	bool	Cancel Reason's active	Yes
partial_dues_status	bool	Cancel Reason's partial dues status	Yes

Success Response

{
    "success": true,
    "message": "تم حفظ البيانات بنجاح.",
    "data": {
        "id": "uuid",
        "reason": "مازن تست",
        "active": false,
        "partialDuesStatus": true
    },
    "statusCode": 200
}

Error Response

Unauthorized (401)

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

Update Cancel Reason

Endpoint

• Method: PATCH
• URL: /v1/admin/cancel-reasons/{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
reason	string	Cancel Reason's reason	No
active	bool	Cancel Reason's active	No
partial_dues_status	bool	Cancel Reason's partial dues status	No

Success Response

{
    "success": true,
    "message": "تم تحديث البيانات بنجاح.",
    "data": {
        "id": "uuid",
        "reason": "مازن تست",
        "active": false,
        "partialDuesStatus": true
    },
    "statusCode": 200
}

Error Response

Unauthorized (401)

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

Recored Not Found (404)

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

Update Cancel Reason Index

Endpoint

• Method: PATCH
• URL: /v1/admin/cancel-reasons

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
ids	array	Cancel Reason's id	Yes	null
active	array	Cancel Reason's active	Yes	null

Success Response

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

Error Response

Recored Not Found (404)

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

Delete Cancel Reason

Endpoint

• Method: DELETE
• URL: /v1/admin/cancel-reasons

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

Success Response

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

Error Response

Recored Not Found (404)

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