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": "76e25e30-0408-4360-a1fb-3537ee02f6cc",
"EncounterTypeModeDurationId": "0ea38c4f-7805-4c7c-800c-0392f4f2b546",
"ProviderId": "49eecc67-413f-4747-94a2-bdbf5f967550",
"UserId": "eefe0847-b94c-439f-8338-515c857cf97a",
"PatientId": "20e6e421-c856-4848-98de-eb5e7b1b15bc",
"SpecialityId": "8e4e103a-556d-4d36-8202-6b998f8391ae",
"AppointmentOn": "2025-12-18T13:12:00.0309853-06:00",
"SecondaryAppointmentOn": "2025-12-18T13:12:00.0309853-06:00",
"Reason": "sample string 3",
"Note": "sample string 4",
"ParentId": "a23042d7-b9f5-477f-96e9-88caffc7f29f",
"ReferredParentId": "2a7c6ad3-fb34-4e15-976c-efa2b24980ad",
"PaidAmount": 5.0,
"AccountId": "63393f52-c0ff-456f-adab-7ef4fc404ef3",
"ServiceId": "9b733051-734b-4322-93ac-d487b82ec5a8",
"MethodId": 1,
"IsCustomFormFlow": "sample string 7",
"DocIds": "sample string 8",
"Reasons": [
{
"ReasonId": "60938e4b-ffe3-4071-8bbc-f3e33221c071"
},
{
"ReasonId": "60938e4b-ffe3-4071-8bbc-f3e33221c071"
}
]
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.