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": "7fd6392c-f7cb-4c57-8dc0-0c2f777b9a6d",
"ProviderId": "919721cb-1229-4d97-937e-e356473dfcd2",
"PatientId": "cc4b5f8a-c953-44c1-927d-858e201cbcd4",
"SpecialityId": "e0369c7c-7dcb-4a9d-9170-e6984d27764d",
"AppointmentOn": "2026-02-04T03:20:09.7482952+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": "0bc6529a-a57a-4236-b080-f253dbcb2065",
"PaidAmount": 8.0,
"AccountId": "78376781-f441-48f9-88da-186fa0aac45a",
"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": "d0ceb565-c8d5-4034-ae0a-0f380cb92109",
"PatientId": "2412b2f2-3a6b-481e-b7ae-a594e72b5aa8",
"AccountId": "1e6f7eff-92c5-4ac5-9ad8-e51d5fa2c50e"
},
{
"Message": {
"status": "sample string 1",
"Code": 2,
"text": "sample string 3"
},
"AppointmentId": "d0ceb565-c8d5-4034-ae0a-0f380cb92109",
"PatientId": "2412b2f2-3a6b-481e-b7ae-a594e72b5aa8",
"AccountId": "1e6f7eff-92c5-4ac5-9ad8-e51d5fa2c50e"
}
]