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": "dd83d0c1-3c04-4d62-8ddb-ae10fba26436",
"EncounterTypeModeDurationId": "f2e6746d-1fee-48a4-a573-861b741252a8",
"ProviderId": "1390d3e9-0c96-4c0e-9934-2ae8d8f6a67d",
"UserId": "3dcbbfb9-9d69-476d-940f-4efe43c17417",
"PatientId": "4fc4d229-8f04-4df6-a22b-591883419c28",
"SpecialityId": "ddd93f05-fc96-4364-baad-d92b017dc25a",
"AppointmentOn": "2025-12-16T09:12:19.9033382+00:00",
"SecondaryAppointmentOn": "2025-12-16T09:12:19.9033382+00:00",
"Reason": "sample string 3",
"Note": "sample string 4",
"ParentId": "61547172-9e79-48e9-89b4-64f37168fa01",
"ReferredParentId": "39dcc520-591a-49c6-9ccd-a4cb2ba2ee46",
"PaidAmount": 5.0,
"AccountId": "646f3c4f-9b5f-48e9-b8d1-e3e25445a41a",
"ServiceId": "293ff033-2517-4288-af8d-f8c48b33b82e",
"MethodId": 1,
"IsCustomFormFlow": "sample string 7",
"DocIds": "sample string 8",
"Reasons": [
{
"ReasonId": "c0d96913-c032-4426-b7ff-6d603918c533"
},
{
"ReasonId": "c0d96913-c032-4426-b7ff-6d603918c533"
}
]
}
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.