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": "3dac3fa3-0d6c-4c66-832f-46bc4728adb0",
"EncounterTypeModeDurationId": "e68051f1-4b59-45a1-affd-12e2d03f42ee",
"ProviderId": "bc4494ca-c423-4b50-aa42-9c6d26f25944",
"UserId": "6764cd67-37c7-4ffb-93d0-7967bac8179b",
"PatientId": "985162d6-a813-4d84-b5b7-b71c6baf8855",
"SpecialityId": "9a6d7443-4fe0-463b-ae3e-1775fa943b6b",
"AppointmentOn": "2026-03-21T16:56:47.7284817-05:00",
"SecondaryAppointmentOn": "2026-03-21T16:56:47.7284817-05:00",
"Reason": "sample string 3",
"Note": "sample string 4",
"ParentId": "2e45b19d-8740-42fd-a167-2e1b2ce49666",
"ReferredParentId": "6ac51fff-25b7-46a8-82f4-b172366eb48c",
"PaidAmount": 5.0,
"AccountId": "59764c51-d1ef-411c-ab0b-de278a132ccd",
"ServiceId": "ac08c002-bf05-4687-b964-0afffd83125e",
"MethodId": 1,
"IsCustomFormFlow": "sample string 7",
"DocIds": "sample string 8",
"Reasons": [
{
"ReasonId": "5d653673-4565-4255-8c81-00c6674959eb"
},
{
"ReasonId": "5d653673-4565-4255-8c81-00c6674959eb"
}
]
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.