POST api/Calendar/PatientAppointmentPost_v2
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": "57c69d05-9ffb-453f-9851-4e6751e1393f",
"EncounterTypeModeDurationId": "2bbab380-300e-447e-8362-ad799b5d6e68",
"ProviderId": "0fade3d7-d368-42ad-89ef-2a574ecba87c",
"UserId": "a0c196e2-3c64-4238-9146-864482d90386",
"PatientId": "0bbc9c13-1e2e-42d9-9f2e-7ac9757aca51",
"SpecialityId": "a918f969-f1f8-4be8-95ef-3570165c3bd6",
"AppointmentOn": "2026-02-03T20:57:55.0825658-06:00",
"SecondaryAppointmentOn": "2026-02-03T20:57:55.0825658-06:00",
"Reason": "sample string 3",
"Note": "sample string 4",
"ParentId": "9f2af6ac-985e-4d64-b2bf-00c18b04a4ea",
"ReferredParentId": "0215e537-7287-4230-b416-4d02533c61c7",
"PaidAmount": 5.0,
"AccountId": "74441512-ced0-4bde-a2b5-a979ef080ce1",
"ServiceId": "31e32051-affa-44ae-ba23-0447ec0a26ee",
"MethodId": 1,
"IsCustomFormFlow": "sample string 7",
"DocIds": "sample string 8",
"Reasons": [
{
"ReasonId": "1b373754-bb54-4a0e-ac07-d712f3e0cc69"
},
{
"ReasonId": "1b373754-bb54-4a0e-ac07-d712f3e0cc69"
}
]
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.