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": "065b669a-8415-4563-8cd8-325862ef2116",
"ProviderId": "83cccd2e-3e1f-49b6-8512-693b6aab63ca",
"PatientId": "ac43383b-dfee-4711-8378-c753f17549fa",
"SpecialityId": "5e900c2b-8d1a-4c23-b4c7-7a29f0c9cd94",
"AppointmentOn": "2025-12-18T13:10:53.3822381-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": "caa6b3ab-9cbc-41da-ab78-9da0ffa2e992",
"PaidAmount": 8.0,
"AccountId": "4cf596a3-adaf-4815-bdfc-139a0ae855d1",
"AppointmentModeId": 1
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of Result| Name | Description | Type | Additional information |
|---|---|---|---|
| ResultCode | string |
None. |
|
| ResultDescription | string |
None. |
Response Formats
application/json, text/json
Sample:
[
{
"Message": {
"status": "sample string 1",
"Code": 2,
"text": "sample string 3"
},
"AppointmentId": "7bf59ce6-61ff-4bc0-8fac-4f02cbaf220f",
"PatientId": "44e195d6-11aa-4b9b-ad81-5e703b05ba25",
"AccountId": "c97073df-b0b7-4861-afb5-49b4ba9a4766"
},
{
"Message": {
"status": "sample string 1",
"Code": 2,
"text": "sample string 3"
},
"AppointmentId": "7bf59ce6-61ff-4bc0-8fac-4f02cbaf220f",
"PatientId": "44e195d6-11aa-4b9b-ad81-5e703b05ba25",
"AccountId": "c97073df-b0b7-4861-afb5-49b4ba9a4766"
}
]