POST api/THSetAppointment
Book Appointment
Request Information
URI Parameters
None.
Body Parameters
AppointmentName | 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": "bb38b63a-48ca-4b05-a189-6c566236d42c", "ProviderId": "54cfebe1-ed0a-4297-9ee6-5cd2f87effff", "PatientId": "47c14747-c072-49cc-b2de-df5f9bd6ef4b", "SpecialityId": "7ff58157-bd82-4e13-8af4-af4744978919", "AppointmentOn": "2025-07-03T13:06:23.5390751-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": "d1c14393-60e8-430b-9735-83803d182eb7", "PaidAmount": 8.0, "AccountId": "a06ffe5d-df8c-4a82-9672-2dbd0da80f59", "AppointmentModeId": 1 }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of ResultName | 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": "de47adb1-fd76-4448-915a-602c9d08620a", "PatientId": "789f9579-2c7e-45f1-be3d-aabac2076a2a", "AccountId": "085fcda7-0597-4e26-a508-e7f9e9129311" }, { "Message": { "status": "sample string 1", "Code": 2, "text": "sample string 3" }, "AppointmentId": "de47adb1-fd76-4448-915a-602c9d08620a", "PatientId": "789f9579-2c7e-45f1-be3d-aabac2076a2a", "AccountId": "085fcda7-0597-4e26-a508-e7f9e9129311" } ]