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": "c042edde-d9da-41fb-8e47-c1d591b306e1",
"ProviderId": "40ba669c-1ae2-4c10-b31d-8d1901d9b74f",
"PatientId": "be844725-4648-49fc-a59f-ef75223c2f09",
"SpecialityId": "f052a30e-1ce9-4597-a66e-eade30339f95",
"AppointmentOn": "2026-03-21T22:05:04.0729239+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": "8a881e66-2847-4bcb-ab1b-e111730291f0",
"PaidAmount": 8.0,
"AccountId": "60a617ba-994a-4f22-b2e1-cf124b6c89d6",
"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": "474a38c7-48e0-42df-87d2-fac3d5010061",
"PatientId": "12e3ca4b-9f67-4849-8c13-c3cb50db6d1f",
"AccountId": "6b5738f7-a984-4fbb-8fea-39b779c99caf"
},
{
"Message": {
"status": "sample string 1",
"Code": 2,
"text": "sample string 3"
},
"AppointmentId": "474a38c7-48e0-42df-87d2-fac3d5010061",
"PatientId": "12e3ca4b-9f67-4849-8c13-c3cb50db6d1f",
"AccountId": "6b5738f7-a984-4fbb-8fea-39b779c99caf"
}
]