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": "11f929f1-11d2-4460-8553-ceacc5a1927b",
"EncounterTypeModeDurationId": "056f632b-1f65-46fb-b99e-0695cafba70b",
"ProviderId": "a6a49d7e-7b52-4084-81aa-44bcf8c9426b",
"UserId": "c9d8adda-141b-453c-aa28-acc2b0696802",
"PatientId": "f46f671c-3e95-4810-bc26-cdc12ada9cfc",
"SpecialityId": "ed10abfe-d51b-46ea-b22d-27d8b454ae83",
"AppointmentOn": "2026-02-03T21:05:00.9113633-06:00",
"SecondaryAppointmentOn": "2026-02-03T21:05:00.9113633-06:00",
"Reason": "sample string 3",
"Note": "sample string 4",
"ParentId": "fc787096-ad90-4967-97f1-16156fea076e",
"ReferredParentId": "9bbbdc1d-0f06-4d81-aea3-64f4c8bdb4bc",
"PaidAmount": 5.0,
"AccountId": "265d3e4a-5d8a-4d4e-962c-a3ed2e2ba5b1",
"ServiceId": "b0e2467c-3a0e-4dd7-bfc3-0b465b386b1a",
"MethodId": 1,
"IsCustomFormFlow": "sample string 7",
"DocIds": "sample string 8",
"Reasons": [
{
"ReasonId": "fdbf1b43-35a0-42c9-844a-89e4cac64669"
},
{
"ReasonId": "fdbf1b43-35a0-42c9-844a-89e4cac64669"
}
]
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.