Appointment Scheduled
Use Appointment Scheduled to confirm that the selected appointment offer is approved.
The modal displays the scheduled doctor, appointment time, location, and price.
This screen includes:
| # | Element | Description |
|---|---|---|
| 1 | Modal title | Displays Appointment scheduled. |
| 2 | Close action | Dismisses the modal. |
| 3 | Doctor name | Displays the scheduled doctor name. |
| 4 | Appointment date and time | Displays the scheduled appointment date, time, and time zone. |
| 5 | Appointment location | Displays the appointment address and distance from the user. |
| 6 | Appointment price | Displays the appointment fee. |
| 7 | Close button | Closes the modal and returns the user to the appointment list. |
Workflow
- Select an appointment offer.
- Select Confirm.
- Submit the appointment approval request.
- Display the Appointment scheduled modal after success.
- Show the doctor name, appointment time, location, and price.
- Close the modal from Close or the close action.
Validations
| Scenario | App Behavior | SDK Output |
|---|---|---|
| Appointment offer is selected | Enables the confirmation action. | state = selected |
| Appointment offer is not selected | Keeps the confirmation action unavailable. | state = invalid |
| Approval request succeeds | Displays the scheduled appointment modal. | status = success |
| Approval request fails | Displays an error state and preserves the offer list. | state = error |
| Scheduled appointment data is available | Displays appointment details in the modal. | appointment = scheduled |
| Scheduled appointment data is unavailable | Displays an error state. | error = missing_appointment_data |
Actions
| Scenario | App Behavior | SDK Output |
|---|---|---|
| Appointment offer selected | Updates the selected offer state. | offer = selected |
| Confirm selected | Sends the appointment approval request. | PUT /api/v3/appointments/{appointment-id}/approve/success |
| Approval succeeds | Opens the Appointment scheduled modal. | modal = appointment_scheduled |
| Approval fails | Keeps the user on the offer selection screen. | state = error |
| Close action selected | Dismisses the modal. | state = dismissed |
| Close button selected | Closes the modal and returns to the appointment list. | navigation = appointment_list |
Endpoint Resources
Appointment Scheduled
PUT
v3/appointments/{appointment-id}/approve/success
Displays success screen when appointment offer was approved.