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": "bcbcf9ba-a364-4229-ad2f-41c79776b29b",
"EncounterTypeModeDurationId": "8dc019bc-baf1-4f25-a22f-e9669673db84",
"ProviderId": "35892d05-0086-4366-930b-3fa374cac51e",
"UserId": "84ef7a81-c643-4b8e-85e5-1ff52fc35f3d",
"PatientId": "a25ad686-2f86-43e7-b238-9251e37e2c50",
"SpecialityId": "f4a534e5-bc8e-4887-9316-050fd40db73d",
"AppointmentOn": "2026-02-03T21:04:03.1544841-06:00",
"SecondaryAppointmentOn": "2026-02-03T21:04:03.1544841-06:00",
"Reason": "sample string 3",
"Note": "sample string 4",
"ParentId": "ac738354-8370-4ef3-87ff-230048575027",
"ReferredParentId": "3b82bbc1-ad2e-465d-bbb8-d076a1f091c0",
"PaidAmount": 5.0,
"AccountId": "3faed728-f67f-4bc0-888f-a8410d31c7df",
"ServiceId": "34584373-414b-43f7-aaba-0a4453f6cd8f",
"MethodId": 1,
"IsCustomFormFlow": "sample string 7",
"DocIds": "sample string 8",
"Reasons": [
{
"ReasonId": "7b0d7dbd-2e54-48b9-a80d-fb468fda994e"
},
{
"ReasonId": "7b0d7dbd-2e54-48b9-a80d-fb468fda994e"
}
]
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.