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": "d7684181-893c-41e1-9c28-2091943e1e1b", "ProviderId": "9c1a47b7-c2c5-411c-80da-1cf50f2d4992", "PatientId": "2d351e2d-80ab-4782-a175-cac7920ca89f", "SpecialityId": "5b8e9fec-d01d-4bce-877d-728fde280180", "AppointmentOn": "2024-07-05T17:01:47.9205661-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": "db842a59-3313-40fd-be7a-ead81636af2f", "PaidAmount": 8.0, "AccountId": "1f30a20a-6e59-4bf3-993d-a4023a45e4ba", "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": "167d9d90-c8c2-4fe1-86bd-0afaa3158c36", "PatientId": "4c9c0825-6906-4118-a135-fc356153dd61", "AccountId": "2c32c7ba-cd38-43e0-985d-d4c1847a2a0d" }, { "Message": { "status": "sample string 1", "Code": 2, "text": "sample string 3" }, "AppointmentId": "167d9d90-c8c2-4fe1-86bd-0afaa3158c36", "PatientId": "4c9c0825-6906-4118-a135-fc356153dd61", "AccountId": "2c32c7ba-cd38-43e0-985d-d4c1847a2a0d" } ]