Afya-Health
  1. Appointment Schedule
Afya-Health
  • Auth
    • Login
      POST
    • Signup
      POST
  • ForgotPassword
    • Verify OTP
      POST
    • ForgotPassword
      POST
    • ResetPassword
      POST
  • Profile
    • Get User Profile
      GET
    • Update user profile
      POST
  • Family Members
    • Add Family Member
      POST
    • Update Family Members
      PUT
    • Delete Family Member
      DELETE
  • Address
    • Get User address
      GET
    • Add Address
      POST
    • Update address
      PUT
    • Delete Address
      DELETE
  • Languages
    • List AppLabels
      GET
    • Add/Update Label
      POST
    • List Languages
      GET
  • Products
    • Get Products
      GET
    • Create Product
      POST
    • Update Product
      PUT
    • Delete Product
      DELETE
    • Update product items
      PUT
  • Permissions
    • Get Permissions
  • Config
    • List Practice Config
    • Add Update Config
    • List Master Config
    • Add Update Master Config
  • Appointment Schedule
    • Create Schedule
      POST
    • Update Schedule
      PUT
    • Delete Schedule
      DELETE
    • Get Schedule by ID
      GET
    • Get Schedule list
      GET
  • Test Tags
    • Get Test Tags
    • Create Test Tag
    • Update Test Tag
    • Delete Test Tag
  • Test Parameters
    • Get Test Parameters
    • Create Test Parameters
    • Update Test Parameters
    • Delete Test Parameters
  • Category
    • Get Category
    • Create Category
    • Update Category
    • Delete Category
  • Device
    • Register Device
  • File
    • Upload File
  • Appointment
    • Create Appointment Order
    • Get Appointments List
    • Update Appointment Status
    • Get Appointment by ID
    • Get Appointment Slots
    • GetStartJourneyDirection
  • Reports
    • Upload Report
    • List All Reports
    • List Reports By Appointment
    • Delete Report
    • Update Report File
  • Staff
    • Add Staff Member
    • List Staff Member
    • Update Staff Member
    • Delete Staff Member
    • Get Staff member by ID
  • Patient
    • List Patients
    • Add Patient
    • Update Patient
    • Delete Patient
    • Get patient by ID
  • Notifications
    • List User Notifications
    • Update Notification read status
  1. Appointment Schedule

Get Schedule by ID

Developing
GET
/api/service/v1/appointment/schedule/{id}

Request

Path Params
id
string 
required
Header Params
Accept
string 
optional
Example:
application/json
Content-Type
string 
optional
Example:
application/json
practice-code
string 
optional
Example:
DEFAULT
Authorization
string 
optional
Example:
{{token}}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://afyahealth.doctodoor.com:5600/api/service/v1/appointment/schedule/' \
--header 'Accept: application/json' \
--header 'practice-code: DEFAULT' \
--header 'Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3YjJkZmZlNWJmMjdlMzk1NTUzMjE0MyIsImVtYWlsIjoiZGVlcC5tYXJzb25pYUBwbGVuYXJ0ZWNoLmNvbSIsInN1YiI6IjY3YjJkZmZlNWJmMjdlMzk1NTUzMjE0MyIsImlhdCI6MTc0MTc4MjA4NCwiZXhwIjoxNzQ5NTU4MDg0fQ.KAMsweSbJPDxpLijKdjgp3YEFauw8KYLLumCBpqQfAA' \
--header 'Content-Type: application/json'

Responses

