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": "ea573c09-bbd9-44a4-9267-b6191e966054", "ProviderId": "d4f7f438-f7bc-4a37-a7d2-fa273e24e7f0", "PatientId": "f1a41571-638a-45b7-89d1-c70ea233f4f3", "SpecialityId": "8c27160c-d71b-4ce3-9039-7b9589a04c7a", "AppointmentOn": "2025-06-08T16:21:17.8717637+05:30", "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": "7f1e194b-5326-4acc-bd1d-a3046ee36ce5", "PaidAmount": 8.0, "AccountId": "7829780d-3b19-42e3-910c-4a1df54b987d", "AppointmentModeId": 1 }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of ResultName | Description | Type | Additional information |
---|---|---|---|
Message | Message |
None. |
|
EncounterId | 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": "91cea17a-d849-4532-9b42-8ed2a372c69a", "PatientId": "bbbe17ec-c867-4443-a67e-665eafa50df0", "AccountId": "a5842ff0-1035-4cae-a69f-8b70b463c8b0" }, { "Message": { "status": "sample string 1", "Code": 2, "text": "sample string 3" }, "AppointmentId": "91cea17a-d849-4532-9b42-8ed2a372c69a", "PatientId": "bbbe17ec-c867-4443-a67e-665eafa50df0", "AccountId": "a5842ff0-1035-4cae-a69f-8b70b463c8b0" } ]