Skip to main content

Mentor's Appointments

This guide explains how to interact with the admin manage the mentor's appointments.

Get All Mentor's Appointments

Endpoint

  • Method: GET
  • URL: /v1/admin/coaches/{id}/appointments

Request Headers

HeaderValueRequired
Content-Typeapplication/jsonYes
Acceptapplication/jsonYes
AuthorizationBearer tokenYes

Success Response

{
"success": true,
"message": "تم حفظ البيانات بنجاح.",
"data": {
"appointments": [
{
"id": "uuid",
"start": "2025-04-16 19:20",
"end": "2025-04-16 20:20",
"date": "2025-04-16",
"time": "07:20 م",
"isBooked": false,
"sessionId": null,
"displayedTime": "07:20 م - 08:20 م",
"description": null,
"category": null,
"customerFullName": null,
"postponeStatus": null,
"canPostpone": false,
"canStartSession": false
}
],
"frozenAccount": []
},
"statusCode": 200
}

Error Responses

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

Create Mentor's Appointment

Endpoint

  • Method: POST
  • URL: /v1/admin/coaches/{id}/appointments

Request Headers

HeaderValueRequired
Content-Typeapplication/jsonYes
Acceptapplication/jsonYes
AuthorizationBearer tokenYes

Request Body

ParameterTypeDescriptionRequiredValidation Rules
startdateAppointments's start datetimeYesrequired, date
durationintAppointments's durationYesrequired, in:30,60

Success Response

{
"success": true,
"message": "تم حفظ البيانات بنجاح.",
"data": {
"id": "uuid",
"start": "2025-04-28 13:00",
"end": "2025-04-28 14:00",
"isBooked": false,
"coachId": "uuid",
"displayedTime": "01:00 م - 02:00 م",
"sessionId": null,
"duration": "60",
"canPostpone": false,
"coachFullname": "احمد البيتي",
"customerFullname": null
},
"statusCode": 200
}

Error Responses

{
"success": false,
"message": "حدث خطأ في البيانات المرسلة يرجى التحقق منها.",
"errors": {
"start": "الوقت أو التاريخ غير متاح."
},
"data": [],
"statusCode": 422
}
{
"success": false,
"message": "لم يتم العثور على السجل",
"data": [],
"statusCode": 404
}

Update Mentor's Appointment

Endpoint

  • Method: POST
  • URL: /v1/admin/coaches/{id}/appointments/{id}

Request Headers

HeaderValueRequired
Content-Typeapplication/jsonYes
Acceptapplication/jsonYes
AuthorizationBearer tokenYes

Request Body

ParameterTypeDescriptionRequiredValidation Rules
startdateAppointments's start datetimeYesrequired, date
durationintAppointments's durationYesrequired, in:30,60

Success Response

{
"success": true,
"message": "تم حفظ البيانات بنجاح.",
"data": {
"id": "uuid",
"start": "2025-04-28 13:00",
"end": "2025-04-28 14:00",
"isBooked": false,
"coachId": "uuid",
"displayedTime": "01:00 م - 02:00 م",
"sessionId": null,
"duration": "60",
"canPostpone": false,
"coachFullname": "احمد البيتي",
"customerFullname": null
},
"statusCode": 200
}

Error Responses

{
"success": false,
"message": "حدث خطأ في البيانات المرسلة يرجى التحقق منها.",
"errors": {
"start": "الوقت أو التاريخ غير متاح."
},
"data": [],
"statusCode": 422
}
{
"success": false,
"message": "لم يتم العثور على السجل",
"data": [],
"statusCode": 404
}

Delete Mentor's Appointments

Endpoint

  • Method: DELETE
  • URL: /v1/admin/coaches/{id}/appointments

Request Headers

HeaderValueRequired
Content-Typeapplication/jsonYes
Acceptapplication/jsonYes
AuthorizationBearer tokenYes

Path Parameters

ParameterTypeDescriptionRequired
idsarrayAppointments ids to deleteNo

Success Response

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

Error Responses

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

Delete All Mentor's Appointments

Endpoint

  • Method: POST
  • URL: /v1/admin/coaches/{id}/appointments/delete-all-appointments

Request Headers

HeaderValueRequired
Content-Typeapplication/jsonYes
Acceptapplication/jsonYes
AuthorizationBearer tokenYes

Success Response

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

Error Responses

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