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": "75d50d3f-db12-4743-8865-8c9afb332b74", "EncounterTypeModeDurationId": "1b8ea89d-dd29-4a75-92ae-f965696fd285", "ProviderId": "fb584a00-4628-4258-b5c7-65b29d22de04", "UserId": "aceaaa8c-c98a-4325-9567-02e87ffba4b0", "PatientId": "f250564d-acd6-4353-b23f-2b87ad892c7a", "SpecialityId": "edb44b77-6be1-4c1d-9657-b4adc773515a", "AppointmentOn": "2025-06-06T16:16:52.5669357+00:00", "SecondaryAppointmentOn": "2025-06-06T16:16:52.5669357+00:00", "Reason": "sample string 3", "Note": "sample string 4", "ParentId": "084780da-93c9-4567-a27b-8dd3e372e3aa", "ReferredParentId": "a3dc4947-48fb-419c-bea7-31dcc74aeaa0", "PaidAmount": 5.0, "AccountId": "3ff4e9ad-b05a-47a2-8b16-3554bc623d1a", "ServiceId": "9f815fc7-652e-4e07-8851-9c081d6a45e2", "MethodId": 1, "IsCustomFormFlow": "sample string 7", "DocIds": "sample string 8", "Reasons": [ { "ReasonId": "1be7b7e9-e666-4e73-9793-ea1981859d17" }, { "ReasonId": "1be7b7e9-e666-4e73-9793-ea1981859d17" } ] }
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.