POST api/Calendar/PatientAppointmentPost_v1
Request Information
URI Parameters
None.
Body Parameters
AppointmentModel| Name | 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": "96ce87cd-eec6-47cd-857a-c82afb167d18",
"EncounterTypeModeDurationId": "eaa3e49d-ca34-4e3e-bc8c-388f9b40ccc8",
"ProviderId": "fef2297b-782c-436f-b781-fbd68bdd76f6",
"UserId": "203111c2-ad70-4aff-8201-8dca7b171cec",
"PatientId": "e2c9f66b-4f56-4c5f-857e-0eb661eb9ec2",
"SpecialityId": "bd237f93-d46a-4975-a95e-a28d771c62fd",
"AppointmentOn": "2026-02-03T20:58:31.6753175-06:00",
"SecondaryAppointmentOn": "2026-02-03T20:58:31.6753175-06:00",
"Reason": "sample string 3",
"Note": "sample string 4",
"ParentId": "d1559324-314c-41f7-8d52-0f1c1869024a",
"ReferredParentId": "a10bb3fd-e80f-4098-8f5c-527c4fa6464e",
"PaidAmount": 5.0,
"AccountId": "a57f4c76-cb71-4a37-906d-bcce09ff2faf",
"ServiceId": "5f9f6231-d02c-492d-8b52-517910b04979",
"MethodId": 1,
"IsCustomFormFlow": "sample string 7",
"DocIds": "sample string 8",
"Reasons": [
{
"ReasonId": "a24ac45a-80c6-4e52-a39f-9baec4610f95"
},
{
"ReasonId": "a24ac45a-80c6-4e52-a39f-9baec4610f95"
}
]
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.