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": "b2db0cd6-f0e0-4aed-99e4-6aea3220c558",
"ProviderId": "76321fe3-0610-4f0c-ab88-4858fea2c1d7",
"PatientId": "ecd31e74-b1b9-4fc4-9686-8d90718cad90",
"SpecialityId": "836e7829-3f91-4bf4-b1c7-2cce721ec9b5",
"AppointmentOn": "2026-02-03T20:56:49.5269765-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": "b9af5442-c85a-4af5-b46a-3830984376c9",
"PaidAmount": 8.0,
"AccountId": "12f9899a-b744-4191-a87c-719fcce03a85",
"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": "f0e5e31c-f9a7-4b06-a18a-8ded1289dae9",
"PatientId": "8f0f3c92-8d3b-42e4-a158-04d7e7a0cb4e",
"AccountId": "48a11b50-0fd4-428a-839e-e9142477e5da"
},
{
"Message": {
"status": "sample string 1",
"Code": 2,
"text": "sample string 3"
},
"AppointmentId": "f0e5e31c-f9a7-4b06-a18a-8ded1289dae9",
"PatientId": "8f0f3c92-8d3b-42e4-a158-04d7e7a0cb4e",
"AccountId": "48a11b50-0fd4-428a-839e-e9142477e5da"
}
]