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": "fd1707d4-83fd-46fd-bb08-5d65427e4ac7",
"EncounterTypeModeDurationId": "4a25ef33-38f2-4a3f-93be-8a4ff83044c1",
"ProviderId": "5f9137a5-047f-465f-875d-32a0f25f7443",
"UserId": "f8ecf226-1d5d-4a17-ba64-27ceb9ee6faa",
"PatientId": "7cf6aceb-dfc9-41c5-ae59-a7ec7d800bbf",
"SpecialityId": "b7dd9ae4-ecbd-489b-9e77-42e549aef2d7",
"AppointmentOn": "2026-03-21T22:07:59.9117947+00:00",
"SecondaryAppointmentOn": "2026-03-21T22:07:59.9117947+00:00",
"Reason": "sample string 3",
"Note": "sample string 4",
"ParentId": "1651b8b6-8a14-44df-8307-ddd037ea4dcf",
"ReferredParentId": "79ee718d-ad23-4b1a-9186-6333fa27bfae",
"PaidAmount": 5.0,
"AccountId": "a56a2287-e739-4b83-94c3-901d33ce5d7a",
"ServiceId": "c4621783-bf75-423b-9e99-7b277e122fbe",
"MethodId": 1,
"IsCustomFormFlow": "sample string 7",
"DocIds": "sample string 8",
"Reasons": [
{
"ReasonId": "806299c3-155e-4d53-86e6-f7b824d26d11"
},
{
"ReasonId": "806299c3-155e-4d53-86e6-f7b824d26d11"
}
]
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.