GET api/Appointments/{id}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Appointment| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | integer |
None. |
|
| LocationId | integer |
None. |
|
| DoctorScheduleSlotId | integer |
None. |
|
| AppointmentTypeId | integer |
None. |
|
| AppointmentStatusId | integer |
None. |
|
| PatientId | integer |
None. |
|
| ApptSource | string |
String length: inclusive between 0 and 50 |
|
| SubmitTime | date |
None. |
|
| Notes | string |
String length: inclusive between 0 and 150 |
|
| ValidFrom | date |
None. |
|
| ValidTo | date |
None. |
|
| AppointmentIdentity | string |
None. |
|
| AppointmentDoctorSchedule | AppointmentDoctorSchedule |
None. |
Response Formats
application/json, text/json
Sample:
{
"Id": 1,
"LocationId": 2,
"DoctorScheduleSlotId": 3,
"AppointmentTypeId": 4,
"AppointmentStatusId": 5,
"PatientId": 6,
"ApptSource": "sample string 7",
"SubmitTime": "2024-11-21T02:38:55.7926493-06:00",
"Notes": "sample string 9",
"ValidFrom": "2024-11-21T02:38:55.7926493-06:00",
"ValidTo": "2024-11-21T02:38:55.7926493-06:00",
"AppointmentIdentity": "sample string 12",
"AppointmentDoctorSchedule": {
"Id": 1,
"DoctorId": 2,
"ClientDoctorIdentity": "sample string 3",
"LocationId": 4,
"ClientOfficeIdentity": "sample string 5",
"ValidFrom": "2024-11-21T02:38:55.7926493-06:00",
"ValidTo": "2024-11-21T02:38:55.7926493-06:00",
"AppointmentDateTimeStart": "2024-11-21T02:38:55.7926493-06:00",
"AppointmentDateTimeEnd": "2024-11-21T02:38:55.7926493-06:00",
"SlotIdentity": 1,
"Available": true,
"Appointments": []
}
}
application/xml
Sample:
Sample not available.
text/xml
Sample:
Sample not available.