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": "68d575fc-9f39-4c1f-ab0d-96b711c2469c",
"ProviderId": "f292aebf-2734-4601-ba62-e282633536d6",
"PatientId": "c7ace72d-a66d-46fc-9b9f-144b3ab68687",
"SpecialityId": "1761d5f2-f119-4f1e-8cf4-efc0a995e4bf",
"AppointmentOn": "2026-02-03T21:01:08.3428995-06: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": "a7c33491-8a4b-441a-b504-cad59192e85c",
"PaidAmount": 8.0,
"AccountId": "4a756a29-52b9-4edc-a40b-ccec598d7e61",
"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": "6f7e1ae7-5010-42e7-a5b0-97502cb001a6",
"PatientId": "14767d76-3228-4f06-8d80-63546b2c5e63",
"AccountId": "9aa578e3-3013-426e-b493-a88cb2e68735"
},
{
"Message": {
"status": "sample string 1",
"Code": 2,
"text": "sample string 3"
},
"AppointmentId": "6f7e1ae7-5010-42e7-a5b0-97502cb001a6",
"PatientId": "14767d76-3228-4f06-8d80-63546b2c5e63",
"AccountId": "9aa578e3-3013-426e-b493-a88cb2e68735"
}
]