POST api/Calendar/PatientAppointmentPost_v1
Request Information
URI Parameters
None.
Body Parameters
AppointmentModelName | Description | Type | Additional information |
---|---|---|---|
EncounterTypeId | globally unique identifier |
None. |
|
EncounterTypeModeDurationId | globally unique identifier |
None. |
|
ProviderId | globally unique identifier |
None. |
|
UserId | globally unique identifier |
Required |
|
PatientId | globally unique identifier |
None. |
|
SpecialityId | globally unique identifier |
None. |
|
AppointmentOn | date |
Required |
|
SecondaryAppointmentOn | date |
None. |
|
Reason | string |
Required String length: inclusive between 0 and 250 |
|
Note | string |
String length: inclusive between 0 and 1000 |
|
ParentId | globally unique identifier |
None. |
|
ReferredParentId | globally unique identifier |
None. |
|
PaidAmount | decimal number |
None. |
|
AccountId | globally unique identifier |
Required |
|
ServiceId | globally unique identifier |
None. |
|
MethodId | integer |
None. |
|
IsCustomFormFlow | string |
None. |
|
DocIds | string |
None. |
|
Reasons | Collection of Reasons |
None. |
Request Formats
application/json, text/json
Sample:
{ "EncounterTypeId": "6999418f-0f4d-4b34-b17e-500c59d03f22", "EncounterTypeModeDurationId": "3c0fadfc-43cb-4527-957d-096a4f1c677b", "ProviderId": "bdd293f4-e6b7-4911-95af-bef8abfe231b", "UserId": "7fb55b1c-c8b2-4733-9c71-77b35f114cba", "PatientId": "d7306d08-0756-4fa3-9e6f-6f0aef3e73ed", "SpecialityId": "014f70d2-0aba-40c0-840d-414e680feaf9", "AppointmentOn": "2025-07-03T13:21:10.3438095-05:00", "SecondaryAppointmentOn": "2025-07-03T13:21:10.3438095-05:00", "Reason": "sample string 3", "Note": "sample string 4", "ParentId": "50034fb1-561f-4384-8cf8-a08c59cea414", "ReferredParentId": "71fc1d69-fb08-446b-a40e-99abc6f43c0a", "PaidAmount": 5.0, "AccountId": "4dbaea8e-c9d2-483b-9b80-35773d614332", "ServiceId": "04e6b1f7-53e5-4816-b2fa-e9fd17f3435b", "MethodId": 1, "IsCustomFormFlow": "sample string 7", "DocIds": "sample string 8", "Reasons": [ { "ReasonId": "b4dd1103-b84a-41b2-8bf2-a9953daef6fd" }, { "ReasonId": "b4dd1103-b84a-41b2-8bf2-a9953daef6fd" } ] }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.