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": "a48f4b99-c8a0-451e-aa93-a743c72afbaf",
"ProviderId": "d96456c4-777c-47c9-931f-86622cfa6707",
"PatientId": "bdb39cd1-331b-4576-8feb-404a0a97e900",
"SpecialityId": "b6e2c71f-288e-4e7e-b62c-152f7da1ace2",
"AppointmentOn": "2025-12-15T04:47:14.9664921+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": "db8dd42b-0687-4e49-992b-e0a717026086",
"PaidAmount": 8.0,
"AccountId": "dc0ccbca-b78a-4cb2-8740-a48e52d268f4",
"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": "5e927b7c-2741-4b31-a531-9b88da35e14c",
"PatientId": "0f9f3a4e-4509-4738-b8c0-281b60d74be3",
"AccountId": "fd323132-45ef-4d65-b324-0ee65fa3cc2a"
},
{
"Message": {
"status": "sample string 1",
"Code": 2,
"text": "sample string 3"
},
"AppointmentId": "5e927b7c-2741-4b31-a531-9b88da35e14c",
"PatientId": "0f9f3a4e-4509-4738-b8c0-281b60d74be3",
"AccountId": "fd323132-45ef-4d65-b324-0ee65fa3cc2a"
}
]