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": "5e844601-8f26-4f44-95d3-7c6795c03059",
"ProviderId": "abfbe1ba-0e2b-46f2-ab8c-c41ee8532b64",
"PatientId": "456e74a9-3bbb-47e5-b2e4-ba89fb7b78cc",
"SpecialityId": "c2a61ff3-d4d9-479c-929c-34ac4e300374",
"AppointmentOn": "2026-03-21T16:59:41.1930744-05: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": "c107625c-52fe-494d-b663-3012a7973e93",
"PaidAmount": 8.0,
"AccountId": "90324b81-f0ea-4abf-af1b-325e48a17e9f",
"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": "dd3d53fe-e94d-45a8-bc9e-4dcc259f2702",
"PatientId": "c6994708-e385-445a-a9ab-09cafeb75e54",
"AccountId": "1dfd36e0-f3e0-4fa6-bd28-ef1ed7cf60a1"
},
{
"Message": {
"status": "sample string 1",
"Code": 2,
"text": "sample string 3"
},
"AppointmentId": "dd3d53fe-e94d-45a8-bc9e-4dcc259f2702",
"PatientId": "c6994708-e385-445a-a9ab-09cafeb75e54",
"AccountId": "1dfd36e0-f3e0-4fa6-bd28-ef1ed7cf60a1"
}
]