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": "c8593df0-c1d6-4658-9d20-b8e876c7728d",
"ProviderId": "60c6b46d-8a27-4e8d-8338-81d6beff88fd",
"PatientId": "550428f7-45d8-4966-a98a-e15e77887150",
"SpecialityId": "a5af2378-8321-40e0-9d35-55598e7ae3d4",
"AppointmentOn": "2025-12-15T10:15:30.4154108-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": "2e309f7a-a265-4ba0-bac4-cda8d8b23840",
"PaidAmount": 8.0,
"AccountId": "a2c4fb98-edfd-4166-a27f-42a3aa92e24a",
"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": "fb48e828-b891-442b-bf32-1cbf9171c04c",
"PatientId": "32f37309-4b34-47ef-bd72-0b3e1ae58ce7",
"AccountId": "35134d74-a81f-469a-b80e-86a3314186cb"
},
{
"Message": {
"status": "sample string 1",
"Code": 2,
"text": "sample string 3"
},
"AppointmentId": "fb48e828-b891-442b-bf32-1cbf9171c04c",
"PatientId": "32f37309-4b34-47ef-bd72-0b3e1ae58ce7",
"AccountId": "35134d74-a81f-469a-b80e-86a3314186cb"
}
]