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": "f349afd9-dcac-47a0-b629-86b1bcca83bb",
"EncounterTypeModeDurationId": "82971f4a-007c-4047-bfbe-8eb9b151ca1c",
"ProviderId": "50e183fe-5467-4924-bdc6-1d81401a0b1f",
"UserId": "de5367db-5d73-4eb5-a15b-552dc2beea58",
"PatientId": "f3d91644-dce4-470f-a62c-de027bd86918",
"SpecialityId": "1f639499-e78e-4238-b7c4-d6fd0e5495d3",
"AppointmentOn": "2026-02-04T03:23:11.4917532+00:00",
"SecondaryAppointmentOn": "2026-02-04T03:23:11.4917532+00:00",
"Reason": "sample string 3",
"Note": "sample string 4",
"ParentId": "4f0ad0a3-7955-44fe-b837-f9f0e334cc0b",
"ReferredParentId": "e2668142-9055-4ddf-aaf8-e0e53a43ee33",
"PaidAmount": 5.0,
"AccountId": "72ffa949-02f2-448a-99b4-72ec2ff8da1a",
"ServiceId": "1be4689e-2409-411d-8428-4633fad0590d",
"MethodId": 1,
"IsCustomFormFlow": "sample string 7",
"DocIds": "sample string 8",
"Reasons": [
{
"ReasonId": "ae908e7a-3493-47cd-ba86-31f8d943ef16"
},
{
"ReasonId": "ae908e7a-3493-47cd-ba86-31f8d943ef16"
}
]
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.