🟢200Success
application/json
Body
error
boolean 
required
status_code
integer 
required
message
string 
required
data
object 
required
services
array [object {8}] 
required
buffer_minutes
integer 
required
is_deleted
integer 
required
override_dates
array [object {6}] 
required
schedules
array [object {8}] 
required
user
object 
required
name
string 
required
start
string 
required
end
null 
required
timezone
string 
required
created_at
string 
required
updated_at
string 
required
id
string 
required
Examples
{
    "error": false,
    "status_code": 200,
    "message": "",
    "data": {
        "services": [],
        "buffer_minutes": 0,
        "is_deleted": 0,
        "override_dates": [
            {
                "date": "2024-12-30T00:00:00.000Z",
                "start_time": "13:00",
                "end_time": "14:00",
                "created_at": "2024-12-23T07:10:47.161Z",
                "updated_at": "2024-12-23T07:10:47.161Z",
                "id": "67690cf77d5c1a3e202cad11"
            }
        ],
        "schedules": [
            {
                "day": 1,
                "isOn": true,
                "startTime": "09:00",
                "endTime": "15:00",
                "breaks": [
                    {
                        "start": "10:00",
                        "end": "11:00",
                        "created_at": "2024-12-23T07:10:47.161Z",
                        "updated_at": "2024-12-23T07:10:47.161Z",
                        "id": "67690cf77d5c1a3e202cad04"
                    }
                ],
                "created_at": "2024-12-23T07:10:47.161Z",
                "updated_at": "2024-12-23T07:10:47.161Z",
                "id": "67690cf77d5c1a3e202cad03"
            },
            {
                "day": 2,
                "isOn": true,
                "startTime": "09:00",
                "endTime": "15:00",
                "breaks": [
                    {
                        "start": "10:00",
                        "end": "11:00",
                        "created_at": "2024-12-23T07:10:47.162Z",
                        "updated_at": "2024-12-23T07:10:47.162Z",
                        "id": "67690cf77d5c1a3e202cad06"
                    }
                ],
                "created_at": "2024-12-23T07:10:47.162Z",
                "updated_at": "2024-12-23T07:10:47.162Z",
                "id": "67690cf77d5c1a3e202cad05"
            },
            {
                "day": 3,
                "isOn": true,
                "startTime": "09:00",
                "endTime": "15:00",
                "breaks": [
                    {
                        "start": "14:00",
                        "end": "15:00",
                        "created_at": "2024-12-23T07:10:47.162Z",
                        "updated_at": "2024-12-23T07:10:47.162Z",
                        "id": "67690cf77d5c1a3e202cad08"
                    }
                ],
                "created_at": "2024-12-23T07:10:47.162Z",
                "updated_at": "2024-12-23T07:10:47.162Z",
                "id": "67690cf77d5c1a3e202cad07"
            },
            {
                "day": 4,
                "isOn": true,
                "startTime": "09:00",
                "endTime": "15:00",
                "breaks": [
                    {
                        "start": "10:00",
                        "end": "11:00",
                        "created_at": "2024-12-23T07:10:47.162Z",
                        "updated_at": "2024-12-23T07:10:47.162Z",
                        "id": "67690cf77d5c1a3e202cad0a"
                    }
                ],
                "created_at": "2024-12-23T07:10:47.162Z",
                "updated_at": "2024-12-23T07:10:47.162Z",
                "id": "67690cf77d5c1a3e202cad09"
            },
            {
                "day": 5,
                "isOn": true,
                "startTime": "09:00",
                "endTime": "15:00",
                "breaks": [
                    {
                        "start": "10:00",
                        "end": "11:00",
                        "created_at": "2024-12-23T07:10:47.162Z",
                        "updated_at": "2024-12-23T07:10:47.162Z",
                        "id": "67690cf77d5c1a3e202cad0c"
                    }
                ],
                "created_at": "2024-12-23T07:10:47.162Z",
                "updated_at": "2024-12-23T07:10:47.162Z",
                "id": "67690cf77d5c1a3e202cad0b"
            },
            {
                "day": 6,
                "isOn": true,
                "startTime": "09:00",
                "endTime": "15:00",
                "breaks": [
                    {
                        "start": "10:00",
                        "end": "11:00",
                        "created_at": "2024-12-23T07:10:47.162Z",
                        "updated_at": "2024-12-23T07:10:47.162Z",
                        "id": "67690cf77d5c1a3e202cad0e"
                    }
                ],
                "created_at": "2024-12-23T07:10:47.163Z",
                "updated_at": "2024-12-23T07:10:47.163Z",
                "id": "67690cf77d5c1a3e202cad0d"
            },
            {
                "day": 7,
                "isOn": true,
                "startTime": "09:00",
                "endTime": "15:00",
                "breaks": [
                    {
                        "start": "10:00",
                        "end": "11:00",
                        "created_at": "2024-12-23T07:10:47.163Z",
                        "updated_at": "2024-12-23T07:10:47.163Z",
                        "id": "67690cf77d5c1a3e202cad10"
                    }
                ],
                "created_at": "2024-12-23T07:10:47.163Z",
                "updated_at": "2024-12-23T07:10:47.163Z",
                "id": "67690cf77d5c1a3e202cad0f"
            }
        ],
        "user": {
            "roles": [
                "6759596f0907f449d617bc74"
            ],
            "is_master_admin": 1,
            "is_deleted": 0,
            "is_active": 1,
            "deleted_at": null,
            "language_code": "en",
            "first_name": "Deep",
            "middle_name": "",
            "last_name": "Marsonia",
            "full_name": "Deep Marsonia",
            "email": "deep.marsonia@plenartech.com",
            "created_at": "2024-12-11T09:20:47.853Z",
            "updated_at": "2024-12-11T09:20:47.853Z",
            "id": "6759596f0907f449d617bcc0"
        },
        "name": "today THis is my Schedule name",
        "start": "2024-12-23T00:00:00.000Z",
        "end": null,
        "timezone": "Asia/Kolkata",
        "created_at": "2024-12-23T07:10:47.163Z",
        "updated_at": "2024-12-23T07:10:47.163Z",
        "id": "67690cf77d5c1a3e202cad02"
    }
}
Previous
Delete Schedule
Next
Get Schedule list
Built with