Coach Categories
This guide explains how to interact with the admin manage the coach's categories crud.
Get All Coach Categories
Endpoint
- Method: GET
- URL:
/v1/admin/coach-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 | Coach Category's name, description | No | null |
Success Response
{
"success": true,
"message": "تم جلب بيانات المدرب بنجاح",
"data": {
"coachCategories": [
{
"id": "uuid",
"categoryName": "مجال الوعي",
"categoryDescription": "hikolkلتاتلات",
"priority": 8,
"status": true,
"photo": "https://coach_category.jpg",
"deepSpecializations": []
},
]
},
"statusCode": 200
}
Error Response
Unauthorized (401)
{
"success": false,
"message": "يجب عليك تسجيل الدخول",
"data": [],
"statusCode": 401
}
Show Coach Category
Endpoint
- Method: GET
- URL:
/v1/admin/coach-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": "uuid",
"categoryName": "مجال الوعي",
"categoryDescription": "hikolkلتاتلات",
"priority": 8,
"status": true,
"photo": "https://coach_category.jpg",
"deepSpecializations": []
},
"statusCode": 200
}
Error Response
Unauthorized (401)
{
"success": false,
"message": "يجب عليك تسجيل الدخول",
"data": [],
"statusCode": 401
}
Recored Not Found (404)
{
"success": false,
"message": "لم يتم العثور على السجل",
"data": [],
"statusCode": 404
}
Create Coach Category
Endpoint
- Method: POST
- URL:
/v1/admin/coach-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 |
|---|---|---|---|
| category_name | string | Coach Category's name | Yes |
| priority | integer | Coach Category's priority | Yes |
| category_description | string | Coach Category's description | Yes |
| status | string | Coach Category's status | Yes |
| session_setting_direct_type_id | string | Coach Category's session setting direct type id | Yes |
| session_setting_scheduled_type_id | string | Coach Category's session setting scheduled type id | Yes |
| photo | file | Coach Category's photo | No |
| session_setting_free_type_id | string | Coach Category's priority | No |
| deep_specializations | array | Coach Category's deep specializations | No |
Success Response
{
"success": true,
"message": "تم حفظ البيانات بنجاح.",
"data": {
"id": "uuid",
"categoryName": "مجال الوعي",
"categoryDescription": "hikolkلتاتلات",
"priority": 8,
"status": true,
"photo": "https://coach_category.jpg",
"deepSpecializations": []
},
"statusCode": 200
}
Error Response
Unauthorized (401)
{
"success": false,
"message": "يجب عليك تسجيل الدخول",
"data": [],
"statusCode": 401
}
Update Coach Category
Endpoint
- Method: PATCH
- URL:
/v1/admin/coach-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 |
|---|---|---|---|
| category_name | string | Coach Category's name | No |
| priority | integer | Coach Category's priority | No |
| category_description | string | Coach Category's description | No |
| status | string | Coach Category's status | No |
| photo | file | Coach Category's photo | No |
| deep_specializations | array | Coach Category's deep specializations | No |
Success Response
{
"success": true,
"message": "تم تحديث البيانات بنجاح.",
"data": {
"id": "uuid",
"categoryName": "مجال الوعي",
"categoryDescription": "hikolkلتاتلات",
"priority": 8,
"status": true,
"photo": "https://coach_category.jpg",
"deepSpecializations": []
},
"statusCode": 200
}
Error Response
Unauthorized (401)
{
"success": false,
"message": "يجب عليك تسجيل الدخول",
"data": [],
"statusCode": 401
}
Recored Not Found (404)
{
"success": false,
"message": "لم يتم العثور على السجل",
"data": [],
"statusCode": 404
}
Delete Coach Category
Endpoint
- Method: DELETE
- URL:
/v1/admin/coach-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 | Coach Category's id | No |
Success Response
{
"success": true,
"message": "تم حذف البيانات بنجاح.",
"data": [],
"statusCode": 200
}
Error Response
Recored Not Found (404)
{
"success": false,
"message": "لم يتم العثور على السجل",
"data": [],
"statusCode": 404
}