POST api/THSetAppointment
Book Appointment
Request Information
URI Parameters
None.
Body Parameters
Appointment| Name | Description | Type | Additional information |
|---|---|---|---|
| EncounterTypeId | globally unique identifier |
Required |
|
| ProviderId | globally unique identifier |
Required |
|
| PatientId | globally unique identifier |
Required |
|
| SpecialityId | globally unique identifier |
Required |
|
| AppointmentOn | date |
Required |
|
| Reason | string |
Required String length: inclusive between 0 and 250 |
|
| Note | string |
String length: inclusive between 0 and 1000 |
|
| Document | Collection of Docs |
None. |
|
| ParentId | globally unique identifier |
None. |
|
| PaidAmount | decimal number |
Required |
|
| AccountId | globally unique identifier |
Required |
|
| AppointmentModeId | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"EncounterTypeId": "a7d377e3-d4f5-4f81-8bef-b6c8675f9b8e",
"ProviderId": "9d64d6fc-2ecf-429e-8a12-96a244e6d04b",
"PatientId": "e06b31f9-3c65-46b2-8f33-b63a5da083f1",
"SpecialityId": "019406b4-5c13-4a1d-9aaf-78f33b84c5d3",
"AppointmentOn": "2026-05-06T13:32:26.2140673+00:00",
"Reason": "sample string 6",
"Note": "sample string 7",
"Document": [
{
"ContentType": "sample string 1",
"Content": "sample string 2"
},
{
"ContentType": "sample string 1",
"Content": "sample string 2"
}
],
"ParentId": "37f818b4-8d2d-4318-b227-022f4cc7e3d8",
"PaidAmount": 8.0,
"AccountId": "b44d8110-eacf-4849-a475-80f3e1ba0b3e",
"AppointmentModeId": 1
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of Result| Name | Description | Type | Additional information |
|---|---|---|---|
| Message | Message |
None. |
|
| AppointmentId | globally unique identifier |
None. |
|
| PatientId | globally unique identifier |
None. |
|
| AccountId | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Message": {
"status": "sample string 1",
"Code": 2,
"text": "sample string 3"
},
"AppointmentId": "f0e6c292-7770-4185-b41b-edf0c607cca4",
"PatientId": "239f27a6-aacb-42fd-b70c-fbaa2ebb2be4",
"AccountId": "6ef888a6-5181-4628-85de-f5ce2444e125"
},
{
"Message": {
"status": "sample string 1",
"Code": 2,
"text": "sample string 3"
},
"AppointmentId": "f0e6c292-7770-4185-b41b-edf0c607cca4",
"PatientId": "239f27a6-aacb-42fd-b70c-fbaa2ebb2be4",
"AccountId": "6ef888a6-5181-4628-85de-f5ce2444e125"
}
]