Skip to content

Commit daf78e2

Browse files
nadeem-ekacareSamudranil DuttaSamudranil Dutta
authored
get appointments by date (#257)
* get appointments by date * get_appt_by_date --------- Co-authored-by: Samudranil Dutta <samudranildutta@ip-10-108-216-111.ap-south-1.compute.internal> Co-authored-by: Samudranil Dutta <samudranildutta@ekacareadmins-MacBook-Air.local>
1 parent bcbe2c3 commit daf78e2

4 files changed

Lines changed: 281 additions & 0 deletions

File tree

‎api-reference/doc-tool/appointment-api/get-appointments-by-date.mdx‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
openapi: get /dr/v1/appointment
3+
---

‎api-reference/doc-tool/doc-tool.yaml‎

Lines changed: 276 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2372,6 +2372,282 @@ paths:
23722372
code: INVALID_REQUEST_PARAMETERS
23732373
message: The request contains invalid parameters
23742374
deprecated: false
2375+
get:
2376+
tags:
2377+
- Appointment API
2378+
summary: Get Appointments By date
2379+
description: >-
2380+
2381+
2382+
### Overview
2383+
2384+
This API endpoint is used to retrieve all the appointments scheduled for a
2385+
specific date. It provides a comprehensive list of appointments. The response includes comprehensive
2386+
information about the appointment, including patient and doctor details,
2387+
appointment status, timings and related services.
2388+
2389+
2390+
Appointment_statuses:
2391+
- BK : Booked
2392+
- OG : Ongoing
2393+
- CM : Completed with Prescription
2394+
- CMNP : Completed without a Prescription
2395+
- CN : Cancelled
2396+
- CND : Cancelled by Doctor
2397+
- CNS : Cancelled by Staff
2398+
2399+
operationId: GetappointmentDetails
2400+
parameters:
2401+
- name: auth
2402+
in: header
2403+
description: ''
2404+
required: true
2405+
style: simple
2406+
schema:
2407+
type: string
2408+
example: 'auth'
2409+
- name: date
2410+
in: query
2411+
description: 'Date of scheduled appointments. Format should be YYYY-MM-DD'
2412+
required: true
2413+
style: form
2414+
explode: true
2415+
schema:
2416+
type: string
2417+
example: "2025-05-01"
2418+
responses:
2419+
'200':
2420+
description: OK
2421+
headers:
2422+
Date:
2423+
schema:
2424+
type: string
2425+
example: Sun, 12 Apr 2020 11:09:57 GMT
2426+
Content-Length:
2427+
schema:
2428+
type: string
2429+
example: '377'
2430+
Connection:
2431+
schema:
2432+
type: string
2433+
example: keep-alive
2434+
Server:
2435+
schema:
2436+
type: string
2437+
example: nginx/1.10.3 (Ubuntu)
2438+
Vary:
2439+
schema:
2440+
type: string
2441+
example: Cookie, Accept-Encoding
2442+
Content-Encoding:
2443+
schema:
2444+
type: string
2445+
example: gzip
2446+
Strict-Transport-Security:
2447+
schema:
2448+
type: string
2449+
example: max-age=15768000
2450+
content:
2451+
application/json:
2452+
schema:
2453+
type: object
2454+
properties:
2455+
appointments:
2456+
type: array
2457+
items:
2458+
type: object
2459+
properties:
2460+
appointment_id:
2461+
type: string
2462+
created_at:
2463+
type: integer
2464+
doctor_id:
2465+
type: string
2466+
patient_id:
2467+
type: string
2468+
clinic_id:
2469+
type: string
2470+
channel:
2471+
type: string
2472+
status:
2473+
type: string
2474+
example: "BK"
2475+
enum:
2476+
- "BK"
2477+
- "OG"
2478+
- "CM"
2479+
- "CMNP"
2480+
- "CN"
2481+
- "CND"
2482+
- "CNS"
2483+
mode:
2484+
type: string
2485+
example: "in_clinic"
2486+
enum:
2487+
- "tele"
2488+
- "in_clinic"
2489+
start_time:
2490+
type: integer
2491+
end_time:
2492+
type: integer
2493+
prescription_id:
2494+
type: string
2495+
prescription_url:
2496+
type: string
2497+
partner_appointment_id:
2498+
type: string
2499+
partner_clinic_id:
2500+
type: string
2501+
partner_doctor_id:
2502+
type: string
2503+
partner_patient_id:
2504+
type: string
2505+
# sa_ids:
2506+
# type: array
2507+
example:
2508+
appointments:
2509+
- appointment_id: "{{eka_appointment_id}}"
2510+
partner_appointment_id: "{{partner_appointment_id}}"
2511+
created_at: 1730189586
2512+
doctor_id: "{{doctor_id}}"
2513+
clinic_id: "{{clinic_id}}"
2514+
channel: "Walkin"
2515+
patient_id: "{{patient_id}}"
2516+
partner_doctor_id: "{{partner_doctor_id}}"
2517+
partner_clinic_id: "{{partner_clinic_id}}"
2518+
partner_patient_id: "{{partner_patient_id}}"
2519+
status: CM
2520+
mode: in_clinic
2521+
start_time: 1730189586
2522+
end_time: 1730189586
2523+
prescription_id: "{{prescription_id}}"
2524+
prescription_url: "https://prescription-store-s3.eka.care/P-DW-1234.pdf"
2525+
# sa_ids: []
2526+
- appointment_id: "{{eka_appointment_id}}"
2527+
partner_appointment_id: "{{partner_appointment_id}}"
2528+
created_at: 1730189586
2529+
doctor_id: "{{doctor_id}}"
2530+
clinic_id: "{{clinic_id}}"
2531+
channel: "Walkin"
2532+
patient_id: "{{patient_id}}"
2533+
partner_doctor_id: "{{partner_doctor_id}}"
2534+
partner_clinic_id: "{{partner_clinic_id}}"
2535+
partner_patient_id: "{{partner_patient_id}}"
2536+
status: CM
2537+
mode: in_clinic
2538+
start_time: 1730189586
2539+
end_time: 1730189586
2540+
prescription_id: "{{prescription_id}}"
2541+
prescription_url: "https://prescription-store-s3.eka.care/P-DW-1234.pdf"
2542+
# sa_ids: []
2543+
2544+
'400':
2545+
description: Bad Request
2546+
headers:
2547+
Date:
2548+
schema:
2549+
type: string
2550+
example: Sun, 12 Apr 2024 11:10:57 GMT
2551+
Content-Length:
2552+
schema:
2553+
type: string
2554+
example: '152'
2555+
Connection:
2556+
schema:
2557+
type: string
2558+
example: keep-alive
2559+
Server:
2560+
schema:
2561+
type: string
2562+
example: nginx/1.10.3 (Ubuntu)
2563+
content:
2564+
application/json:
2565+
schema:
2566+
type: object
2567+
properties:
2568+
error:
2569+
type: object
2570+
properties:
2571+
code:
2572+
type: string
2573+
message:
2574+
type: string
2575+
example:
2576+
error:
2577+
code: INVALID_REQUEST_PARAMETERS
2578+
message: The request contains invalid parameters
2579+
'403':
2580+
description: Forbidden
2581+
headers:
2582+
Date:
2583+
schema:
2584+
type: string
2585+
example: Sun, 12 Apr 2024 11:11:57 GMT
2586+
Content-Length:
2587+
schema:
2588+
type: string
2589+
example: '145'
2590+
Connection:
2591+
schema:
2592+
type: string
2593+
example: keep-alive
2594+
Server:
2595+
schema:
2596+
type: string
2597+
example: nginx/1.10.3 (Ubuntu)
2598+
content:
2599+
application/json:
2600+
schema:
2601+
type: object
2602+
properties:
2603+
error:
2604+
type: object
2605+
properties:
2606+
code:
2607+
type: string
2608+
message:
2609+
type: string
2610+
example:
2611+
error:
2612+
code: ACCESS_DENIED
2613+
message: "Access denied. You do not have permission to view this appointment."
2614+
'500':
2615+
description: Internal Server Error
2616+
headers:
2617+
Date:
2618+
schema:
2619+
type: string
2620+
example: Sun, 12 Apr 2024 11:13:57 GMT
2621+
Content-Length:
2622+
schema:
2623+
type: string
2624+
example: '158'
2625+
Connection:
2626+
schema:
2627+
type: string
2628+
example: keep-alive
2629+
Server:
2630+
schema:
2631+
type: string
2632+
example: nginx/1.10.3 (Ubuntu)
2633+
content:
2634+
application/json:
2635+
schema:
2636+
type: object
2637+
properties:
2638+
error:
2639+
type: object
2640+
properties:
2641+
code:
2642+
type: string
2643+
message:
2644+
type: string
2645+
example:
2646+
error:
2647+
code: SERVER_ERROR
2648+
message: An unexpected error occurred while processing your request. Please try again later.
2649+
2650+
deprecated: false
23752651
/dr/v1/appointment/slots/reserve:
23762652
post:
23772653
tags:

‎docs.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -177,6 +177,7 @@
177177
"api-reference/doc-tool/appointment-api/get-appointment-slots",
178178
"api-reference/doc-tool/appointment-api/book-appointment-slot",
179179
"api-reference/doc-tool/appointment-api/get-appointment-details",
180+
"api-reference/doc-tool/appointment-api/get-appointments-by-date",
180181
"api-reference/doc-tool/appointment-api/update-appointment",
181182
"api-reference/doc-tool/appointment-api/update-appointment-v2",
182183
"api-reference/doc-tool/appointment-api/parked-appointment",

‎mint.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -279,6 +279,7 @@
279279
"api-reference/doc-tool/appointment-api/get-appointment-slots",
280280
"api-reference/doc-tool/appointment-api/book-appointment-slot",
281281
"api-reference/doc-tool/appointment-api/get-appointment-details",
282+
"api-reference/doc-tool/appointment-api/get-appointments-by-date",
282283
"api-reference/doc-tool/appointment-api/update-appointment",
283284
"api-reference/doc-tool/appointment-api/update-appointment-v2",
284285
"api-reference/doc-tool/appointment-api/parked-appointment",

0 commit comments

Comments
 (0)