Session Settings
This guide explains how to interact with the admin manage the session settings crud.
Get All Session Settings
Endpoint
- Method: GET
- URL:
/v1/admin/session-settings
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 | Session Setting's name and duration | No | null |
Success Response
{
"success": true,
"message": "تم جلب بيانات المدرب بنجاح",
"data": {
"sessionSettings": [
{
"id": "uuid",
"name": "جلسة مباشرة",
"duration": 60,
"price": "23.00 - 2000.00",
"type": "DIRECT",
"categories": [
"استشارة تربوية",
"استشارة حرة",
"استشارة طبية",
"استشارة مال",
"مجال الوعي",
"استشارة طبية"
],
"isActive": true
},
]
},
"statusCode": 200
}
Error Response
Unauthorized (401)
{
"success": false,
"message": "يجب عليك تسجيل الدخول",
"data": [],
"statusCode": 401
}
Show Session Setting
Endpoint
- Method: GET
- URL:
/v1/admin/session-settings/{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",
"name": "جلسة مباشرة",
"duration": 60,
"isFree": false,
"levelsWithPrice": [
{
"levelId": "uuid",
"levelName": "levelName",
"price": 2000
},
],
"price": "23.00 - 2000.00",
"type": "DIRECT",
"categories": [
{
"id": "uuid",
"name": "استشارة تربوية"
},
],
"usabilityCount": -1,
"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 Session Setting
Endpoint
- Method: POST
- URL:
/v1/admin/session-settings
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 | Session Setting's degree | Yes |
| duration | integer | Session Setting's duration | Yes |
| is_free | bool | Session Setting's is free | Yes |
| levels | array | Session Setting's levels | Yes |
| type | string | Session Setting's type | Yes |
| create_without_categories | bool | Session Setting's create without categories | Yes |
| add_all_categories | bool | Session Setting's add all categories | Yes |
| categories | array | Session Setting's categories ids | Yes |
| usability_count | integer | Session Setting's usability count | Yes |
| is_available | bool | Session Setting's is available | Yes |
Success Response
{
"success": true,
"message": "تم حفظ البيانات بنجاح.",
"data": {
"id": "uuid",
"name": "جلسة مباشرة",
"duration": 60,
"isFree": false,
"levelsWithPrice": [
{
"levelId": "uuid",
"levelName": "levelName",
"price": 2000
},
],
"price": "23.00 - 2000.00",
"type": "DIRECT",
"categories": [
{
"id": "uuid",
"name": "استشارة تربوية"
},
],
"usabilityCount": -1,
"isActive": true
},
"statusCode": 200
}
Error Response
Unauthorized (401)
{
"success": false,
"message": "يجب عليك تسجيل الدخول",
"data": [],
"statusCode": 401
}
Update Session Setting
Endpoint
- Method: PATCH
- URL:
/v1/admin/session-settings/{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 | Session Setting's degree | No |
| duration | integer | Session Setting's duration | No |
| is_free | bool | Session Setting's is free | No |
| levels | array | Session Setting's levels | No |
| type | string | Session Setting's type | No |
| add_all_categories | bool | Session Setting's add all categories | No |
| categories | array | Session Setting's categories ids | No |
| usability_count | integer | Session Setting's usability count | No |
| is_available | bool | Session Setting's is available | No |
Success Response
{
"success": true,
"message": "تم تحديث البيانات بنجاح.",
"data": {
"id": "uuid",
"name": "جلسة مباشرة",
"duration": 60,
"isFree": false,
"levelsWithPrice": [
{
"levelId": "uuid",
"levelName": "levelName",
"price": 2000
},
],
"price": "23.00 - 2000.00",
"type": "DIRECT",
"categories": [
{
"id": "uuid",
"name": "استشارة تربوية"
},
],
"usabilityCount": -1,
"isActive": true
},
"statusCode": 200
}
Error Response
Unauthorized (401)
{
"success": false,
"message": "يجب عليك تسجيل الدخول",
"data": [],
"statusCode": 401
}
Recored Not Found (404)
{
"success": false,
"message": "لم يتم العثور على السجل",
"data": [],
"statusCode": 404
}
Update Session Setting Index
Endpoint
- Method: PATCH
- URL:
/v1/admin/session-settings
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 | Session Setting's id | Yes | null |
| is_available | array | Session Setting's is available | Yes | null |
Success Response
{
"success": true,
"message": "تم تحديث البيانات بنجاح.",
"data": [],
"statusCode": 200
}
Error Response
Recored Not Found (404)
{
"success": false,
"message": "لم يتم العثور على السجل",
"data": [],
"statusCode": 404
}
Delete Session Setting
Endpoint
- Method: DELETE
- URL:
/v1/admin/session-settings
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 | Session Setting's id | No |
Success Response
{
"success": true,
"message": "تم حذف البيانات بنجاح.",
"data": [],
"statusCode": 200
}
Error Response
Recored Not Found (404)
{
"success": false,
"message": "لم يتم العثور على السجل",
"data": [],
"statusCode": 404
}