Afya-Health
  1. Appointment
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
    • Create Product
    • Update Product
    • Delete Product
    • Update product items
  • Permissions
    • Get Permissions
  • Config
    • List Practice Config
    • Add Update Config
    • List Master Config
    • Add Update Master Config
  • Appointment Schedule
    • Create Schedule
    • Update Schedule
    • Delete Schedule
    • Get Schedule by ID
    • Get Schedule list
  • 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
      POST
    • Get Appointments List
      GET
    • Update Appointment Status
      POST
    • Get Appointment by ID
      GET
    • Get Appointment Slots
      POST
    • GetStartJourneyDirection
      POST
  • 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

Update Appointment Status

Developing
POST
/api/service/v1/appointment/{id}/status

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}}
Body Params application/json
status
string 
required
Example
{
    "status" : "lab_agent_arrived"
}

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 POST 'https://afyahealth.doctodoor.com:5600/api/service/v1/appointment//status' \
--header 'Accept: application/json' \
--header 'practice-code: DEFAULT' \
--header 'Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3YjJkZmZlNWJmMjdlMzk1NTUzMjE0MyIsImVtYWlsIjoiZGVlcC5tYXJzb25pYUBwbGVuYXJ0ZWNoLmNvbSIsInN1YiI6IjY3YjJkZmZlNWJmMjdlMzk1NTUzMjE0MyIsImlhdCI6MTc0MTc4MjA4NCwiZXhwIjoxNzQ5NTU4MDg0fQ.KAMsweSbJPDxpLijKdjgp3YEFauw8KYLLumCBpqQfAA' \
--header 'Content-Type: application/json' \
--data-raw '{
    "status" : "lab_agent_arrived"
}'

Responses

🟢200Success
application/json
Body
error
boolean 
required
status_code
integer 
required
message
string 
required
data
object 
required
slot_timing
object 
required
status
string 
required
family_members
array[string]
required
is_deleted
integer 
required
items
array [object {10}] 
required
status_activity
array [object {5}] 
required
user
string 
required
payment_mode
string 
required
technician
string 
required
address
string 
required
gender_preference
string 
required
coupon_code
string 
required
currency
string 
required
fee
integer 
required
total
integer 
required
final_total
integer 
required
created_at
string 
required
updated_at
string 
required
id
string 
required
Examples
{
    "error": false,
    "status_code": 200,
    "message": "Appointment status changed successfully",
    "data": {
        "slot_timing": {
            "date": "2025-01-26T00:00:00.000Z",
            "start_time": "09:00",
            "end_time": "10:00"
        },
        "status": "sample_collected",
        "family_members": [],
        "is_deleted": 0,
        "items": [
            {
                "discount_amount": 0,
                "title": "test 1 ##",
                "estimated_report_delivery_time": "0",
                "package_test_id": "67975664eb8b1053d7d780c8",
                "total": 420,
                "discount_type": "flat",
                "final_total": 320,
                "created_at": "2025-01-30T10:08:38.433Z",
                "updated_at": "2025-01-30T10:08:38.433Z",
                "id": "679b4fa699799f96924bd635"
            }
        ],
        "status_activity": [
            {
                "date": "2025-01-30T13:40:18.235Z",
                "status": "order_confirmed",
                "created_at": "2025-01-30T10:08:38.433Z",
                "updated_at": "2025-01-30T13:40:18.235Z",
                "id": "679b4fa699799f96924bd639"
            },
            {
                "date": "2025-01-30T13:40:29.181Z",
                "status": "lab_agent_arrived",
                "created_at": "2025-01-30T10:08:38.433Z",
                "updated_at": "2025-01-30T13:40:29.182Z",
                "id": "679b4fa699799f96924bd63a"
            },
            {
                "date": "2025-01-30T13:40:39.494Z",
                "status": "sample_collected",
                "created_at": "2025-01-30T10:08:38.433Z",
                "updated_at": "2025-01-30T13:40:39.494Z",
                "id": "679b4fa699799f96924bd63b"
            },
            {
                "date": "2025-01-30T13:40:03.710Z",
                "status": "completed",
                "created_at": "2025-01-30T10:08:38.433Z",
                "updated_at": "2025-01-30T13:40:03.711Z",
                "id": "679b4fa699799f96924bd63c"
            },
            {
                "date": null,
                "status": "cancelled",
                "created_at": "2025-01-30T10:08:38.433Z",
                "updated_at": "2025-01-30T10:08:38.433Z",
                "id": "679b4fa699799f96924bd63d"
            }
        ],
        "user": "677bb5bd4291b96cd0623ef2",
        "payment_mode": "cod",
        "technician": "677bb5bd4291b96cd0623ee6",
        "address": "678a433390b9c678ccb677f6",
        "gender_preference": "male",
        "coupon_code": "ABC",
        "currency": "AED",
        "fee": 10,
        "total": 420,
        "final_total": 320,
        "created_at": "2025-01-30T10:08:38.434Z",
        "updated_at": "2025-01-30T13:40:39.497Z",
        "id": "679b4fa699799f96924bd632"
    }
}
Previous
Get Appointments List
Next
Get Appointment by ID
Built with