POST api/Calendar/PatientAppointmentPost_v2
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": "cfcdd019-6cf1-43e5-b317-3cdf24c3dafa", "EncounterTypeModeDurationId": "ff7a85d8-4423-4301-b064-2ffc8d2c2bc4", "ProviderId": "1bf7e1b2-634b-45bd-bc1d-ea890a47a393", "UserId": "44e99f04-73bd-4c96-b736-17b3b335257b", "PatientId": "8eca9b0e-a2f3-4aca-ac21-94470db5b683", "SpecialityId": "a3846853-7dea-4f78-972b-6324f102dc56", "AppointmentOn": "2025-07-03T13:19:23.587794-05:00", "SecondaryAppointmentOn": "2025-07-03T13:19:23.587794-05:00", "Reason": "sample string 3", "Note": "sample string 4", "ParentId": "dbff2a6a-47a8-4b3d-a7ee-1d22fc3a693a", "ReferredParentId": "83427746-f04f-4f27-9b17-fd02a28527ed", "PaidAmount": 5.0, "AccountId": "45eae8a9-3512-4da3-b832-0340f7c8b930", "ServiceId": "605ebf21-85cc-4350-8768-3fd26bc5ac9f", "MethodId": 1, "IsCustomFormFlow": "sample string 7", "DocIds": "sample string 8", "Reasons": [ { "ReasonId": "e823d345-6856-4a53-9476-a7e154f5c6e0" }, { "ReasonId": "e823d345-6856-4a53-9476-a7e154f5c6e0" } ] }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.